Get Catalog Category Items
GET {{baseUrl}}/api/catalog-categories/:id/items/
Get all items in a category with the given category ID.
Items can be sorted by the following fields, in ascending and descending order:
created
Include parameters can be provided to get the following related resource data: variants
Returns a maximum of 100 items per request.
Rate limits:
Burst: 350/s
Steady: 3500/m
Scopes:
catalogs:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[catalog-item] | string | For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets | |
fields[catalog-variant] | string | For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>ids: any<br>category.id: equals<br>title: contains<br>published: equals | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#relationships | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#pagination | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2023-07-15/reference/api-overview#sorting |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"catalog-item","id":"\u003cstring\u003e","attributes":{"external_id":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","price":"\u003cnumber\u003e","url":"\u003cstring\u003e","image_full_url":"\u003cstring\u003e","image_thumbnail_url":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"custom_metadata":{},"published":"\u003cboolean\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"variants":{"data":[{"type":"catalog-variant","id":"\u003cstring\u003e"},{"type":"catalog-variant","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"catalog-item","id":"\u003cstring\u003e","attributes":{"external_id":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","price":"\u003cnumber\u003e","url":"\u003cstring\u003e","image_full_url":"\u003cstring\u003e","image_thumbnail_url":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"custom_metadata":{},"published":"\u003cboolean\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"variants":{"data":[{"type":"catalog-variant","id":"\u003cstring\u003e"},{"type":"catalog-variant","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"},"included":[{"type":"catalog-variant","id":"\u003cstring\u003e","attributes":{"external_id":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","sku":"\u003cstring\u003e","inventory_policy":0,"inventory_quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","url":"\u003cstring\u003e","image_full_url":"\u003cstring\u003e","image_thumbnail_url":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"custom_metadata":{},"published":"\u003cboolean\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"}},{"type":"catalog-variant","id":"\u003cstring\u003e","attributes":{"external_id":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","sku":"\u003cstring\u003e","inventory_policy":2,"inventory_quantity":"\u003cnumber\u003e","price":"\u003cnumber\u003e","url":"\u003cstring\u003e","image_full_url":"\u003cstring\u003e","image_thumbnail_url":"\u003cstring\u003e","images":["\u003cstring\u003e","\u003cstring\u003e"],"custom_metadata":{},"published":"\u003cboolean\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"}}]}