Product Collection
Storefront Product Collection API endpoints
Query parameters
pageoptionalintegerPage number for pagination
per_pageoptionalintegerEntities per page
ids[]optionalinteger[]Filter by collection IDs
slugs[]optionalstring[]Filter by collection slugs
typeoptionalstringFilter by collection type
sort[field]optionalstringField to sort by
Possible values: id, name.
sort[direction]optionalstringSort direction; defaults to asc.
Possible values: asc, desc.
Defaults to "asc".
Returnsobject
Product collections list response
Error responses
422objectA query parameter fails validation. ids or slugs is not an array or repeats a value; an ids entry is not an integer; a slug is longer than 80 characters; type is not a string or is longer than 50 characters; sort is not an array, sort.field is missing or not id or name, or sort.direction is not asc or desc; page is below 1; per_page is outside 1-500; or expand is not an array.
Path parameters
collection_idRequiredintegerCollection ID
ReturnsProductCollection
Product collection response
Error responses
404objectNo collection with this ID exists, or it belongs to another shop, is not published, or is archived.
422objectexpand is not an array.
Path parameters
collection_idRequiredintegerCollection ID
Query parameters
pageoptionalintegerPage number for pagination
per_pageoptionalintegerEntities per page
expand[]optionalstring[]List of relations to expand (e.g. product, items.variant)
Returnsobject
Collection groups list response
Error responses
404objectNo collection with this ID exists, or it belongs to another shop, is not published, or is archived.
422objectpage is not an integer or is below 1, per_page is not an integer or is outside 1-100, or expand is not an array.