Get products from a collection
Retrieves information about the products from 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 | Read 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.
Path parameters
Collection's unique identifier.
Query parameters
Page number.
Number of the items of the page.
Filter used to refine the collection's products.
Defines if the status of the product is active or not.
Defines if the product is visible on the store or not.
Product's category unique identifier.
Product's brand unique identifier.
Product's supplier unique identifier.
Product's sales channel unique identifier.
Product past release date.
Product future release date.
Product specification field Value. You must also fill in SpecificationFieldId to use this parameter.
Product specification field unique identifier.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK