{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account SKU API", "version": "1.0" }, "items": [ { "info": { "name": "SKU", "type": "folder" }, "items": [ { "info": { "name": "VTex Search for SKU", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/skus/_search", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "from", "value": "", "type": "query", "description": "The first page of the interval of the product list." }, { "name": "to", "value": "", "type": "query", "description": "The last page of the interval of the product list." }, { "name": "id", "value": "", "type": "query", "description": "SKU unique idenfier number." }, { "name": "externalid", "value": "", "type": "query", "description": "SKU reference unique identifier number in the store." } ] }, "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 an SKU taking i" }, { "info": { "name": "VTex Get List of SKUs", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog-seller-portal/skus/ids", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "from", "value": "", "type": "query", "description": "The first page of the interval of the product list." }, { "name": "to", "value": "", "type": "query", "description": "The last page of the interval of the product list." } ] }, "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 all SKUs.\r\n\r\n##" }, { "info": { "name": "VTex List all SKU IDs", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/sku/stockkeepingunitids", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Number of the page from where you need to retrieve SKU IDs." }, { "name": "pagesize", "value": "", "type": "query", "description": "Size of the page from where you need retrieve SKU IDs. The maximum value is `1000`." } ] }, "docs": "Retrieves the IDs of all SKUs in your store. Presents the results with page size and pagination.\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:" }, { "info": { "name": "VTex Get SKU and context", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/sku/stockkeepingunitbyid/:skuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "SKU's unique identifier number." }, { "name": "sc", "value": "", "type": "query", "description": "Trade policy's unique identifier number." } ] }, "docs": "Retrieves context of an SKU.\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-using-applicati" }, { "info": { "name": "VTex Get SKU by RefId", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog/pvt/stockkeepingunit", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RefId", "value": "", "type": "query", "description": "SKU reference ID." } ] }, "docs": "Retrieves information about a specific SKU by its `RefId`.\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" }, { "info": { "name": "VTex Create SKU", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog/pvt/stockkeepingunit", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new SKU.\r\n\r\nIf there is a need to create a new SKU 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 successfully r" }, { "info": { "name": "VTex Get SKU ID by reference ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/sku/stockkeepingunitidbyrefid/:refId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RefId", "value": "", "type": "path", "description": "SKU reference ID." } ] }, "docs": "Retrieves an SKU ID by the SKU's 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| **Pro" }, { "info": { "name": "VTex Get SKU by alternate ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/sku/stockkeepingunitbyalternateId/:alternateId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "alternateId", "value": "", "type": "path", "description": "Product EAN or `RefId`." } ] }, "docs": "Retrieves an SKU by its alternate ID, which can be the EAN or the 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 resour" }, { "info": { "name": "VTex Get SKU list by product ID", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog_system/pvt/sku/stockkeepingunitByProductId/:productId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "productId", "value": "", "type": "path", "description": "Product's unique numerical identifier." } ] }, "docs": "Retrieves a list with the SKUs related to 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 resources for" }, { "info": { "name": "VTex Retrieve SKU ID list by reference ID list", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/catalog_system/pub/sku/stockkeepingunitidsbyrefids", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Given a list of reference IDs, this endpoint returns a list with the corresponding SKU IDs.\r\n\r\n>⚠️ The list of reference IDs in the request body cannot have repeated reference IDs, or the API will return an error 500.\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--3q6ztrC8YynQf6rdc" }, { "info": { "name": "VTex Get SKU", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/catalog/pvt/stockkeepingunit/:skuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "SKU unique identifier number." } ] }, "docs": "Retrieves a specific SKU by its 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| **Product** | **" }, { "info": { "name": "VTex Update SKU", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/catalog/pvt/stockkeepingunit/:skuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "SKU's unique numerical identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing SKU.\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** | **Category** " } ] } ], "bundled": true }