Get all product assortments
Retrieves the list of product assortments registered at the merchant level.
Assortments are used to segment the catalog for specific business contexts (for example, B2B contracts or Organization Units) based on the inclusion and exclusion of collection IDs:
- Inclusion model: All products are restricted by default, and only SKUs that belong to the included collections are visible.
- Exclusion model: All products are available by default, and SKUs that belong to the excluded collections are hidden.
The list returned contains both the included and excluded collections associated with an assortment.
⚠️ 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:
| Product | Category | Resource |
|---|---|---|
| Catalog | Content | Product 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.
Query parameters
Assortment name.
Cursor indicating the assortment ID after which the next page of results must start. Useful for cursor-based pagination.
Maximum number of assortments returned in the response when using cursor-based pagination.
Filters the result to return only assortments that reference the specified collection ID, either as an included or as an excluded collection.
Headers
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK