SKU bindings

Get SKU bindings information

Retrieves SKU bindings administrative information using optional query params sellerId, skuId, sellerSkuId and IsActive to filter results and size to restrict the amount of results.

ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/admin.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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:

Product	Category	Resource
Catalog API	General	View Product

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/sku-binding/pvt/skuseller/admin

Query parameters

sellerIdstring

Example:vtxkfj7352

ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the Sellers management section in the Admin to get the correct ID.

skuIdstring

Example:1

SKU's unique identifier in the marketplace.

sellerSkuIdstring

Example:71

SKU ID in the seller's store.

isActiveboolean

Example:true

Defines if the SKU binding is active.

sizestring

Example:1

Amount of results.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

IsPersistedboolean

Defines if the seller is persisted.

IsRemovedboolean

Defines if the seller is removed.

SkuSellerIdinteger

SKU Binding ID.

UpdateDatestring

Date when the SKU binding was updated for the last time, in UTC format.

RequestedUpdateDatestring nullable

Date when an SKU binding update was requested for the last time, in UTC format.

SellerStockKeepingUnitIdstring

SKU ID in the seller's store.

SellerIdstring

ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the Sellers management section in the Admin to get the correct ID.

StockKeepingUnitIdinteger

SKU ID in the VTEX marketplace.

IsActiveboolean

Defines if the SKU binding is active.

Changes

Changed in 3 of the 51 revisions of this API.292

Jun 23, 20267c0a81967c442See the full diff
- ○
  api tag SKU bindings added
  api-tag-added
- ○
  api tag SKU Bindings removed
  api-tag-removed
Jul 15, 20258c2a6cb1e16c19See the full diff
- ▲
  the response's body type/format changed from object/ to array/ for status 200
  response-body-type-changed
- ●
  removed the optional property IsActive from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property IsPersisted from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property IsRemoved from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property RequestedUpdateDate from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property SellerId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property SellerStockKeepingUnitId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property SkuSellerId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property StockKeepingUnitId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property UpdateDate from the response with the 200 status
  response-optional-property-removed
Jul 15, 2025c14a30d636591See the full diff
- ▲
  the StockKeepingUnitId response's property type/format changed from integer/int32 to integer/ for status 200
  response-property-type-changed

Full history