v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB

Subcollection

Reposition SKU on the subcollection

⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portal.

Edits the position of an SKU that already exists in the subcollection, which is a Group within a collection.

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	Collection	Write Collections

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.

post/api/catalog/pvt/collection/{collectionId}/position

Path parameters

collectionIdinteger required

Example:151

Collection's unique numerical identifier.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

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

Request body

skuIdinteger required

SKU ID.

positioninteger required

SKU position.

subCollectionIdinteger required

Subcollection ID.

Example request

{
  "skuId": 1,
  "position": 1,
  "subCollectionId": 17
}

v50