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
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
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":"est","attributes":{"external_id":"deserunt","title":"commodo nulla tempor mollit nisi","description":"consequat deserunt","url":"sunt","image_full_url":"velit dolore enim","image_thumbnail_url":"cillum non Excepteur elit","images":["ipsum qui deserunt velit","do et sunt "],"custom_metadata":{},"published":true,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"https://cBpXcPmRcKgOseqchiTRiq.fwvsH9CMeejZs4-VaaLJVVdleIS"},"relationships":{"variants":{"data":[{"type":"catalog-variant","id":"sint mollit c"},{"type":"catalog-variant","id":""}]}}},{"type":"catalog-item","id":"sit anim non dolore i","attributes":{"external_id":"enim pariatur","title":"proident","description":"est sed Duis nisi","url":"do anim","image_full_url":"adipisicing cillum cupidatat incididunt","image_thumbnail_url":"sunt","images":["qui l","reprehenderit sit"],"custom_metadata":{},"published":false,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"http://CXJCDoJitUu.earRGNKaTxVqVolZs9XvAPKyG4k2arQP5fEHxJpt06i1-LVv.bz9WKUPiP"},"relationships":{"variants":{"data":[{"type":"catalog-variant","id":"commodo mollit esse Duis"},{"type":"catalog-variant","id":"cupidatat est dolore"}]}}}],"links":{"self":"http://XeFK.tgdjdQkeLYL+05aqj","first":"http://mhyayERXWkgPtzCBxr.kavvgDJkf2ghhl6JzkjyRZLDc.h6LyrYlx","last":"http://TmGQWobFWmHuqScTE.qknSJPmbbnRRmiAltuaUMXJBmXqyT0tN","prev":"https://nAcTqINWjnprfMVfFlFhCM.ebtaE4ETXyOfK9GIoEyOgnGygd1YG6zGlG.L.xQkrW","next":"https://SAPBqUrqbCIe.xsrKsirlFf5Bph"},"included":[{"type":"catalog-variant","id":"aute enim sit elit culpa","attributes":{"external_id":"in veniam deserunt","title":"reprehenderit veniam ipsum","description":"Lorem occaecat id","sku":"consequat in dolore cillum","inventory_policy":1,"inventory_quantity":55802179.09330064,"price":35607520.33931714,"url":"proident sed enim in","image_full_url":"officia","image_thumbnail_url":"Ut culpa ipsum","images":["ex do","deserunt id in enim"],"custom_metadata":{},"published":false,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"https://BDHhNPgUOvknokkwgdAdIkGmIr.yooeEDIj8ooABg-hukofkvd+DOlGP0WpMDJlQzpg+KI9aRvRrM5jXZ7FDRLfk0DSp81"}},{"type":"catalog-variant","id":"mollit in elit pariatur","attributes":{"external_id":"nostrud occaecat commodo dolor","title":"et consequat dolor","description":"ex sunt","sku":"ut occaecat","inventory_policy":2,"inventory_quantity":-15348595.610487431,"price":88655010.60954526,"url":"pariatur in enim nisi ipsum","image_full_url":"ea dolore et culpa consequat","image_thumbnail_url":"sint dolor","images":["deserunt dolor","ea officia sunt aliquip ad"],"custom_metadata":{},"published":true,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"http://nHQqgtGFuIopbo.vlivLOSPV6w03tvznCleIk+-UjxuJ1jX5MrUHEl4mrxy8y+MrgBhZuqxdQPfDvxOD"}}]}