{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Category API", "version": "1.0" }, "items": [ { "info": { "name": "Category", "type": "folder" }, "items": [ { "info": { "name": "VTex Get Category Tree", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/category-tree", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "depth", "value": "", "type": "query", "description": "Category tree level." } ] }, "docs": " >📘 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 tr" }, { "info": { "name": "VTex Update Category Tree", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/category-tree", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": " >📘 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 tre" }, { "info": { "name": "VTex Get Category by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/category-tree/categories/:categoryId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "categoryId", "value": "", "type": "path", "description": "Category unique identifier number." } ] }, "docs": " >📘 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 i" }, { "info": { "name": "VTex Create Category", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/category-tree/categories", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": " >📘 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## Permissions\r\n\r\nAny us" }, { "info": { "name": "VTex Get category tree", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pub/category/tree/:categoryLevels", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "categoryLevels", "value": "", "type": "path", "description": "Value of the category level you need to retrieve." } ] }, "docs": "Retrieves the category tree of your store. Get all the category levels registered in the Catalog or define the level up to which you want to get. \r\n> 📘 Onboarding guide \r\n>\r\n> Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/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\n## " }, { "info": { "name": "VTex Get category by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog/pvt/category/:categoryId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "categoryId", "value": "", "type": "path", "description": "Category's unique numerical identifier." } ] }, "docs": "Retrieves general information about a category.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Pr" }, { "info": { "name": "VTex Update category", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/catalog/pvt/category/:categoryId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "categoryId", "value": "", "type": "path", "description": "Category's unique numerical identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a previously existing category.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** " }, { "info": { "name": "VTex Create category", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog/pvt/category", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to succ" } ] } ], "bundled": true }