{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Product Specification API", "version": "1.0" }, "items": [ { "info": { "name": "Product Specification", "type": "folder" }, "items": [ { "info": { "name": "VTex Get product specifications by product ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/products/:productId/specification", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." } ] }, "docs": "Retrieves all specifications of a product by the product's ID.\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## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/" }, { "info": { "name": "VTex Update product specification by product ID", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/products/:productId/specification", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the value of a product specification by the product's ID. The specification's ID or name can be used to identify what product specification will be updated. specification fields must be previously created in your Catalog.\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--3q6zt" }, { "info": { "name": "VTex Get product specifications and their information by product ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog/pvt/product/:productId/specification", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." } ] }, "docs": "Retrieves information of all specifications of a product by the product's ID.\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 resource" }, { "info": { "name": "VTex Associate product specification", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog/pvt/product/:productId/specification", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associates a previously defined specification to a product.\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 endpoin" }, { "info": { "name": "VTex Delete all product specifications by product ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/catalog/pvt/product/:productId/specification", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." } ] }, "docs": "Deletes all product specifications given a specific product ID.\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 end" }, { "info": { "name": "VTex Delete a product specification", "type": "http" }, "http": { "method": "DELETE", "url": "https://{providerApiEndpoint}/api/catalog/pvt/product/:productId/specification/:specificationId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." }, { "name": "specificationId", "value": "", "type": "path", "description": "Product specification's unique numerical identifier." } ] }, "docs": "Deletes a product specification given a product ID and a specification ID.\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 f" }, { "info": { "name": "VTex Associate product specification using specification name and group name", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/catalog/pvt/product/:productId/specificationvalue", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associates a specification to a product using specification name and group name. Automatically creates the informed group, specification and values if they had not been created before.\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" } ] } ], "bundled": true }