{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Product API", "version": "1.0" }, "items": [ { "info": { "name": "Product", "type": "folder" }, "items": [ { "info": { "name": "VTex Get Product by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/products/:productId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product 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 product by it" }, { "info": { "name": "VTex Update Product", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/products/:productId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product unique identifier number." } ], "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 an existing product and its SKUs.\r\n\r\n## Per" }, { "info": { "name": "VTex Get Product Description by Product ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/products/:productId/description", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product 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 the description of a product given a prod" }, { "info": { "name": "VTex Update Product Description by Product ID", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/products/:productId/description", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product unique identifier number." } ], "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 description of a product given a produc" }, { "info": { "name": "VTex Get Product by external ID, SKU ID, SKU external ID or slug", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/products/:param", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "param", "value": "", "type": "path", "description": "This part of the path must follow this format: `{param}={value}`. Replace `{param}` with the name of the parameter used to fetch a product, which can be one of the following: `external-id` (product reference unique identifier number in the store), `sku-id` (SKU unique identifier number), `sku-external-id` (SKU reference unique identifier number in the store) or `slug` (reference of the product in the URL of the store). Replace `{value}` with the value of the selected param. Make sure there is a `=` between them." } ] }, "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 product by it" }, { "info": { "name": "VTex Create Product", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/products", "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 product and its SKUs.\r\n\r\n## Permissio" }, { "info": { "name": "VTex Get product and SKU IDs", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/products/GetProductAndSkuIds", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "categoryId", "value": "", "type": "query", "description": "ID of the category from which you need to retrieve products and SKUs." }, { "name": "_from", "value": "", "type": "query", "description": "Insert the ID that will start the request result." }, { "name": "_to", "value": "", "type": "query", "description": "Insert the ID that will end the request result." } ] }, "docs": "Retrieves the IDs of products and SKUs. \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/api-authentication-usi" }, { "info": { "name": "VTex Get product by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog/pvt/product/:productId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." } ] }, "docs": "Retrieves a specific product by its ID. The response body fields are exactly the inforamtion needed to create a new product. \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 us" }, { "info": { "name": "VTex Update product", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/catalog/pvt/product/:productId", "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": "Updates an existing 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 endpoint:\r\n\r\n| **Product** | **Categor" }, { "info": { "name": "VTex Get product and its general context", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/products/productget/:productId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." } ] }, "docs": "Retrieves a specific product's general information as name, description and the trade policies where it is included.\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` e" }, { "info": { "name": "VTex Get product by reference ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/products/productgetbyrefid/:refId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "refId", "value": "", "type": "path", "description": "Product reference code." } ] }, "docs": "Retrieves a specific product by its Reference 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 endpoint:\r\n\r\n| **" }, { "info": { "name": "VTex Get product's SKUs by product ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pub/products/variations/:productId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." } ] }, "docs": "Retrieves data about a product and all SKUs related to it given 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 reso" }, { "info": { "name": "VTex Get product review rate by product ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/addon/pvt/review/GetProductRate/:productId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." } ] }, "docs": "Retrieves the review rate of a product given 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 resources for this endp" }, { "info": { "name": "VTex Create product with category and brand", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog/pvt/product", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows two types of request:\r\n\r\n**Type 1:** Creating a new product as well as a new category path (including subcategories) and a new brand by using `CategoryPath` and `BrandName` parameters.\r\n\r\n**Type 2:** Creating a new product given an existing `BrandId` and an existing `CategoryId`.\r\n\r\nWhen creating a product, regardless of the type of request, if there is a need to create a new product with a specific custom product ID, specify the `Id` (integer) in the request body. Otherwise" } ] } ], "bundled": true }