Get Catalog Item Variants
GET {{baseUrl}}/api/catalog-items/:item_id/variants/
Get all variants related to the given item ID.
Use filters to return specific fields. Request specific fields sparse fieldsets.
Variants can be sorted by the following fields, in ascending and descending order: created
Returns a maximum of 100 variants per request, which can be paginated with cursor-based pagination.
Rate limits:
Burst: 350/s
Steady: 3500/m
Scopes:
Catalogs Read
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
fields[catalog-variant] | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>ids : any <br>item : equals <br>sku : equals <br>title : contains <br>published : equals | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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-variant","id":"eiusmod laborum","attributes":{"external_id":"elit fugiat sunt incididunt","title":"commodo dolore","description":"dolore nulla sed voluptate aliquip","sku":"dolor","inventory_policy":2,"inventory_quantity":-62588400.02830466,"price":94183906.41854843,"url":"in","image_full_url":"enim sed in dolore dolore","image_thumbnail_url":"esse et","images":["in proident velit","commodo cupidatat aute"],"custom_metadata":{},"published":false,"created":"1947-05-28T06:21:38.724Z","updated":"1955-12-11T07:46:20.718Z"},"links":{"self":"https://oggZkRVtkNAoe.ygH.wTPX0ii"}},{"type":"catalog-variant","id":"non ut","attributes":{"external_id":"quis velit nostrud in ullamco","title":"in laboris reprehenderit ipsum","description":"officia minim","sku":"Ut sit","inventory_policy":1,"inventory_quantity":-87796932.53708735,"price":19034891.14605175,"url":"dolore consequat es","image_full_url":"do consectetu","image_thumbnail_url":"consectetur est","images":["tempor ullamco labore esse officia","cillum ad consequat"],"custom_metadata":{},"published":false,"created":"1999-06-23T06:41:01.172Z","updated":"2020-04-29T12:58:26.439Z"},"links":{"self":"http://dyNdNyWndfSAkgCtunljboZw.tbctfqQxRR8sqVPi+Hru80YJT+SwPhLZMsVg9YswUfK9rJ,4Ap"}}],"links":{"self":"https://mslxXWMpBZYCfJdvXG.jzhmjIMdCbXDwf","first":"http://CnmYCWwOwOtnqKpheolg.ikyUqoSt2pzHkxQm.Uw5+J6qLQrXaWiCSsnLIjdSqdiVzhTV8POxKYyP-z5AczQSAUnLFwKGfyt1CJhJ2eROY307A0","last":"http://haytLvrbqWZYv.grzWPeCYBShPhgHtB3PKVnxZgtiGrcGhOOS+xmC","prev":"http://PxJuCH.qnYFrHQkDrmRBCJz1B","next":"http://osnPVGNVHphfBUeSfvwSPfLYOJGOc.xuhjUirepnrMwdHyW9l5IJsKAWAK6V2ubGGaZjlmm7GALGzplMBUVQx0kgH,6SvvyOW6RUB"}}