openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 106 kB
JSON
{"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\nWith the Catalog API for Seller Portal, you will be able to create, edit and consult products and their variations, brands, and categories.\r\n\r\n> This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests).\r\n\r\n## Index\r\n\r\n### Product\r\n\r\n`GET` [Get Product by ID](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#get-/api/catalog-seller-portal/products/-productId-)\r\n`PUT` [Update Product](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#put-/api/catalog-seller-portal/products/-productId-)\r\n`GET` [Get Product Description by Product ID](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#get-/api/catalog-seller-portal/products/-productId-/description)\r\n`PUT` [Update Product Description by Product ID](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#put-/api/catalog-seller-portal/products/-productId-/description)\r\n`GET` [Get Product by external ID, SKU ID, SKU external ID or slug](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#get-/api/catalog-seller-portal/products/-param-)\r\n`POST` [Create Product](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#post-/api/catalog-seller-portal/products)\r\n\r\n### SKU\r\n\r\n`GET` [Search for SKU](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#get-/api/catalog-seller-portal/skus/_search)\r\n`GET` [Get List of SKUs](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#get-/api/catalog-seller-portal/skus/ids)\r\n\r\n### Brand\r\n\r\n`GET` [Get List of Brands](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#get-/api/catalog-seller-portal/brands)\r\n`POST` [Create a Brand](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#post-/api/catalog-seller-portal/brands)\r\n`GET` [Get Brand by ID](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#get-/api/catalog-seller-portal/brands/-brandId-)\r\n`PUT` [Update Brand](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#put-/api/catalog-seller-portal/brands/-brandId-)\r\n\r\n### Category\r\n\r\n`GET` [Get Category Tree](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#get-/api/catalog-seller-portal/category-tree)\r\n`PUT` [Update Category Tree](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#put-/api/catalog-seller-portal/category-tree)\r\n`GET` [Get Category by ID](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#get-/api/catalog-seller-portal/category-tree/categories/-categoryId-)\r\n`POST` [Create a Category](https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal#post-/api/catalog-seller-portal/category-tree/categories)","title":"Catalog API - Seller Portal","version":"1.0.0","x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Catalog API Seller Portal.json","version":"3.0"}],"x-providerName":"vtex.local","x-serviceName":"Catalog-API-Seller-Portal"},"security":[{"appKey":[],"appToken":[]}],"tags":[{"name":"Product"},{"name":"SKU"},{"name":"Brand"},{"name":"Category"}],"paths":{"/api/catalog-seller-portal/brands":{"get":{"description":" >📘 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Retrieves general information about all brands of the store. It is mandatory to use at least one query parameter. \r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"data\": [\r\n {\r\n \"id\": \"7\",\r\n \"name\": \"All For Paws\",\r\n \"isActive\": true,\r\n \"createdAt\": \"2022-01-17T19:43:14.18678Z\",\r\n \"updatedAt\": \"2022-01-17T19:43:14.18678Z\"\r\n },\r\n {\r\n \"id\": \"1\",\r\n \"name\": \"AOC\",\r\n \"isActive\": true,\r\n \"createdAt\": \"2021-08-16T21:13:40.55189Z\",\r\n \"updatedAt\": \"2021-08-16T21:13:40.55189Z\"\r\n }\r\n ],\r\n \"_metadata\": {\r\n \"total\": 18,\r\n \"from\": 1,\r\n \"to\": 2,\r\n \"orderBy\": \"name,asc\"\r\n }\r\n}\r\n```","operationId":"ListBrand","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":"Search word.","explode":true,"in":"query","name":"q","required":false,"schema":{"example":"tshirt","type":"string"},"style":"form"},{"description":"The first page of the interval of the brand list.","explode":true,"in":"query","name":"from","required":false,"schema":{"example":"1","type":"string"},"style":"form"},{"description":"The last page of the interval of the brand list.","explode":true,"in":"query","name":"to","required":false,"schema":{"example":"50","type":"string"},"style":"form"},{"description":"The order that the list is displayed. You can select `name`, or `updated_at` to select the order criteria. Then you can add `,` , `asc` or `desc` to define the brands order.","explode":true,"in":"query","name":"orderBy","required":false,"schema":{"example":"status,asc;name,asc","type":"string"},"style":"form"},{"description":"Brand name.","explode":true,"in":"query","name":"name","required":false,"schema":{"example":"Zwilling","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"_metadata":{"from":1,"orderBy":"name,desc","to":10,"total":1399},"data":[{"createdAt":"2025-04-15T13:51:55.670Z","id":"863","isActive":false,"name":"Zwilling","updatedAt":"2025-04-15T13:51:55.670Z"},{"createdAt":"2025-04-15T13:51:55.670Z","id":"1298","isActive":false,"name":"Zooz Pets","updatedAt":"2025-04-15T13:51:55.670Z"}]},"schema":{"properties":{"_metadata":{"description":"Information about the organization and exhibition of the brand list.","example":{"from":1,"orderBy":"name,desc","to":10,"total":1399},"properties":{"from":{"description":"The first page of the interval of the brand list.","example":1,"title":"from","type":"integer"},"orderBy":{"description":"The order that the list is displayed. You can select `name`, or `updated_at` to select the order criteria. Then you can add `,` , `asc` or `desc` to define the brands order.","example":"name,desc","title":"orderBy","type":"string"},"to":{"description":"The last page of the interval of the brand list.","example":10,"title":"to","type":"integer"},"total":{"description":"Total of brands on the list.","example":1399,"title":"total","type":"integer"}},"required":["total","from","to","orderBy"],"title":"_metadata","type":"object"},"data":{"description":"List with information about the store's brands.","items":{"example":{"createdAt":"2025-04-15T13:51:55.670Z","displayOnMenu":false,"id":"863","isActive":false,"name":"Zwilling","score":0,"updatedAt":"2025-04-15T13:51:55.670Z"},"properties":{"createdAt":{"description":"Date when the brand was created.","example":"2025-04-15T13:51:55.670Z","title":"createdAt","type":"string"},"id":{"description":"Brand unique identifier number.","example":"863","title":"id","type":"string"},"isActive":{"description":"The condition defines if the brand is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"name":{"description":"Brand Name.","example":"Zwilling","title":"name","type":"string"},"updatedAt":{"description":"Last date when the brand was updated.","example":"2025-04-15T13:51:55.670Z","title":"updatedAt","type":"string"}},"required":["id","name","isActive","createdAt","updatedAt"],"title":"","type":"object"},"title":"data","type":"array"}},"required":["data","_metadata"],"title":"","type":"object"}}},"description":"OK","headers":{}}},"summary":"Get List of Brands","tags":["Brand"]},"post":{"description":" >📘 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Creates a new brand.\r\n\r\n## Request body example\r\n\r\n```json\r\n{\r\n \"name\": \"Zwilling\",\r\n \"isActive\": true\r\n}\r\n```\r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"id\": \"20\",\r\n \"name\": \"Zwilling\",\r\n \"isActive\": true,\r\n \"createdAt\": \"2021-05-17T15:20:36.077253+00:00\",\r\n \"updatedAt\": \"2021-01-18T14:41:45.696488+00:00\"\r\n}\r\n```","operationId":"PostBrand","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":{"example":{"isActive":true,"name":"Zwilling"},"schema":{"properties":{"isActive":{"description":"The condition defines if the brand is active (`true`) or inactive (`false`).","example":true,"title":"isActive","type":"boolean"},"name":{"description":"Brand Name.","example":"Zwilling","title":"name","type":"string"}},"required":["name","isActive"],"title":"","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"createdAt":"2025-04-15T13:51:55.670Z","id":"863","isActive":true,"name":"Zwilling","updatedAt":"2025-04-15T13:51:55.670Z"},"schema":{"properties":{"createdAt":{"description":"Date when the brand was created.","example":"2025-04-15T13:51:55.670Z","title":"createdAt","type":"string"},"id":{"description":"Brand unique identifier number.","example":"863","title":"id","type":"string"},"isActive":{"description":"The condition defines if the brand is active (`true`) or inactive (`false`).","example":true,"title":"isActive","type":"boolean"},"name":{"description":"Brand Name.","example":"Zwilling","title":"name","type":"string"},"updatedAt":{"description":"Last date when the brand was updated.","example":"2025-04-15T13:51:55.670Z","title":"updatedAt","type":"string"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Create Brand","tags":["Brand"]}},"/api/catalog-seller-portal/brands/{brandId}":{"get":{"description":" >📘 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Retrieves general information about a brand by its ID.\r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"id\": \"863\",\r\n \"name\": \"Zwilling\",\r\n \"isActive\": false,\r\n \"createdAt\": \"2021-01-18T14:41:45.696488+00:00\",\r\n \"updatedAt\": \"2021-01-18T14:41:45.696488+00:00\"\r\n}\r\n```","operationId":"GetBrand","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":"Brand unique identifier number.","in":"path","name":"brandId","required":true,"schema":{"example":"863","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"createdAt":"2025-04-15T13:51:55.670Z","id":"863","isActive":false,"name":"Zwilling","updatedAt":"2025-04-15T13:51:55.670Z"},"schema":{"example":{"createdAt":"2025-04-15T13:51:55.670Z","id":"863","isActive":false,"name":"Zwilling","updatedAt":"2025-04-15T13:51:55.670Z"},"properties":{"createdAt":{"description":"Date when the brand was created.","example":"2025-04-15T13:51:55.670Z","title":"createdAt","type":"string"},"id":{"description":"Brand unique identifier number.","example":"863","title":"id","type":"string"},"isActive":{"description":"The condition defines if the brand is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"name":{"description":"Brand Name.","example":"Zwilling","title":"name","type":"string"},"updatedAt":{"description":"Last date when the brand was updated.","example":"2025-04-15T13:51:55.670Z","title":"updatedAt","type":"string"}},"title":"","type":"object"}}},"description":"OK"}},"summary":"Get Brand by ID","tags":["Brand"]},"put":{"description":" >📘 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Updates an existing brand. \r\n\r\n## Request body example\r\n\r\n```json\r\n{\r\n \"id\": \"20\",\r\n \"name\": \"Zwilling\",\r\n \"isActive\": true\r\n}\r\n```","operationId":"PutBrand","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":"Brand unique identifier number.","in":"path","name":"brandId","required":true,"schema":{"example":"20","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"id":"20","isActive":true,"name":"Zwilling"},"schema":{"properties":{"id":{"description":"Brand unique identifier number.","example":"20","title":"id","type":"string"},"isActive":{"description":"The condition defines if the brand is active (`true`) or inactive (`false`).","example":true,"title":"isActive","type":"boolean"},"name":{"description":"Brand Name.","example":"Zwilling","title":"name","type":"string"}},"required":["id","name","isActive"],"title":"","type":"object"}}}},"responses":{"204":{"description":"No Content"}},"summary":"Update Brand","tags":["Brand"]}},"/api/catalog-seller-portal/category-tree":{"get":{"description":" >📘 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Retrieves general information about the category tree from the store.\r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"roots\": [\r\n {\r\n \"value\": {\r\n \"id\": \"2\",\r\n \"name\": \"Departamento Artesanato\",\r\n \"isActive\": true\r\n },\r\n \"children\": [\r\n {\r\n \"value\": {\r\n \"id\": \"3\",\r\n \"name\": \"Artesanato de Barro\",\r\n \"isActive\": false\r\n },\r\n \"children\": [\r\n {\r\n \"value\": {\r\n \"id\": \"4\",\r\n \"name\": \"Artesanato de Barro Vermelho\",\r\n \"isActive\": false\r\n },\r\n \"children\": []\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"value\": {\r\n \"id\": \"5\",\r\n \"name\": \"Perfumes\",\r\n \"isActive\": false\r\n },\r\n \"children\": [\r\n {\r\n \"value\": {\r\n \"id\": \"6\",\r\n \"name\": \"Perfume Feminino\",\r\n \"isActive\": false\r\n },\r\n \"children\": []\r\n },\r\n {\r\n \"value\": {\r\n \"id\": \"7\",\r\n \"name\": \"Perfume Masculino\",\r\n \"isActive\": false,\r\n \"displayOnMenu\": false,\r\n \"score\": 0,\r\n \"filterByBrand\": false,\r\n \"isClickable\": false\r\n },\r\n \"children\": []\r\n }\r\n ]\r\n }\r\n ],\r\n \"createdAt\": \"2021-08-16T20:57:13.070813Z\",\r\n \"updatedAt\": \"2022-07-07T14:24:56.416337Z\"\r\n}\r\n```","operationId":"GetCategoryTree","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 tree level.","in":"query","name":"depth","required":false,"schema":{"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"createdAt":"2025-04-15T13:51:55.670Z","roots":[{"children":[{"children":[{"children":[],"value":{"id":"4","isActive":false,"name":"Artesanato de Barro Vermelho"}}],"value":{"id":"3","isActive":false,"name":"Artesanato de Barro"}}],"value":{"id":"2","isActive":true,"name":"Departamento Artesanato"}},{"children":[{"children":[],"value":{"id":"6","isActive":false,"name":"Perfume Feminino"}},{"children":[],"value":{"displayOnMenu":false,"filterByBrand":false,"id":"7","isActive":false,"isClickable":false,"name":"Perfume Masculino","score":0}}],"value":{"id":"5","isActive":false,"name":"Perfumes"}}],"updatedAt":"2025-04-15T13:51:55.670Z"},"schema":{"properties":{"createdAt":{"description":"Date when the category tree was created.","example":"2025-04-15T13:51:55.670Z","title":"createdAt","type":"string"},"roots":{"description":"List of all categories of the store.","example":[{"children":[{"value":{"id":"2","isActive":false,"name":"Perfumes"}}],"value":{"id":"1","isActive":false,"name":"sandboxintegracao"}}],"items":{"properties":{"children":{"description":"List of all children categories of the parent category.","example":[{"value":{"id":"2","isActive":false,"name":"Perfumes"}}],"items":{"example":{"value":{"id":"2","isActive":false,"name":"Perfumes"}},"properties":{"value":{"description":"Object with values of a children category.","example":{"id":"2","isActive":false,"name":"Perfumes"},"properties":{"id":{"description":"Children category unique identifier number.","title":"id","type":"string"},"isActive":{"description":"The condition defines if the children category is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"name":{"description":"Children category Name.","example":"Perfumes","title":"name","type":"string"}},"required":["id","name","isActive"],"title":"value","type":"object"}},"required":["value"],"title":"","type":"object"},"title":"children","type":"array"},"value":{"description":"Object with values of a category.","example":{"id":"1","isActive":false,"name":"sandboxintegracao"},"properties":{"id":{"description":"Category unique identifier number.","example":"1","title":"id","type":"string"},"isActive":{"description":"The condition defines if the category is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"name":{"description":"Category Name.","example":"sandboxintegracao","title":"name","type":"string"}},"required":["id","name","isActive"],"title":"value","type":"object"}},"required":["value","children"],"title":"","type":"object"},"title":"roots","type":"array"},"updatedAt":{"description":"Last date when the category tree was updated.","example":"2025-04-15T13:51:55.670Z","title":"updatedAt","type":"string"}},"required":["roots"],"title":"","type":"object"}}},"description":"OK"}},"summary":"Get Category Tree","tags":["Category"]},"put":{"deprecated":false,"description":" >📘 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Updates the existing categories in the category tree.\r\n\r\n## Request body example\r\n\r\n```json\r\n{\r\n \"roots\": [\r\n {\r\n \"value\": {\r\n \"id\": \"2\",\r\n \"name\": \"Departamento Artesanato\",\r\n \"isActive\": true\r\n },\r\n \"children\": [\r\n {\r\n \"value\": {\r\n \"id\": \"3\",\r\n \"name\": \"Artesanato de Barro\",\r\n \"isActive\": false\r\n },\r\n \"children\": [\r\n {\r\n \"value\": {\r\n \"id\": \"4\",\r\n \"name\": \"Artesanato de Barro Vermelho\",\r\n \"isActive\": false\r\n },\r\n \"children\": []\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"value\": {\r\n \"id\": \"5\",\r\n \"name\": \"Perfumes\",\r\n \"isActive\": false\r\n },\r\n \"children\": [\r\n {\r\n \"value\": {\r\n \"id\": \"6\",\r\n \"name\": \"Perfume Feminino\",\r\n \"isActive\": false\r\n },\r\n \"children\": []\r\n },\r\n {\r\n \"value\": {\r\n \"id\": \"7\",\r\n \"name\": \"Perfume Masculino\",\r\n \"isActive\": false,\r\n \"displayOnMenu\": false,\r\n \"score\": 0,\r\n \"filterByBrand\": false,\r\n \"isClickable\": false\r\n },\r\n \"children\": []\r\n }\r\n ]\r\n }\r\n ]\r\n}\r\n```","operationId":"UpdateCategoryTree","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":{"example":{"roots":[{"children":[{"children":[{"children":[],"value":{"id":"4","isActive":false,"name":"Artesanato de Barro Vermelho"}}],"value":{"id":"3","isActive":false,"name":"Artesanato de Barro"}}],"value":{"id":"2","isActive":true,"name":"Departamento Artesanato"}},{"children":[{"children":[],"value":{"id":"6","isActive":false,"name":"Perfume Feminino"}},{"children":[],"value":{"id":"7","isActive":false,"name":"Perfume Masculino"}}],"value":{"id":"5","isActive":false,"name":"Perfumes"}}]},"schema":{"properties":{"roots":{"description":"List of all categories of the store.","example":[{"children":[{"value":{"id":"2","isActive":false,"name":"Perfumes"}}],"value":{"id":"1","isActive":false,"name":"sandboxintegracao"}}],"items":{"properties":{"children":{"description":"List of all children categories of the parent category.","example":[{"value":{"id":"2","isActive":false,"name":"Perfumes"}}],"items":{"example":{"value":{"id":"2","isActive":false,"name":"Perfumes"}},"properties":{"value":{"description":"Object with values of a children category.","example":{"id":"2","isActive":false,"name":"Perfumes"},"properties":{"id":{"description":"Children category unique identifier number.","title":"id","type":"string"},"isActive":{"description":"The condition defines if the children category is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"name":{"description":"Children category Name.","example":"Perfumes","title":"name","type":"string"}},"required":["id","name","isActive"],"title":"value","type":"object"}},"required":["value"],"title":"","type":"object"},"title":"children","type":"array"},"value":{"description":"Object with values of a category.","example":{"id":"1","isActive":false,"name":"sandboxintegracao"},"properties":{"id":{"description":"Category unique identifier number.","example":"1","title":"id","type":"string"},"isActive":{"description":"The condition defines if the category is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"name":{"description":"Category Name.","example":"sandboxintegracao","title":"name","type":"string"}},"required":["id","name","isActive"],"title":"value","type":"object"}},"required":["value","children"],"title":"","type":"object"},"title":"roots","type":"array"}},"required":["roots"],"title":"","type":"object"}}},"description":"OK","required":true},"responses":{"204":{"description":"No Content"}},"summary":"Update Category Tree","tags":["Category"]}},"/api/catalog-seller-portal/category-tree/categories":{"post":{"deprecated":false,"description":" >📘 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Creates a new category.\r\n\r\n## Request body example\r\n\r\n```json\r\n{\r\n \"parentId\": \"567\",\r\n \"Name\": \"Beauty\"\r\n}\r\n```\r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"value\": {\r\n \"id\": \"1\",\r\n \"name\": \"Beauty\",\r\n \"isActive\": false\r\n },\r\n \"children\": [\r\n {\r\n \"value\": {\r\n \"id\": \"2\",\r\n \"name\": \"Perfumes\",\r\n \"isActive\": false\r\n }\r\n }\r\n ]\r\n}\r\n```","operationId":"CreateCategory","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":{"example":{"Name":"Beauty","parentId":"567"},"schema":{"properties":{"Name":{"description":"Category name.","example":"Beauty","title":"Name","type":"string"},"parentId":{"description":"Parent category unique identifier number.","example":"567","title":"parentId","type":"string"}},"required":["parentId","Name"],"title":"","type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"children":[{"value":{"id":"2","isActive":false,"name":"Perfumes"}}],"value":{"id":"1","isActive":false,"name":"Beauty"}},"schema":{"properties":{"children":{"description":"List of all children categories of the parent category.","example":[{"value":{"id":"2","isActive":false,"name":"Perfumes"}}],"items":{"example":{"value":{"id":"2","isActive":false,"name":"Perfumes"}},"properties":{"value":{"description":"Object with values of a children category.","example":{"id":"2","isActive":false,"name":"Perfumes"},"properties":{"id":{"description":"Children category unique identifier number.","title":"id","type":"string"},"isActive":{"description":"The condition defines if the children category is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"name":{"description":"Children category Name.","example":"Perfumes","title":"name","type":"string"}},"required":["id","name","isActive"],"title":"value","type":"object"}},"required":["value"],"title":"","type":"object"},"title":"children","type":"array"},"value":{"description":"Object with values of a category.","example":{"id":"1","isActive":false,"name":"sandboxintegracao"},"properties":{"id":{"description":"Category unique identifier number.","example":"1","title":"id","type":"string"},"isActive":{"description":"The condition defines if the category is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"name":{"description":"Category Name.","example":"sandboxintegracao","title":"name","type":"string"}},"required":["id","name","isActive"],"title":"value","type":"object"}},"required":["value","children"],"title":"","type":"object"}}},"description":"OK"}},"summary":"Create Category","tags":["Category"]}},"/api/catalog-seller-portal/category-tree/categories/{categoryId}":{"get":{"description":" >📘 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Retrieves general information about a category by its ID. \r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"value\": {\r\n \"id\": \"1\",\r\n \"name\": \"sandboxintegracao\",\r\n \"isActive\": false\r\n },\r\n \"children\": [\r\n {\r\n \"value\": {\r\n \"id\": \"2\",\r\n \"name\": \"Perfumes\",\r\n \"isActive\": false\r\n }\r\n }\r\n ]\r\n}\r\n```","operationId":"Getbyid","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 unique identifier number.","in":"path","name":"categoryId","required":true,"schema":{"example":"1","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"children":[{"value":{"id":"2","isActive":false,"name":"Perfumes"}}],"value":{"id":"1","isActive":false,"name":"sandboxintegracao"}},"schema":{"properties":{"children":{"description":"List of all children categories of the parent category.","example":[{"value":{"id":"2","isActive":false,"name":"Perfumes"}}],"items":{"example":{"value":{"id":"2","isActive":false,"name":"Perfumes"}},"properties":{"value":{"description":"Object with values of a children category.","example":{"id":"2","isActive":false,"name":"Perfumes"},"properties":{"id":{"description":"Children category unique identifier number.","example":"234","title":"id","type":"string"},"isActive":{"description":"The condition defines if the children category is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"name":{"description":"Children category Name.","example":"Perfumes","title":"name","type":"string"}},"required":["id","name","isActive"],"title":"value","type":"object"}},"required":["value"],"title":"","type":"object"},"title":"children","type":"array"},"value":{"description":"Object with values of a category.","example":{"id":"1","isActive":false,"name":"sandboxintegracao"},"properties":{"id":{"description":"Category unique identifier number.","example":"1","title":"id","type":"string"},"isActive":{"description":"The condition defines if the category is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"name":{"description":"Category Name.","example":"sandboxintegracao","title":"name","type":"string"}},"required":["id","name","isActive"],"title":"value","type":"object"}},"required":["value","children"],"title":"","type":"object"}}},"description":"OK"}},"summary":"Get Category by ID","tags":["Category"]}},"/api/catalog-seller-portal/products":{"post":{"description":" >📘 This API is part of the [Seller Portal Catalog](https://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp). This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact [our Support Center](https://support.vtex.com/hc/en-us/requests). \r\n\r\n Creates a new product and its SKUs. \r\n\r\n\r\n## Request body example\r\n\r\n```json\r\n{\r\n \"status\": \"active\",\r\n \"name\": \"VTEX 10 Shirt\",\r\n \"description\": \"Shirt number 10 by VTEX.\",\r\n \"brandId\": \"1\",\r\n \"categoryIds\": [\r\n \"732\"\r\n ],\r\n \"specs\": [\r\n {\r\n \"name\": \"Color\",\r\n \"values\": [\r\n \"Black\",\r\n \"White\"\r\n ]\r\n },\r\n {\r\n \"name\": \"Size\",\r\n \"values\": [\r\n \"S\",\r\n \"M\",\r\n \"L\"\r\n ]\r\n }\r\n ],\r\n \"attributes\": [\r\n {\r\n \"name\": \"Fabric\",\r\n \"value\": \"Cotton\"\r\n },\r\n {\r\n \"name\": \"Gender\",\r\n \"value\": \"Feminine\"\r\n }\r\n ],\r\n \"slug\": \"/vtex-shirt\",\r\n \"images\": [\r\n {\r\n \"id\": \"vtex_logo.jpg\",\r\n \"url\": \"https://vtxleo7778.vtexassets.com/assets/vtex.catalog-images/products/vtex_logo.jpg\",\r\n \"alt\": \"VTEX\"\r\n }\r\n ],\r\n \"skus\": [\r\n {\r\n \"name\": \"VTEX Shirt Black Size S\",\r\n \"externalId\": \"1909621862\",\r\n \"manufacturerCode\": \"1234567\",\r\n \"isActive\": true,\r\n \"weight\": 300,\r\n \"dimensions\": {\r\n \"width\": 1.5,\r\n \"height\": 2.1,\r\n \"length\": 1.6\r\n },\r\n \"specs\": [\r\n {\r\n \"name\": \"Color\",\r\n \"value\": \"Black\"\r\n },\r\n {\r\n \"name\": \"Size\",\r\n \"value\": \"S\"\r\n }\r\n ],\r\n \"images\": [\r\n \"vtex_logo.jpg\"\r\n ]\r\n },\r\n {\r\n \"name\": \"VTEX Shirt White Size L\",\r\n \"externalId\": \"1909621862\",\r\n \"manufacturerCode\": \"1234568\",\r\n \"isActive\": true,\r\n \"weight\": 300,\r\n \"dimensions\": {\r\n \"width\": 1.5,\r\n \"height\": 2.1,\r\n \"length\": 1.6\r\n },\r\n \"specs\": [\r\n {\r\n \"name\": \"Color\",\r\n \"value\": \"White\"\r\n },\r\n {\r\n \"name\": \"Size\",\r\n \"value\": \"L\"\r\n }\r\n ],\r\n \"images\": [\r\n \"vtex_logo.jpg\"\r\n ]\r\n }\r\n ],\r\n \"origin\": \"vtxleo7778\",\r\n \"transportModal\": \"110\",\r\n \"taxCode\": \"234\"\r\n}\r\n```\r\n\r\n## Response body example\r\n\r\n```json\r\n{\r\n \"id\": \"189371\",\r\n \"status\": \"active\",\r\n \"name\": \"VTEX 10 Shirt\",\r\n \"brandId\": \"1\",\r\n \"brandName\": \"AOC\",\r\n \"categoryIds\": [\r\n \"732\"\r\n ],\r\n \"categoryNames\": [\r\n \"/Men/Acessories/\"\r\n ],\r\n \"specs\": [\r\n {\r\n \"name\": \"Color\",\r\n \"values\": [\r\n \"Black\",\r\n \"White\"\r\n ]\r\n },\r\n {\r\n \"name\": \"Size\",\r\n \"values\": [\r\n \"S\",\r\n \"M\",\r\n \"L\"\r\n ]\r\n }\r\n ],\r\n \"attributes\": [\r\n {\r\n \"name\": \"Fabric\",\r\n \"value\": \"Cotton\"\r\n },\r\n {\r\n \"name\": \"Gender\",\r\n \"value\": \"Feminine\"\r\n }\r\n ],\r\n \"slug\": \"/vtex-shirt\",\r\n \"images\": [\r\n {\r\n \"id\": \"vtex_logo.jpg\",\r\n \"url\": \"https://vtxleo7778.vtexassets.com/assets/vtex.catalog-images/products/vtex_logo.jpg\",\r\n \"alt\": \"VTEX\"\r\n }\r\n ],\r\n \"skus\": [\r\n {\r\n \"id\": \"182907\",\r\n \"name\": \"VTEX Shirt Black Size S\",\r\n \"externalId\": \"1909621862\",\r\n \"manufacturerCode\": \"1234567\",\r\n \"isActive\": true,\r\n \"weight\": 300,\r\n \"dimensions\": {\r\n \"width\": 1.5,\r\n \"height\": 2.1,\r\n \"length\": 1.6\r\n },\r\n \"specs\": [\r\n {\r\n \"name\": \"Color\",\r\n \"value\": \"Black\"\r\n },\r\n {\r\n \"name\": \"Size\",\r\n \"value\": \"S\"\r\n }\r\n ],\r\n \"images\": [\r\n \"vtex_logo.jpg\"\r\n ]\r\n },\r\n {\r\n \"id\": \"182908\",\r\n \"name\": \"VTEX Shirt White Size L\",\r\n \"externalId\": \"1909621862\",\r\n \"manufacturerCode\": \"1234568\",\r\n \"isActive\": true,\r\n \"weight\": 300,\r\n \"dimensions\": {\r\n \"width\": 1.5,\r\n \"height\": 2.1,\r\n \"length\": 1.6\r\n },\r\n \"specs\": [\r\n {\r\n \"name\": \"Color\",\r\n \"value\": \"White\"\r\n },\r\n {\r\n \"name\": \"Size\",\r\n \"value\": \"L\"\r\n }\r\n ],\r\n \"images\": [\r\n \"vtex_logo.jpg\"\r\n ]\r\n }\r\n ],\r\n \"origin\": \"vtxleo7778\",\r\n \"transportModal\": \"110\",\r\n \"taxCode\": \"234\",\r\n \"createdAt\": \"2022-11-01T14:15:54.262702Z\",\r\n \"updatedAt\": \"2022-11-01T14:15:54.262702Z\"\r\n}\r\n```","operationId":"PostProduct","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":{"example":{"attributes":[{"name":"Fabric","value":"Cotton"},{"name":"Gender","value":"Feminine"}],"brandId":"1","categoryIds":["732"],"description":"Shirt number 10 by VTEX.","images":[{"alt":"VTEX","id":"vtex_logo.jpg","url":"https://vtxleo7778.vtexassets.com/assets/vtex.catalog-images/products/vtex_logo.jpg"}],"name":"VTEX 10 Shirt","origin":"vtxleo7778","skus":[{"dimensions":{"height":2.1,"length":1.6,"width":1.5},"externalId":"1909621862","images":["vtex_logo.jpg"],"isActive":true,"manufacturerCode":"1234567","name":"VTEX Shirt Black Size S","specs":[{"name":"Color","value":"Black"},{"name":"Size","value":"S"}],"weight":300},{"dimensions":{"height":2.1,"length":1.6,"width":1.5},"externalId":"1909621862","images":["vtex_logo.jpg"],"isActive":true,"manufacturerCode":"1234568","name":"VTEX Shirt White Size L","specs":[{"name":"Color","value":"White"},{"name":"Size","value":"L"}],"weight":300}],"slug":"/vtex-shirt","specs":[{"name":"Color","values":["Black","White"]},{"name":"Size","values":["S","M","L"]}],"status":"active","taxCode":"234","transportModal":"110"},"schema":{"properties":{"attributes":{"description":"Attributes of the product. Attributes are additional properties used to create site browsing filters.","example":[{"name":"Fabric","value":"Cotton"},{"name":"Gender","value":"Feminine"}],"items":{"properties":{"name":{"description":"Attribute name.","example":"Fabric","title":"name","type":"string"},"value":{"description":"Attribute value.","example":"Cotton","title":"value","type":"string"}},"required":["name","value"],"title":""},"title":"attributes","type":"array"},"brandId":{"description":"Product's Brand unique identifier number.","example":"1","title":"brandId","type":"string"},"categoryIds":{"description":"Product's Categories unique identifier numbers. It can have multiples IDs for each Category and Subcategories.","example":["732"],"items":{"title":"","type":"string"},"title":"categoryIds","type":"array"},"description":{"description":"Description of the primary information related to the product. A simple and easy-to-understand summary for the customer.","example":"Descrição camiseta VTEX","title":"description","type":"string"},"externalId":{"description":"Product reference unique identifier number in the store.","example":"sandboxintegracao-310117347","title":"externalId","type":"string"},"images":{"description":"Information of the images of the product.","example":[{"alt":"imagem","id":"vtex_logo.jpg","url":"https://vtxleo7778.vtexassets.com/assets/vtex.catalog-images/products/vtex_logo.jpg"}],"items":{"properties":{"alt":{"description":"Image alternative description.","example":"imagem","title":"alt","type":"string"},"id":{"description":"Image ID.","example":"vtex_logo.jpg","title":"id","type":"string"},"url":{"description":"Image URL, which must be in the following format: `https://{accountName}.vtexassets.com/assets/{path}`, saved using the [Catalog Images app](https://developers.vtex.com/vtex-developer-docs/docs/vtex-catalog-images).","example":"https://mystore.vtexassets.com/assets/vtex.catalog-images/products/vtex_logo.jpg","title":"url","type":"string"}},"required":["id","url"],"title":"","type":"object"},"title":"images","type":"array"},"name":{"description":"Product Name. Use simple words and avoid other languages or complex writing. This field is essential for SEO and must respect the 150 character limit.","example":"VTEX Shirt","title":"name","type":"string"},"origin":{"description":"Origin account of the product. It is not possible to alter products where the origin is `marketplace`.","example":"vtxleo7778","title":"origin","type":"string"},"skus":{"description":"SKUs of the product.","example":[{"dimensions":{"height":2.1,"length":1.6,"width":1.5},"ean":"978-1909621862","externalId":"1909621862","images":["https://mystore.vtexassets.com/assets/vtex.catalog-images/products/vtex_logo.jpg"],"isActive":true,"manufacturerCode":"1234567","name":"VTEX Shirt Black Size S","specs":[{"name":"Color","value":"Black"},{"name":"Size","value":"S"}],"weight":300},{"dimensions":{"height":2.1,"length":1.6,"width":1.5},"ean":"978-1909621862","externalId":"1909621862","images":["vtex_logo.jpg"],"isActive":true,"manufacturerCode":"1234568","name":"VTEX Shirt White Size L","specs":[{"name":"Color","value":"White"},{"name":"Size","value":"L"}],"weight":300}],"items":{"properties":{"dimensions":{"description":"SKU dimensions.","example":{"height":2.1,"length":1.6,"width":1.5},"properties":{"height":{"description":"SKU height.","example":2.1,"title":"height","type":"number"},"length":{"description":"SKU length.","example":1.6,"title":"length","type":"number"},"width":{"description":"SKU width.","example":1.5,"title":"width","type":"number"}},"required":["width","height","length"],"title":"dimensions","type":"object"},"ean":{"description":"Unique SKU identification code (barcode), composed of up to 13 numeric characters.","example":"978-1909621862","title":"ean","type":"string"},"externalId":{"description":"Unique reference code created to improve the store's organization. This is not a required field.","example":"1909621862","title":"externalId","type":"string"},"images":{"description":"SKU's images IDs.","example":["vtex_logo.jpg"],"items":{},"title":"images","type":"array"},"isActive":{"description":"If the SKU is active (`true`) or inactive (`false`).","example":false,"title":"isActive","type":"boolean"},"manufacturerCode":{"description":"SKU reference code in the store.","example":"1234567","title":"code","type":"string"},"name":{"description":"SKU Name. Use simple words and avoid other languages or complex writing. This field is essential for SEO and must respect the 150 character limit.","example":"VTEX Shirt Black Size S","title":"name","type":"string"},"specs":{"description":"SKU specifications. This field is mandatory, but nullable if there is only one SKU.","example":[{"name":"Color","value":"Black"},{"name":"Size","value":"S"}],"items":{"properties":{"name":{"description":"SKU's specification name.","example":"Color","title":"name","type":"string"},"value":{"description":"SKU's specification values.","example":"Black","title":"value","type":"string"}},"required":["name","value"],"title":"","type":"object"},"nullable":true,"title":"specs","type":"array"},"weight":{"description":"SKU weight.","example":300,"title":"weight","type":"integer"}},"required":["name","isActive","weight","dimensions","specs","images"],"title":"","type":"object"},"title":"skus","type":"array"},"slug":{"description":"Reference of the product in the URL of the store.","example":"/vtex-shirt","title":"slug","type":"string"},"specs":{"description":"Specifications that will differentiate the possible product SKUs.","example":[{"name":"Color","values":["Black","White"]},{"name":"Size","values":["S","M","L"]}],"items":{"properties":{"name":{"description":"Specification name.","example":"Color","title":"name","type":"string"},"values":{"description":"Specification values.","example":["Black","White"],"items":{"title":"","type":"string"},"title":"values","type":"array"}},"required":["name","values"],"title":"","type":"object"},"title":"specs","type":"array"},"status":{"description":"Status of the product. Its values can be `active` or `inactive`.","example":"active","title":"status","type":"string"},"taxCode":{"description":"Product tax code.","example":"123","nullable":true,"title":"taxCode","type":"string"},"transportModal":{"description":"Transport modal of the product.","example":"1","nullable":true,"title":"transportModal","type":"string"}},"required":["status","name","brandId","categoryIds","specs","attributes","slug","images","skus","origin"],"title":"","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"attributes":[{"name":"Fabric","value":"Cotton"},{"name":"Gender","value":"Feminine"}],"brandId":"1","brandName":"AOC","categoryIds":["732"],"categoryNames":["/sandboxintegracao/Acessórios/"],"createdAt":"2025-04-15T13:51:55.671Z","id":"189371","images":[{"alt":"VTEX","id":"vtex_logo.jpg","url":"https://vtxleo7778.vtexassets.com/assets/vtex.catalog-images/product