Get Catalog Variants
GET {{baseUrl}}/api/catalog-variants/
Get all variants in an account.
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":"mollit","attributes":{"external_id":"qui fugi","title":"enim esse officia ea","description":"laboris Ut sint minim et","sku":"dolore Ut commodo ipsum","inventory_policy":1,"inventory_quantity":66370877.54737866,"price":60726798.09756717,"url":"deserunt non consequat reprehenderit","image_full_url":"velit quis commodo","image_thumbnail_url":"ex anim in minim","images":["elit Excepteur qui","nostrud nulla"],"custom_metadata":{},"published":true,"created":"1990-10-06T03:23:32.780Z","updated":"1992-06-21T11:00:14.228Z"},"links":{"self":"http://regDStsNzrgwnEPsX.ojxP28fj7yUqsbgpkPqS8FgYpJsET+fRwR3lPgIY0Ntl.FMNz0JQCAmsqYxC-y"}},{"type":"catalog-variant","id":"eu ullamco anim laborum","attributes":{"external_id":"officia ipsum adipisicing veniam","title":"officia v","description":"sit sint non fugiat","sku":"proident officia anim","inventory_policy":0,"inventory_quantity":-6277250.72015965,"price":-39236813.28280897,"url":"sint adipisicing nulla ea incididunt","image_full_url":"Ut ad","image_thumbnail_url":"reprehenderit et in incididunt","images":["consectetur culpa exercitation","in enim eiusmod"],"custom_metadata":{},"published":true,"created":"1996-08-07T12:42:16.615Z","updated":"1970-11-24T17:20:57.850Z"},"links":{"self":"http://iOWZpWEltODhD.bulSFU0SU6QrcIIfj-nRyHgdd6EL49-hhIeLVktLqjr.7"}}],"links":{"self":"https://ILeDNvVGkNGBnYHNAGXjlOuN.kedrP.65","first":"http://FlhrJtHXrFwtqiCqToMEA.ooB5L+8MXfSp5BAeKHGm1T0eTmbGPHD1qq+DCtvTyiHODX+gaMMiQ8+VaZ7kljV.61lUuzK","last":"https://esYGDqjdqHnZXoeotKToxJuPvOhHr.bfjsFe8ikpJ6tWMUXZOTCHCUcm+k4NsoSIG18JKpKXaM20K3-Y","prev":"https://lkGDDoKsM.laumKnfal.SDqVECa+lqCfRzAEGadn","next":"http://JWhSZaMx.hmnAKBkn7xRuOcXyWzfdPbYxi8xQDHCru0cO6DWInDHQ6aNmhECbwsh"}}