SKU Bindings API
The SKU Bindings API enables sellers to manage their SKUs offered across different VTEX marketplaces.
It allows sellers to send new suggestions to marketplaces, update SKU prices or inventory, and perform other operations, promoting accurate and flexible catalog management.
Common parameters
| Parameter name | Description | Type |
|---|---|---|
{{accountName}} |
Name of the VTEX account. Used as part of the URL. | Server variable. |
{{environment}} |
Environment to use. Used as part of the URL. The default value is vtexcommercestable. |
Server variable. |
X-VTEX-API-AppKey |
Unique identifier of the API key. | Authentication header. Must be used together with X-VTEX-API-AppToken. Not necessary when using VtexIdclientAutCookie. |
X-VTEX-API-AppToken |
Secret token of the API key. | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using VtexIdclientAutCookie. |
VtexIdclientAutCookie |
User token, valid for 24 hours. | Authentication header. Not necessary when using X-VTEX-API-AppKey and X-VTEX-API-AppToken. |
Endpoints
SKU Bindings
| Summary | Method | Path |
|---|---|---|
| Get SKU bindings by SKU ID | GET | /sku-binding/pvt/skusellers/{skuId} |
| Get SKU bindings information | GET | /sku-binding/pvt/skuseller/admin |
| Get details of a seller's SKU | GET | /sku-binding/pvt/skuseller/{sellerId}/{sellerSkuId} |
| Bind a seller's SKU to another SKU | PUT | /sku-binding/pvt/skuseller/{sellerId}/{sellerSkuId} |
| Get all SKU bindings by seller ID | GET | /sku-binding/pvt/skuseller/list/bysellerId/{sellerId} |
| Get paged SKU bindings by seller ID | GET | /sku-binding/pvt/skuseller/paged/sellerid/{sellerId} |
| Change notification with SKU ID | POST | /sku-binding/pvt/skuseller/changenotification/{skuId} |
| Change notification with seller ID and seller SKU ID | POST | /sku-binding/pvt/skuseller/changenotification/{sellerId}/{sellerSkuId} |
| Insert SKU binding | POST | /sku-binding/pvt/skuseller/insertion |
| Activate SKU binding | POST | /sku-binding/pvt/skuseller/activate/{sellerId}/{skuSellerId} |
| Deactivate SKU binding | POST | /sku-binding/pvt/skuseller/inactivate/{sellerId}/{skuSellerId} |
| Remove a seller's SKU binding | POST | /sku-binding/pvt/skuseller/remove/{sellerId}/{sellerSkuId} |