v50

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

Update product assortment

Updates the name of an existing product assortment given its unique identifier. The new name must be unique across the merchant's assortments.

⚠️ This feature is only available for stores using the B2B Buyer Portal, which is currently available to select accounts.

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:

ProductCategoryResource
CatalogContentProduct and SKU Management

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.

put/api/catalog/pvt/assortment/{productAssortmentID}

Path parameters

productAssortmentIDinteger required
Example:1

Product assortment'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

namestring required

Assortment's new unique name. Must not collide with existing assortments at the merchant level.

Response

OK

Idinteger

Assortment's unique numerical identifier.

Namestring

Assortment's unique name.

CreatedAtstring date-time

Date and time when the assortment was created, in UTC format.

UpdatedAtstring date-time

Date and time when the assortment was last updated, in UTC format.

IncludedCollectionsinteger[]

List of collection IDs explicitly allowed by the assortment.

ExcludedCollectionsinteger[]

List of collection IDs explicitly restricted by the assortment.