v50

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

Add excluded collection to product assortment

Associates a collection as an excluded collection of the specified product assortment. Excluded collections define the SKUs that must be hidden when the exclusion model is applied to the catalog segmentation.

The same collection cannot be associated twice with the same assortment. In that case, the request will return a status code 409 error.

⚠️ 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.

post/api/catalog/pvt/assortment/{productAssortmentID}/excluded-collections/{collectionID}

Path parameters

productAssortmentIDinteger required
Example:1

Product assortment's unique numerical identifier.

collectionIDinteger required
Example:149

Collection's unique numerical identifier.

Headers

Acceptstring required

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

Response

OK

assortmentIdinteger

Assortment's unique identifier.

collectionIdinteger

Collection's unique identifier associated with the assortment.