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
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":"consectetur commodo","attributes":{"external_id":"reprehenderit mollit adipisicing","title":"in in cupidatat ex","description":"anim irure voluptate","url":"aute velit","image_full_url":"officia sunt mini","image_thumbnail_url":"minim nulla pariatur eu","images":["do enim cu","in est et ut"],"custom_metadata":{},"published":true,"created":"1998-02-19T19:30:28.227Z","updated":"1962-07-02T03:42:00.567Z"},"links":{"self":"https://moKfGAwKCrkfhLWWm.giX.FpTJWTMt6fhyLAJVUGN5dWcayXk.EPfy3St+I.weCE-ETt"},"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":"nulla","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":"in q","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":"dolor dolore","attributes":{"external_id":"exercitation occaecat consequat","title":"dolore ullamco","description":"consequat proident est aliqua","url":"tempor in","image_full_url":"ex mollit laborum","image_thumbnail_url":"commodo","images":["anim m","Ut tempor et"],"custom_metadata":{},"published":true,"created":"1956-01-02T10:43:05.719Z","updated":"1998-02-09T00:31:34.444Z"},"links":{"self":"https://tsVdvZkIqraJsvROAFoYfcOu.yczT+ksTenUX4h2kCRCVNayN8F9ZwbxWQ8ONE1qq0KucbpmcS"},"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":"voluptate enim mollit aute","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":"enim consequat","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://xWybAZQvTTagLTPoxJ.nchiu7oxK6nef+IMkoHQnA","first":"http://oBXTCd.mgjjIhRx0wbI4WmqfZGGm0sfo","last":"http://bHeQsqkJEkjyEPKUpOSq.dwkzwhTqImLlsOmRyjDmL2vKi","prev":"http://VSAfaVLRcpQgwMixtJSAwZMUkKly.rcuyXqtn+nNgzFbh+4S2cVPAO","next":"http://KjUsRYvlKSNPBJEWamtXQ.qbutct+zV8-e-HwYSvvjFpxWDlkHpA83.+phE8pTyv,ovWrM+OFRP9AIYYGYHCeOgPdD"}}