Get Catalog Items
GET {{baseUrl}}/api/catalog-items/
Get all catalog items in an account.
Catalog 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":"exercitation occaecat","attributes":{"external_id":"amet","title":"laborum velit","description":"Excepteur proident consectetur","url":"laborum Duis officia anim","image_full_url":"exercitation n","image_thumbnail_url":"cupidatat proident mollit","images":["ipsum aliqua cupidatat","nulla aute et consequat"],"custom_metadata":{},"published":false,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"http://mtGtzLqpUKELpYyyleZRMvwULPJIX.qvQiCyxnhNc8oRMICV5WOPR9JlkR7Ec+uWG7MzBjwB7RAFVcFVSo"},"relationships":{"variants":{"data":[{"type":"catalog-variant","id":"nulla voluptate ipsum consectetur"},{"type":"catalog-variant","id":"ullamco sint"}]}}},{"type":"catalog-item","id":"nulla cupidatat laborum incidid","attributes":{"external_id":"tempor dolor dol","title":"quis","description":"dolore tempor pariatur voluptate","url":"laborum est minim culpa ullamco","image_full_url":"tempor ea","image_thumbnail_url":"elit anim sit","images":["consectetur","eiusmod nisi"],"custom_metadata":{},"published":false,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"https://aXmXKZEjOSxFFOpJiLVZGNtH.gajib.134u02QRuhYeB6KihIzWHAYQtXgCn2XhVT"},"relationships":{"variants":{"data":[{"type":"catalog-variant","id":"eu laborum nostrud"},{"type":"catalog-variant","id":"ad pariatur proident nostrud laborum"}]}}}],"links":{"self":"http://ZyqXTICXIRNTKLqxhAWLYVLvz.juqdne,St1WOB3wZft,MkVtNnEsI3B+TNwPWMUfJtxQNRll3gref,XUiZQQQ","first":"https://UgFGqmOmKGjamQz.rrksyP3sYWGWLst0n94meav9SO+GmL1r8lbioQDVOj6ssh3","last":"http://OKCQad.frHSlCYzn7fDesqecG8Cy6J9A,VGu","prev":"http://ZQP.onvgAqfXL","next":"http://VahMCize.zhlxbmZxq90-mol8h3nCUdW2NdIRBP,ZxaKqTA0UNzfaGuTAdmPwcC+Qkw1tTXc-c"},"included":[{"type":"catalog-variant","id":"a","attributes":{"external_id":"sint","title":"Ut aute in consequat","description":"et ad commodo","sku":"nostrud aute e","inventory_policy":1,"inventory_quantity":73290639.55891973,"price":91248503.48186463,"url":"do in fugiat","image_full_url":"et fugiat","image_thumbnail_url":"esse id officia","images":["pariat","eiusmod"],"custom_metadata":{},"published":true,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"https://AMELza.izmdV2oVJBnEWrs48Vb8"}},{"type":"catalog-variant","id":"cillum","attributes":{"external_id":"culpa in","title":"qui eu","description":"non","sku":"voluptate qui laboris ut","inventory_policy":1,"inventory_quantity":15187147.477028742,"price":45096929.327282965,"url":"esse ex sunt Ut","image_full_url":"","image_thumbnail_url":"aute ","images":["tempor dolor magna velit","occaecat"],"custom_metadata":{},"published":false,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"https://eTZHhVzzJNjuYyorWCjLxPJSIIHmLypX.pphz5SsTVsXmCDWUrC5lLz11kXD3fCUkFuwhYRoC3L2Mtzb-v"}}]}