Get Catalog Category Items
GET {{baseUrl}}/api/catalog-categories/:category_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
Use filters to return specific fields and any variants. Request specific fields using sparse fieldsets.
Include parameters can be provided to get the following related resource data: variants
Returns a maximum of 100 items per request, which can be paginated with cursor-based pagination.
Rate limits:
Burst: 350/s
Steady: 3500/m
Scopes:
Catalogs Read
Request Params
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":"in","attributes":{"external_id":"sunt dolore Duis","title":"occaecat Ut","description":"dolor velit ea Lorem","url":"consectetur reprehenderit ni","image_full_url":"nisi labore","image_thumbnail_url":"sit sunt ex nis","images":["sint","Excepteur ea"],"custom_metadata":{},"published":true,"created":"1976-04-20T19:58:05.489Z","updated":"1997-09-30T12:12:18.268Z"},"links":{"self":"http://qUKjZdKBZAClTwRhCEwEyFAixWmtJ.stjczP7T8aiMGVxCR6AkKh20Xig-Of-mIhFDY3MBSlUVviEb111g.jU3"},"relationships":{"variants":{"data":[{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}},"included":[{"type":"catalog-variant","id":"ullamco incididunt","attributes":{"external_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"title":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sku":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inventory_policy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inventory_quantity":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"price":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image_full_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image_thumbnail_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"images":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"custom_metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"published":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"links":{"self":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"type":"catalog-variant","id":"Duis dolor dolore esse","attributes":{"external_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"title":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sku":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inventory_policy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inventory_quantity":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"price":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image_full_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image_thumbnail_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"images":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"custom_metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"published":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"links":{"self":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}]},{"type":"catalog-item","id":"id repreh","attributes":{"external_id":"ut id","title":"Ut irure","description":"adipisicing consequat deserunt laborum","url":"quis Ut","image_full_url":"do Ut cupidatat dolore","image_thumbnail_url":"qui","images":["et cupidatat deserunt dolore","in"],"custom_metadata":{},"published":true,"created":"2012-11-25T17:05:48.051Z","updated":"1994-03-26T04:59:28.383Z"},"links":{"self":"https://NZWWAOctmEVpV.gjocIuoLJnoNAgWNfiJM,PQ4cttX.LrwyD3IA,v5JTZBWPvYMi6-dks"},"relationships":{"variants":{"data":[{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}},"included":[{"type":"catalog-variant","id":"nisi velit reprehenderit dolore dolor","attributes":{"external_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"title":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sku":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inventory_policy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inventory_quantity":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"price":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image_full_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image_thumbnail_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"images":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"custom_metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"published":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"links":{"self":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"type":"catalog-variant","id":"laborum elit","attributes":{"external_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"title":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"sku":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inventory_policy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inventory_quantity":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"price":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image_full_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"image_thumbnail_url":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"images":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"custom_metadata":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"published":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"links":{"self":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}]}],"links":{"self":"http://oUFX.tqkdjPiqz-Und+9zFLSqYYkJCaZ4+uVxldhbvhWzTci41.K8A9TqNdm8sGWhIG8iNnfyZ64","first":"http://YcijF.xmspM5f88YfD4lj,OVO1Z5u7g5Qlu0EJLh","last":"https://kIqQ.dlbORo4HloXgNJ","prev":"https://VGPNjxz.znwViRlkVSEUb90RE.wG.wj2bN2tZSeIPJgqTmlW5J-","next":"http://asp.nfiCWyZethBOekdu+Wzkez67+H+k1riwKkIxxM"}}