Klaviyo API

Getting access, Developing, Testing

Back to Klaviyo

Get Catalog Item Variants

Get all variants related to the given item ID.\nVariants can be sorted by the following fields, in ascending and descending order: created\nReturns a maximum of 100 variants per request.

Rate limits:
Burst: 350/s
Steady: 3500/m\n\nScopes:\nCatalogs Read

Input

type: object properties: parameters: type: object properties: item_id: type: string example: $custom:::$default:::SAMPLE-DATA-ITEM-1 description: >- The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. fields[catalog-variant]: type: array items: type: string enum: - external_id - title - description - sku - inventory_policy - inventory_quantity - price - url - image_full_url - image_thumbnail_url - images - custom_metadata - published - created - updated description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets filter: type: string description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/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]: type: string description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination sort: type: string enum: - created - '-created' description: >- For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sorting revision: type: string default: '2023-02-22' description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])' required: - item_id - revision title: Parameters

Output

type: object required: - data - links properties: data: type: array items: type: object required: - type - id - attributes - links properties: type: type: string enum: - catalog-variant id: type: string example: $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM description: >- The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`. attributes: type: object properties: external_id: type: string example: SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM description: The ID of the catalog item variant in an external system. title: type: string example: Ocean Blue Shirt (Sample) Variant Medium description: The title of the catalog item variant. description: type: string example: >- Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns. description: A description of the catalog item variant. sku: type: string example: OBS-MD description: The SKU of the catalog item variant. inventory_policy: type: integer enum: - 0 - 1 - 2 description: >- This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.\n example: 2 inventory_quantity: type: number example: 25 description: The quantity of the catalog item variant currently in stock. price: type: number example: 42 description: >- This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item). url: type: string example: https://via.placeholder.com/150 description: >- URL pointing to the location of the catalog item variant on your website. image_full_url: type: string example: https://via.placeholder.com/300 description: >- URL pointing to the location of a full image of the catalog item variant. image_thumbnail_url: type: string example: https://via.placeholder.com/150 description: >- URL pointing to the location of an image thumbnail of the catalog item variant. images: type: array example: - https://via.placeholder.com/150 description: >- List of URLs pointing to the locations of images of the catalog item variant. items: type: string custom_metadata: type: object example: Top Pick: true description: >- Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb. published: type: boolean example: true description: >- Boolean value indicating whether the catalog item variant is published. created: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time when the catalog item variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). updated: type: string format: date-time example: '2022-11-08T00:00:00' description: >- Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). links: type: object required: - self properties: self: type: string format: uri links: type: object required: - self properties: self: type: string format: uri first: type: string format: uri last: type: string format: uri prev: type: string format: uri next: type: string format: uri