Skip to content
Guides
CatalogCollections
catalog:read

List collection products

Returns a paginated product summary for a collection. Use this endpoint to render collection products instead of loading raw product IDs from the collection detail.

GET/v1/catalog/collections/{collectionId}/products

Returns a paginated product summary for a collection. Use this endpoint to render collection products instead of loading raw product IDs from the collection detail.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Path Parameters

collectionId*string

Identifier of the collection.

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/collections/7204558912004325301/products" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "name": "Example resource",      "slug": "example-resource",      "sku": "SKU-001",      "price": 1,      "compareAtPrice": 1,      "currency": "PEN",      "imageUrl": "https://example.com/resource",      "status": "draft",      "sortOrder": 1,      "isPinned": false    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}