List Collections

GET/store/:storeCode/collections
publishable key

Retrieve a paginated list of collections.

Path Parameters
storeCoderequiredstring

Store slug in the URL (first argument to every SDK store method).

Query Parameters
limitnumber

Maximum number of items to return.

offsetnumber

Number of items to skip before collecting the result set.

orderstring

Field to sort by. Prefix with `-` for descending order (e.g. `-created_at`).

fieldsstring

Comma-separated fields to include. Prefix with `*` to expand a relation (e.g. `id,*variants`).

qstring

Search query.

titlestring

Filter by title.

handlestring

Filter by handle.

Response

Status

200OK

Schema

Copy
HttpTypes.StoreCollectionListResponse

Properties

collectionsrequiredStoreCollection[]

List of collections.

countrequirednumber

Total count.

offsetrequirednumber

Offset applied.

limitrequirednumber

Limit applied.