openapi-directory/api/vtex.local/Catalog-API.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://vtex.local"},{"description":"VTEX server url","url":"https://{accountName}.{environment}.com.br","variables":{"accountName":{"default":"{accountName}","description":"Name of the VTEX account. Used as part of the URL."},"environment":{"default":"{environment}","description":"Environment to use. Used as part of the URL."}}}],"x-hasEquivalentPaths":true,"info":{"contact":{},"description":"\r\n> Check the new [Catalog onboarding guide](https://developers.vtex.com/docs/guides/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey.\r\n\r\nMethods for collecting product/SKU catalog data, categories, brands and other information. All content that comes between `{{}}` keys must be replaced with the correct data before performing the request.\r\n\r\n\r\n## Index\r\n\r\n- [Product](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/products/GetProductAndSkuIds) - Here you can consult, create, or update a Product. For more information, check [this article](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/1wmX3QvQVxbKVmalhIE5Ru).\r\n- [Product Specification](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/products/-productId-/specification) - You can consult, create, or update additional information of a Product.  For more information, check [this article](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP#product-specification).\r\n- [SKU](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/sku/stockkeepingunitids) - Here you can consult, create, or update an SKU. For more information, check [this article](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3mJbIqMlz6oKDmyZ2bKJoA).\r\n- [SKU Complement](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/stockkeepingunit/-skuId-/complement) - You can consult, create, or update an SKU Complement. An SKU Complement is a new SKU that has a Parent SKU.\r\n- [SKU EAN](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/sku/stockkeepingunitbyean/-ean-) -  Here you can consult, create, or update an SKU unique identification code (barcode).\r\n- [SKU Attachment](https://developers.vtex.com/docs/api-reference/catalog-api#post-/api/catalog/pvt/skuattachment) - You can consult, create, or update an SKU Attachment. An attachment is used to add custom information about the item. For more information, check [this article](https://help.vtex.com/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm?locale=en).\r\n- [SKU File](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/stockkeepingunit/-skuId-/file) - Here you can consult, create, or update an SKU File. An SKU File is an image associated with an SKU.\r\n- [SKU Kit](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/stockkeepingunitkit) - You can consult, create, or update an SKU Kit. A kit is an SKU composed of one or more SKUs. For more information, check [this article](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28?locale=en).\r\n- [SKU Seller](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/skuseller/-sellerId-/-sellerSkuId-) - Here you can consult and delete an SKU Seller. An SKU Seller is a seller associated with an SKU. For more information, check [this article](https://help.vtex.com/tutorial/what-is-a-seller--5FkLvhZ3Few4CWWIuYOK2w?locale=en).\r\n- [SKU Service](https://developers.vtex.com/docs/api-reference/catalog-api#put-/api/catalog/pvt/skuservice/-skuServiceId-) - You can create, update, or delete an SKU Service. A service is an item that may come with a product, optionally, and with a cost. For more information, check [this article](https://help.vtex.com/tutorial/what-is-a-service--46Ha8CEEQoC6Y40i6akG0y?locale=en).\r\n- [SKU Service Attachment](https://developers.vtex.com/docs/api-reference/catalog-api#post-/api/catalog/pvt/skuservicetypeattachment) - Here you can associate or disassociate an Attachment to an SKU Service.\r\n- [SKU Service Type](https://developers.vtex.com/docs/api-reference/catalog-api#post-/api/catalog/pvt/skuservicetype) - You can create, update, or delete an SKU Service Type. A service type is the behavior configuration of a service.\r\n- [SKU Service Value](https://developers.vtex.com/docs/api-reference/catalog-api#post-/api/catalog/pvt/skuservicevalue) - Here you can create, update, or delete an SKU Service Value. Service value is how much the customer will be charged for the service.\r\n- [SKU Specification](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/stockkeepingunit/-skuId-/specification) - You can consult, create, or delete an SKU Specification. SKU Specification is used to create site browsing filters and to differentiate SKUs within the product page. For more information, check [this article](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP?locale=en#sku-specifications).\r\n- [Legacy Subcollection](https://developers.vtex.com/docs/api-reference/catalog-api#post-/api/catalog/pvt/subcollection/-subCollectionId-/stockkeepingunit) - Here you can can consult, create, or delete an SKU, Brand or Category from a Subcollection, as well as create, delete and update subcollections. A subcollection is a group type associated with a collection. For more information, check [this article](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3moFonW33dgOYDrU21Z1X0#group-types).\r\n- [Category](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pub/category/tree/-categoryLevels-) - You consult, create, or update a Category. A category is a hierarchical level of product classification. For more information, check [this article](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2gkZDjXRqfsq62TlAkj4uf).\r\n- [Similar Category](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/product/-productId-/similarcategory/) - Here you can create and delete a Similar Category to a Product. This way the Product will be shown in both categories (main and similar).\r\n- [Category Specification](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pub/specification/field/listByCategoryId/-categoryId-) - You can consult all Specifications by Category. For more information about Specification, check [this article](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP).\r\n- [Brand](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/brand/list) - You can consult, create, update, or delete a Brand. A brand is a product property. For more information, check [this article](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/7i3sB8fgkqUp5NoH5yJtfh).\r\n- [Attachment](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/attachment/-attachmentid-) - You can consult, create, or update an Attachment. An attachment is used to add custom information about the item. For more information, check [this article](https://help.vtex.com/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm?locale=en).\r\n- [Collection Beta](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/collection/search) - The new [Beta Collections module](https://help.vtex.com/announcements/new-beta-collections-module-easily-create-and-manage-product-collections--6KvFxylC5SNsbVm8L8XZpZ#) launch allowed us to engineer new endpoints that create and manage Collections. For more information, check [this article](https://help.vtex.com/en/tutorial/creating-collections-beta--yJBHqNMViOAnnnq4fyOye?&utm_source=autocomplete#).\r\n- [Legacy Collection](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/collection/-collectionId-) - Here you can consult, create, update, or delete a Collection. A collection is a group of items. For more information, check [this article](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/4hN41yU8IPeb8HKmmaXoca?locale=en).\r\n- [Specification](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/specification/-specificationId-) - Here you can consult, create, or delete a Specification. A specification is used to create site browsing filters and to differentiate SKUs and Products within the product page. For more information, check [this article](https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP?locale=en).\r\n- [Specification Field](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pub/specification/fieldGet/-fieldId-) - You can consult, create, or update a Specification Field. A specification field allows you to present more detailed items. \r\n- [Specification Field Value](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/specification/fieldValue/-fieldValueId-) - Here you can consult, create, or update a Specification Field Value. \r\n- [Specification Value](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/specificationvalue/-specificationValueId-) - You can consult, create, or update a Specification Value.\r\n- [Specification Group](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/specification/groupbycategory/-categoryId-) - Here you can consult, create, or update a Specification Group.\r\n- [Non Structured Specification](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/specification/nonstructured/-Id-) - You can consult or delete a Non Structured Specification.\r\n- [Sales Channel](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/saleschannel/list) - Here you can consult Sales Channel.\r\n- [Seller](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/seller/list) - You can consult, create, or update a Seller. A seller is the _product owner_. For more information, check [this article](https://help.vtex.com/tutorial/what-is-a-seller--5FkLvhZ3Few4CWWIuYOK2w?locale=en).\r\n- [Supplier](https://developers.vtex.com/docs/api-reference/catalog-api#post-/api/catalog/pvt/supplier) - Here you can consult, create, or update a Supplier.\r\n- [Trade Policy](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog/pvt/product/-productId-/salespolicy) - You can create, update, or delete a Trade Policy. Trade policy is required when one of the above factors is different among the sale channel. For more information, check [this article](https://help.vtex.com/tutorial/what-is-a-sales-policy--563tbcL0TYKEKeOY4IAgAE?locale=en).\r\n- [Product Indexing](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/products/GetIndexedInfo/-productId-) - Here you can consult Product Indexed information.\r\n- [Commercial Conditions](https://developers.vtex.com/docs/api-reference/catalog-api#get-/api/catalog_system/pvt/commercialcondition/list) - Here you can consult commercial conditions registered in the store.\r\n\r\n\r\n## Common parameters\r\n\r\n| Parameter name              | Description                                                                             |\r\n|---------------------------|-----------------------------------------------------------------------------------------|\r\n| `{{accountName}}`         | Store account name                                                                      |\r\n| `{{environment}`          | The environment that will be called. Change for vtexcommercestable or vtexcommmercebeta |\r\n| `{{X-VTEX-API-AppKey}}`   | Located in the headers of the requests, user authentication key                         |\r\n| `{{X-VTEX-API-AppToken}}` | Located in the headers of the requests, authentication password                         |","title":"Catalog API","version":"1.0","x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Catalog API.json","version":"3.0"}],"x-providerName":"vtex.local","x-serviceName":"Catalog-API"},"security":[{"appKey":[],"appToken":[]}],"tags":[{"name":"SKU Service"},{"name":"SKU Service Attachment"},{"name":"SKU Service Value"},{"name":"SKU Service Type"},{"name":"Category"},{"name":"Brand"},{"name":"Attachment"},{"name":"Product"},{"name":"Product Specification"},{"name":"Trade Policy"},{"name":"Similar Category"},{"name":"SKU"},{"name":"SKU EAN"},{"name":"SKU File"},{"name":"SKU Kit"},{"name":"SKU Specification"},{"name":"SKU Attachment"},{"name":"SKU Complement"},{"name":"Non Structured Specification"},{"name":"Specification Field"},{"name":"Specification Group"},{"name":"Specification Value"},{"name":"Specification Field Value"},{"name":"Category Specification"},{"name":"Specification"},{"name":"Legacy Collection"},{"name":"Legacy Subcollection"},{"name":"Collection Beta"},{"name":"Supplier"},{"name":"Sales Channel"},{"name":"Seller"},{"name":"SKU Seller"},{"name":"Product Indexing"},{"name":"Commercial Conditions"},{"name":"Gift List"}],"paths":{"/api/addon/pvt/giftlist/get/{listId}":{"get":{"description":"Retrieves information about a Gift List by its ID.","operationId":"GetGiftList","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Gift List unique numerical identifier.","in":"path","name":"listId","required":true,"schema":{"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Object with information about the Gift List.","example":{"IsPublic":false,"address":null,"clientId":3,"dateCreated":"2025-06-15T13:49:16.523Z","eventCity":"","eventDate":"2025-06-15T13:49:16.523Z","eventLocation":"","eventState":"","fileId":null,"fileUrl":null,"giftCardId":2,"giftCardRechargeSkuId":null,"giftListId":1,"giftListMembers":[],"giftListSkuIds":[],"giftListTypeId":1,"giftListTypeName":"Lista de Casamento","isActive":false,"isAddressOk":true,"memberNames":"sei lá","message":"mensageeeem","name":"My list","profileSystemUserAddressName":"CASA","profileSystemUserId":"010956A4-A74A-4375-8B7B-3B3B7B89B483","shipsToOwner":false,"telemarketingId":null,"telemarketingObservation":"","urlFolder":"lili","userId":"010956A4-A74A-4375-8B7B-3B3B7B89B483","version":1},"properties":{"IsPublic":{"description":"Defines if the gift list is public.","example":true,"title":"IsPublic","type":"boolean"},"address":{"description":"Address of the gift list.","example":"Botafogo","nullable":true,"title":"address","type":"string"},"dateCreated":{"description":"Date when the gift list was created.","example":"2025-06-15T13:49:16.523Z","title":"dateCreated","type":"string"},"eventCity":{"description":"City of the event associated with the Gift List.","example":"Rio de Janeiro","title":"eventCity","type":"string"},"eventDate":{"description":"Date of the event associated with the Gift List.","example":"2025-06-15T13:49:16.523Z","title":"eventDate","type":"string"},"eventLocation":{"description":"Location of the event associated with the Gift List.","example":"Botafogo","title":"eventLocation","type":"string"},"eventState":{"description":"State of the event associated with the Gift List.","example":"RJ","title":"eventState","type":"string"},"fileId":{"description":"File ID.","example":155233,"nullable":true,"title":"fileId","type":"integer"},"fileUrl":{"description":"File URL.","example":"/arquivos/ids/155233-800-800/gl-0_635266293044683588.jpg","nullable":true,"title":"fileUrl","type":"string"},"giftCardId":{"description":"Gift Card ID.","example":2,"title":"giftCardId","type":"integer"},"giftCardRechargeSkuId":{"description":"ID of the SKU that recharges the gift card.","example":1,"nullable":true,"title":"giftCardRechargeSkuId","type":"integer"},"giftListId":{"description":"Gift List ID.","example":1,"title":"giftListId","type":"integer"},"giftListMembers":{"description":"Array of members of the gift list.","items":{"description":"Object with information about each gift list member.","example":{"clientId":null,"giftListId":2,"giftListMemberId":1,"isActive":true,"isAdmin":true,"name":"Rafael","surname":"Villa-Verde","text1":null,"text2":null,"title":null,"userId":"010956A4-A74A-4375-8B7B-3B3B7B89B483"},"properties":{"clientId":{"description":"Client ID.","nullable":true,"title":"clientId","type":"string"},"giftListId":{"description":"Gift List ID.","title":"giftListId","type":"integer"},"giftListMemberId":{"description":"Gift List member ID.","title":"giftListMemberId","type":"integer"},"isActive":{"description":"Defines if the Gift List user is active or not.","title":"isActive","type":"boolean"},"isAdmin":{"description":"Defines if the Gift List member is an administrator of the Gift List or not.","title":"isAdmin","type":"boolean"},"name":{"description":"Name of the Gift List member.","title":"name","type":"string"},"surname":{"description":"Surname of the Gift List member.","title":"surname","type":"string"},"text1":{"description":"Complementary text.","nullable":true,"title":"text1","type":"string"},"text2":{"description":"Complementary text.","nullable":true,"title":"text2","type":"string"},"title":{"description":"Title of the Gift List member.","nullable":true,"title":"title","type":"string"},"userId":{"description":"User ID.","title":"userId","type":"string"}},"type":"object"},"title":"giftListMembers","type":"array"},"giftListSkuIds":{"description":"Array with the IDs of SKUs that are part of the gift list.","items":{"description":"SKU ID.","type":"string"},"title":"giftListSkuIds","type":"array"},"giftListTypeId":{"description":"Gift List Type ID.","example":1,"title":"giftListTypeId","type":"integer"},"giftListTypeName":{"description":"Gift List Type name.","example":"Wedding list","title":"giftListTypeName","type":"string"},"isActive":{"description":"Defines if the gift list is active.","example":true,"title":"isActive","type":"boolean"},"isAddressOk":{"description":"Validates the address of the gift list.","example":false,"title":"isAddressOk","type":"boolean"},"memberNames":{"description":"Name of the members of the gift list.","example":"Rafael Villa-Verde","title":"memberNames","type":"string"},"message":{"description":"Gift List message.","example":"This is a gift list for my wedding.","title":"message","type":"string"},"name":{"description":"Gift List name.","example":"My list","title":"name","type":"string"},"profileSystemUserAddressName":{"description":"Name of the user's address.","example":"CASA","title":"profileSystemUserAddressName","type":"string"},"profileSystemUserId":{"description":"User ID on Profile System.","example":"a6e7d995-e884-409d-911f-36b25c40169a","title":"profileSystemUserId","type":"string"},"shipsToOwner":{"description":"Defines if items purchased from the gift list will be shipped to the owner of the gift list.","example":false,"title":"shipsToOwner","type":"boolean"},"telemarketingId":{"description":"Telemarketing ID.","example":1,"nullable":true,"title":"telemarketingId","type":"integer"},"telemarketingObservation":{"description":"Telemarketing observation.","example":"","title":"telemarketingObservation","type":"string"},"urlFolder":{"description":"Slug of the gift list that will be part of its URL.","example":"myweddinglist","title":"urlFolder","type":"string"},"userId":{"description":"User ID.","example":"a6e7d995-e884-409d-911f-36b25c40169a","title":"userId","type":"string"},"version":{"description":"Version of the gift list.","example":1,"title":"version","type":"integer"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Get Gift List","tags":["Gift List"]}},"/api/addon/pvt/review/GetProductRate/{productId}":{"get":{"deprecated":false,"description":"Retrieves the review rate of a product by this product's ID.","operationId":"ReviewRateProduct","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Product’s unique numerical identifier.","in":"path","name":"productId","required":true,"schema":{"example":1,"type":"integer"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Review rate numeber.","example":3,"type":"number"}}},"description":"OK"}},"summary":"Get Product Review Rate by Product ID","tags":["Product"]}},"/api/catalog/pvt/attachment":{"post":{"description":"Creates a new SKU attachment.\r\n >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. \r\n## Request body example\r\n\r\n```json\r\n{\r\n  \"Name\": \"Test\",\r\n  \"IsRequired\": true,\r\n  \"IsActive\": true,\r\n  \"Domains\": [\r\n    {\r\n      \"FieldName\": \"Basic test\",\r\n      \"MaxCaracters\": \"\",\r\n      \"DomainValues\": \"[1-2]#9[1-1][1]basic;#11[0-1][1]basic\"\r\n    },\r\n    {\r\n      \"FieldName\": \"teste\",\r\n      \"MaxCaracters\": \"\",\r\n      \"DomainValues\": \"[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium\"\r\n    }\r\n  ]\r\n}\r\n```\r\n## Response body example\r\n\r\n```json\r\n{\r\n  \"Id\": 8,\r\n  \"Name\": \"Test\",\r\n  \"IsRequired\": true,\r\n  \"IsActive\": true,\r\n  \"Domains\": [\r\n    {\r\n      \"FieldName\": \"Basic test\",\r\n      \"MaxCaracters\": \"\",\r\n      \"DomainValues\": \"[1-2]#9[1-1][1]basic;#11[0-1][1]basic\"\r\n    },\r\n    {\r\n      \"FieldName\": \"teste\",\r\n      \"MaxCaracters\": \"\",\r\n      \"DomainValues\": \"[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium\"\r\n    }\r\n  ]\r\n}\r\n```","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentRequest"}}},"description":""},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentResponse"}}},"description":"OK"}},"summary":"Create attachment","tags":["Attachment"]}},"/api/catalog/pvt/attachment/{attachmentid}":{"delete":{"description":"Deletes a previously existing SKU attachment.","parameters":[{"description":"Attachment ID.","in":"path","name":"attachmentid","required":true,"schema":{"example":"vtexcommercestable","type":"string"}},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK"}},"summary":"Delete attachment","tags":["Attachment"]},"get":{"description":"Gets information about a registered attachment. \r\n >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation.\r\n## Response body example\r\n\r\n```json\r\n{\r\n  \"Id\": 8,\r\n  \"Name\": \"Test\",\r\n  \"IsRequired\": true,\r\n  \"IsActive\": true,\r\n  \"Domains\": [\r\n    {\r\n      \"FieldName\": \"Basic test\",\r\n      \"MaxCaracters\": \"\",\r\n      \"DomainValues\": \"[1-2]#9[1-1][1]basic;#11[0-1][1]basic\"\r\n    },\r\n    {\r\n      \"FieldName\": \"teste\",\r\n      \"MaxCaracters\": \"\",\r\n      \"DomainValues\": \"[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium\"\r\n    }\r\n  ]\r\n}\r\n```","parameters":[{"description":"Attachment ID.","in":"path","name":"attachmentid","required":true,"schema":{"example":"8","type":"string"}},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentResponse"}}},"description":"OK"}},"summary":"Get attachment","tags":["Attachment"]},"put":{"description":"Updates a previously existing SKU attachment with new information. \r\n >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. \r\n## Request body example\r\n\r\n```json\r\n{\r\n  \"Name\": \"Test\",\r\n  \"IsRequired\": true,\r\n  \"IsActive\": true,\r\n  \"Domains\": [\r\n    {\r\n      \"FieldName\": \"Basic test\",\r\n      \"MaxCaracters\": \"\",\r\n      \"DomainValues\": \"[1-2]#9[1-1][1]basic;#11[0-1][1]basic\"\r\n    },\r\n    {\r\n      \"FieldName\": \"teste\",\r\n      \"MaxCaracters\": \"\",\r\n      \"DomainValues\": \"[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium\"\r\n    }\r\n  ]\r\n}\r\n```\r\n## Response body example\r\n\r\n```json\r\n{\r\n  \"Id\": 8,\r\n  \"Name\": \"Test\",\r\n  \"IsRequired\": true,\r\n  \"IsActive\": true,\r\n  \"Domains\": [\r\n    {\r\n      \"FieldName\": \"Basic test\",\r\n      \"MaxCaracters\": \"\",\r\n      \"DomainValues\": \"[1-2]#9[1-1][1]basic;#11[0-1][1]basic\"\r\n    },\r\n    {\r\n      \"FieldName\": \"teste\",\r\n      \"MaxCaracters\": \"\",\r\n      \"DomainValues\": \"[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium\"\r\n    }\r\n  ]\r\n}\r\n```","parameters":[{"description":"Attachment ID.","in":"path","name":"attachmentid","required":true,"schema":{"example":"vtexcommercestable","type":"string"}},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentRequest"}}},"description":""},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentResponse"}}},"description":"OK"}},"summary":"Update attachment","tags":["Attachment"]}},"/api/catalog/pvt/attachments":{"get":{"description":"Retrieves information about all registered attachments. \r\n >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. \r\n## Response body example\r\n\r\n```json\r\n{\r\n    \"Page\": 1,\r\n    \"Size\": 11,\r\n    \"TotalRows\": 11,\r\n    \"TotalPage\": 1,\r\n    \"Data\": [\r\n        {\r\n            \"Id\": 1,\r\n            \"Name\": \"Acessórios do bicho\",\r\n            \"IsRequired\": true,\r\n            \"IsActive\": true,\r\n            \"Domains\": [\r\n                {\r\n                    \"FieldName\": \"extra\",\r\n                    \"MaxCaracters\": \"\",\r\n                    \"DomainValues\": \"[0-3]#1[1-2][1]pricetable1;#3[0-2][0]pricetable2;#5[0-2][0]pricetable3\"\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"Id\": 2,\r\n            \"Name\": \"Sobrenome\",\r\n            \"IsRequired\": false,\r\n            \"IsActive\": true,\r\n            \"Domains\": []\r\n        },\r\n        {\r\n            \"Id\": 3,\r\n            \"Name\": \"Assinatura Teste\",\r\n            \"IsRequired\": false,\r\n            \"IsActive\": true,\r\n            \"Domains\": [\r\n                {\r\n                    \"FieldName\": \" vtex.subscription.key.frequency\",\r\n                    \"MaxCaracters\": \"\",\r\n                    \"DomainValues\": \"1 day, 7 day, 1 month, 6 month\"\r\n                },\r\n                {\r\n                    \"FieldName\": \"vtex.subscription.key.validity.begin\",\r\n                    \"MaxCaracters\": \"\",\r\n                    \"DomainValues\": \"1\"\r\n                },\r\n                {\r\n                    \"FieldName\": \"vtex.subscription.key.validity.end\",\r\n                    \"MaxCaracters\": \"\",\r\n                    \"DomainValues\": \"31\"\r\n                },\r\n                {\r\n                    \"FieldName\": \"vtex.subscription.key.purchaseday\",\r\n                    \"MaxCaracters\": \"\",\r\n                    \"DomainValues\": \"1, 2, 20, 31\"\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"Id\": 5,\r\n            \"Name\": \"teste\",\r\n            \"IsRequired\": false,\r\n            \"IsActive\": true,\r\n            \"Domains\": []\r\n        },\r\n        {\r\n            \"Id\": 6,\r\n            \"Name\": \"teste2\",\r\n            \"IsRequired\": false,\r\n            \"IsActive\": true,\r\n            \"Domains\": []\r\n        },\r\n        {\r\n            \"Id\": 7,\r\n            \"Name\": \"vtex.subscription.teste3\",\r\n            \"IsRequired\": false,\r\n            \"IsActive\": true,\r\n            \"Domains\": []\r\n        },\r\n        {\r\n            \"Id\": 8,\r\n            \"Name\": \"teste api nova\",\r\n            \"IsRequired\": true,\r\n            \"IsActive\": true,\r\n            \"Domains\": [\r\n                {\r\n                    \"FieldName\": \"Basic teste\",\r\n                    \"MaxCaracters\": \"\",\r\n                    \"DomainValues\": \"[1-2]#9[1-1][1]basic;#11[0-1][1]basic\"\r\n                },\r\n                {\r\n                    \"FieldName\": \"teste\",\r\n                    \"MaxCaracters\": \"\",\r\n                    \"DomainValues\": \"[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium\"\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"Id\": 9,\r\n            \"Name\": \"vtex.subscription.teste\",\r\n            \"IsRequired\": false,\r\n            \"IsActive\": true,\r\n            \"Domains\": []\r\n        },\r\n        {\r\n            \"Id\": 10,\r\n            \"Name\": \"Montagens\",\r\n            \"IsRequired\": false,\r\n            \"IsActive\": true,\r\n            \"Domains\": []\r\n        },\r\n        {\r\n            \"Id\": 11,\r\n            \"Name\": \"vtex.subscription.subscription\",\r\n            \"IsRequired\": false,\r\n            \"IsActive\": true,\r\n            \"Domains\": [\r\n                {\r\n                    \"FieldName\": \"vtex.subscription.key.frequency\",\r\n                    \"MaxCaracters\": \"15\",\r\n                    \"DomainValues\": \"1 month\"\r\n                },\r\n                {\r\n                    \"FieldName\": \"vtex.subscription.key.purchaseday\",\r\n                    \"MaxCaracters\": \"15\",\r\n                    \"DomainValues\": \"1,15,28\"\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"Id\": 12,\r\n            \"Name\": \"T-Shirt Customization\",\r\n            \"IsRequired\": false,\r\n            \"IsActive\": true,\r\n            \"Domains\": [\r\n                {\r\n                    \"FieldName\": \"T-Shirt Name\",\r\n                    \"MaxCaracters\": \"15\",\r\n                    \"DomainValues\": \"[]\"\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}\r\n```","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"Data":{"description":"Array containing attachments data.","items":{"$ref":"#/components/schemas/AttachmentResponse"},"title":"Data","type":"array"},"Page":{"description":"Current page of results.","example":1,"title":"Page","type":"integer"},"Size":{"description":"Total number of results in the current page.","example":11,"title":"Size","type":"integer"},"TotalPage":{"description":"Total number of pages with results.","example":1,"title":"TotalPage","type":"integer"},"TotalRows":{"description":"Total number of rows with results.","example":11,"title":"TotalRows","type":"integer"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Get all attachments","tags":["Attachment"]}},"/api/catalog/pvt/brand":{"post":{"description":"Creates a new Brand.\r\n## Request and response body example\r\n\r\n```json\r\n{\r\n  \"Id\": 2000013,\r\n  \"Name\": \"Orma Carbon\",\r\n  \"Text\": \"Orma Carbon\",\r\n  \"Keywords\": \"orma\",\r\n  \"SiteTitle\": \"Orma Carbon\",\r\n  \"Active\": true,\r\n  \"MenuHome\": true,\r\n  \"AdWordsRemarketingCode\": \"\",\r\n  \"LomadeeCampaignCode\": \"\",\r\n  \"Score\": null,\r\n  \"LinkId\": \"orma-carbon\"\r\n}\r\n```","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandCreateUpdate"}}},"description":"Request body."},"responses":{"200":{"content":{"application/json":{"example":{"Active":true,"AdWordsRemarketingCode":"","Id":2000013,"Keywords":"orma","LinkId":"orma-carbon","LomadeeCampaignCode":"","MenuHome":true,"Name":"Orma Carbon","Score":null,"SiteTitle":"Orma Carbon","Text":"Orma Carbon"},"schema":{"$ref":"#/components/schemas/BrandCreateUpdate"}}},"description":"OK"}},"summary":"Create Brand","tags":["Brand"]}},"/api/catalog/pvt/brand/{brandId}":{"delete":{"description":"Deletes an existing Brand.","parameters":[{"description":"Brand’s unique numerical identifier.","in":"path","name":"brandId","required":true,"schema":{"example":"123","type":"string"}},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"description":"OK"}},"summary":"Delete Brand","tags":["Brand"]},"get":{"description":"Retrieves information about a specific Brand and its context.\r\n## Response body example\r\n\r\n```json\r\n{\r\n  \"Id\": 2000013,\r\n  \"Name\": \"Orma Carbon\",\r\n  \"Text\": \"Orma Carbon\",\r\n  \"Keywords\": \"orma\",\r\n  \"SiteTitle\": \"Orma Carbon\",\r\n  \"Active\": true,\r\n  \"MenuHome\": true,\r\n  \"AdWordsRemarketingCode\": \"\",\r\n  \"LomadeeCampaignCode\": \"\",\r\n  \"Score\": null,\r\n  \"LinkId\": \"orma-carbon\"\r\n}\r\n```","parameters":[{"description":"Describes the type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Brand ID.","in":"path","name":"brandId","required":true,"schema":{"example":"123","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"Active":true,"AdWordsRemarketingCode":"","Id":2000013,"Keywords":"orma","LinkId":"orma-carbon","LomadeeCampaignCode":"","MenuHome":true,"Name":"Orma Carbon","Score":null,"SiteTitle":"Orma Carbon","Text":"Orma Carbon"},"schema":{"$ref":"#/components/schemas/BrandCreateUpdate"}}},"description":"OK"}},"summary":"Get Brand and context","tags":["Brand"]},"put":{"description":"Updates a previously existing Brand.\r\n## Request and response body example\r\n\r\n```json\r\n{\r\n  \"Id\": 2000013,\r\n  \"Name\": \"Orma Carbon\",\r\n  \"Text\": \"Orma Carbon\",\r\n  \"Keywords\": \"orma\",\r\n  \"SiteTitle\": \"Orma Carbon\",\r\n  \"Active\": true,\r\n  \"MenuHome\": true,\r\n  \"AdWordsRemarketingCode\": \"\",\r\n  \"LomadeeCampaignCode\": \"\",\r\n  \"Score\": null,\r\n  \"LinkId\": \"orma-carbon\"\r\n}\r\n```","parameters":[{"description":"Brand’s unique numerical identifier.","in":"path","name":"brandId","required":true,"schema":{"example":"123","type":"string"}},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandCreateUpdate"}}},"description":""},"responses":{"200":{"content":{"application/json":{"example":{"Active":true,"AdWordsRemarketingCode":"","Id":2000013,"Keywords":"orma","LinkId":"orma-carbon","LomadeeCampaignCode":"","MenuHome":true,"Name":"Orma Carbon","Score":null,"SiteTitle":"Orma Carbon","Text":"Orma Carbon"},"schema":{"$ref":"#/components/schemas/BrandCreateUpdate"}}},"description":"OK"}},"summary":"Update Brand","tags":["Brand"]}},"/api/catalog/pvt/category":{"post":{"description":"Creates a new Category.\r\n\r\nIf there is a need to create a new category with a specific custom ID, specify the `Id` (integer) in the request. Otherwise, VTEX will generate the ID automatically.\r\n\r\n## Request body example (automatically generated ID)\r\n\r\n```json\r\n{\r\n    \"Name\": \"Home Appliances\",\r\n    \"FatherCategoryId\": null,\r\n    \"Title\": \"Home Appliances\",\r\n    \"Description\": \"Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.\",\r\n    \"Keywords\": \"Kitchen, Laundry, Appliances\",\r\n    \"IsActive\": true,\r\n    \"LomadeeCampaignCode\": null,\r\n    \"AdWordsRemarketingCode\": null,\r\n    \"ShowInStoreFront\": true,\r\n    \"ShowBrandFilter\": true,\r\n    \"ActiveStoreFrontLink\": true,\r\n    \"GlobalCategoryId\": 604,\r\n    \"StockKeepingUnitSelectionMode\": \"SPECIFICATION\",\r\n    \"Score\": null\r\n}\r\n```\r\n\r\n## Request body example (custom ID)\r\n\r\n```json\r\n{\r\n    \"Id\": 1,\r\n    \"Name\": \"Home Appliances\",\r\n    \"FatherCategoryId\": null,\r\n    \"Title\": \"Home Appliances\",\r\n    \"Description\": \"Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.\",\r\n    \"Keywords\": \"Kitchen, Laundry, Appliances\",\r\n    \"IsActive\": true,\r\n    \"LomadeeCampaignCode\": null,\r\n    \"AdWordsRemarketingCode\": null,\r\n    \"ShowInStoreFront\": true,\r\n    \"ShowBrandFilter\": true,\r\n    \"ActiveStoreFrontLink\": true,\r\n    \"GlobalCategoryId\": 604,\r\n    \"StockKeepingUnitSelectionMode\": \"SPECIFICATION\",\r\n    \"Score\": null\r\n}\r\n```\r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n    \"Id\": 1,\r\n    \"Name\": \"Home Appliances\",\r\n    \"FatherCategoryId\": null,\r\n    \"Title\": \"Home Appliances\",\r\n    \"Description\": \"Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.\",\r\n    \"Keywords\": \"Kitchen, Laundry, Appliances\",\r\n    \"IsActive\": true,\r\n    \"LomadeeCampaignCode\": \"\",\r\n    \"AdWordsRemarketingCode\": \"\",\r\n    \"ShowInStoreFront\": true,\r\n    \"ShowBrandFilter\": true,\r\n    \"ActiveStoreFrontLink\": true,\r\n    \"GlobalCategoryId\": 604,\r\n    \"StockKeepingUnitSelectionMode\": \"LIST\",\r\n    \"Score\": null,\r\n    \"LinkId\": \"Alimentacao\",\r\n    \"HasChildren\": true\r\n}\r\n```","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCategoryRequest"}}},"description":""},"responses":{"200":{"content":{"application/json":{"example":{"ActiveStoreFrontLink":true,"AdWordsRemarketingCode":"","Description":"Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.","FatherCategoryId":null,"GlobalCategoryId":3367,"HasChildren":true,"Id":1,"IsActive":true,"Keywords":"Kitchen, Laundry, Appliances","LinkId":"Alimentacao","LomadeeCampaignCode":"","Name":"Home Appliances","Score":null,"ShowBrandFilter":true,"ShowInStoreFront":true,"StockKeepingUnitSelectionMode":"LIST","Title":"Home Appliances"},"schema":{"$ref":"#/components/schemas/Category"}}},"description":"OK"}},"summary":"Create Category","tags":["Category"]}},"/api/catalog/pvt/category/{categoryId}":{"get":{"description":"Retrieves general information about a Category. \r\n## Response body example\r\n\r\n```json\r\n{\r\n    \"Id\": 1,\r\n    \"Name\": \"Home Appliances\",\r\n    \"FatherCategoryId\": null,\r\n    \"Title\": \"Home Appliances\",\r\n    \"Description\": \"Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.\",\r\n    \"Keywords\": \"Kitchen, Laundry, Appliances\",\r\n    \"IsActive\": true,\r\n    \"LomadeeCampaignCode\": \"\",\r\n    \"AdWordsRemarketingCode\": \"\",\r\n    \"ShowInStoreFront\": true,\r\n    \"ShowBrandFilter\": true,\r\n    \"ActiveStoreFrontLink\": true,\r\n    \"GlobalCategoryId\": 3367,\r\n    \"StockKeepingUnitSelectionMode\": \"LIST\",\r\n    \"Score\": null,\r\n    \"LinkId\": \"Alimentacao\",\r\n    \"HasChildren\": true\r\n}\r\n```","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Category’s unique numerical identifier.","in":"path","name":"categoryId","required":true,"schema":{"example":9289,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"ActiveStoreFrontLink":true,"AdWordsRemarketingCode":"","Description":"Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.","FatherCategoryId":null,"GlobalCategoryId":3367,"HasChildren":true,"Id":1,"IsActive":true,"Keywords":"Kitchen, Laundry, Appliances","LinkId":"Alimentacao","LomadeeCampaignCode":"","Name":"Home Appliances","Score":null,"ShowBrandFilter":true,"ShowInStoreFront":true,"StockKeepingUnitSelectionMode":"LIST","Title":"Home Appliances"},"schema":{"$ref":"#/components/schemas/Category"}}},"description":"OK"}},"summary":"Get Category by ID","tags":["Category"]},"put":{"description":"Updates a previously existing Category.\r\n\r\n## Request body example\r\n\r\n```json\r\n{\r\n    \"Name\": \"Home Appliances\",\r\n    \"FatherCategoryId\": null,\r\n    \"Title\": \"Home Appliances\",\r\n    \"Description\": \"Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.\",\r\n    \"Keywords\": \"Kitchen, Laundry, Appliances\",\r\n    \"IsActive\": true,\r\n    \"LomadeeCampaignCode\": null,\r\n    \"AdWordsRemarketingCode\": null,\r\n    \"ShowInStoreFront\": true,\r\n    \"ShowBrandFilter\": true,\r\n    \"ActiveStoreFrontLink\": true,\r\n    \"GlobalCategoryId\": 604,\r\n    \"StockKeepingUnitSelectionMode\": \"SPECIFICATION\",\r\n    \"Score\": null\r\n}\r\n```\r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n    \"Id\": 1,\r\n    \"Name\": \"Home Appliances\",\r\n    \"FatherCategoryId\": null,\r\n    \"Title\": \"Home Appliances\",\r\n    \"Description\": \"Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.\",\r\n    \"Keywords\": \"Kitchen, Laundry, Appliances\",\r\n    \"IsActive\": true,\r\n    \"LomadeeCampaignCode\": \"\",\r\n    \"AdWordsRemarketingCode\": \"\",\r\n    \"ShowInStoreFront\": true,\r\n    \"ShowBrandFilter\": true,\r\n    \"ActiveStoreFrontLink\": true,\r\n    \"GlobalCategoryId\": 604,\r\n    \"StockKeepingUnitSelectionMode\": \"LIST\",\r\n    \"Score\": null,\r\n    \"LinkId\": \"Alimentacao\",\r\n    \"HasChildren\": true\r\n}\r\n```","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Category’s unique numerical identifier.","in":"path","name":"categoryId","required":true,"schema":{"example":9289,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ActiveStoreFrontLink":{"description":"If true, the Category link becomes active in store.","example":true,"title":"ActiveStoreFrontLink","type":"boolean"},"AdWordsRemarketingCode":{"deprecated":true,"description":"This is a legacy field. Do not take this information into consideration.","example":"Sale","type":"string"},"Description":{"description":"Text used in meta description tag for Category page.","example":"Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.","title":"Description","type":"string"},"FatherCategoryId":{"description":"ID of the parent category, apply in case of category and subcategory.","example":2,"nullable":true,"title":"FatherCategoryId","type":"integer"},"GlobalCategoryId":{"description":"Google Global Category ID.","example":222,"title":"GlobalCategoryId","type":"integer"},"IsActive":{"description":"If true, the Category page becomes available in store.","example":true,"title":"IsActive","type":"boolean"},"Keywords":{"description":"Substitute words for the Category.","example":"Kitchen, Laundry, Appliances","title":"Keywords","type":"string"},"LomadeeCampaignCode":{"deprecated":true,"description":"This is a legacy field. Do not take this information into consideration.","example":"Sale","type":"string"},"Name":{"description":"Category name.","example":"Home Appliances","title":"Name","type":"string"},"Score":{"description":"Score for search sorting order.","example":3,"title":"Score","type":"integer"},"ShowBrandFilter":{"description":"If true, the Category page displays a Brand filter.","example":true,"title":"ShowBrandFilter","type":"boolean"},"ShowInStoreFront":{"description":"If true, the Category is shown in