Skip to content
Guides
ES
API reference
stablecatalog: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

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"

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/string/products"
{  "data": [    {      "id": "string",      "name": "string",      "slug": "string",      "sku": null,      "price": 0.1,      "compareAtPrice": null,      "currency": "string",      "imageUrl": null,      "status": "draft",      "sortOrder": 0,      "isPinned": true    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}