{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PostCatalogVariantResponse",
"title": "PostCatalogVariantResponse",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
},
"id": {
"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`.",
"type": "string",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
},
"attributes": {
"type": "object",
"properties": {
"external_id": {
"description": "The ID of the catalog item variant in an external system.",
"type": "string",
"example": "SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"nullable": true
},
"title": {
"description": "The title of the catalog item variant.",
"type": "string",
"example": "Ocean Blue Shirt (Sample) Variant Medium",
"nullable": true
},
"description": {
"description": "A description of the catalog item variant.",
"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.",
"nullable": true
},
"sku": {
"description": "The SKU of the catalog item variant.",
"type": "string",
"example": "OBS-MD",
"nullable": true
},
"inventory_policy": {
"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.",
"type": "integer",
"example": 2,
"enum": [
0,
1,
2
],
"nullable": true
},
"inventory_quantity": {
"description": "The quantity of the catalog item variant currently in stock.",
"type": "number",
"example": 25,
"nullable": true
},
"price": {
"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).",
"type": "number",
"example": 42,
"nullable": true
},
"url": {
"description": "URL pointing to the location of the catalog item variant on your website.",
"type": "string",
"example": "https://via.placeholder.com/150",
"nullable": true
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item variant.",
"type": "string",
"example": "https://via.placeholder.com/300",
"nullable": true
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
"type": "string",
"example": "https://via.placeholder.com/150",
"nullable": true
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item variant.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"https://via.placeholder.com/150"
],
"nullable": true
},
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
"type": "object",
"example": {
"Top Pick": true
},
"nullable": true
},
"published": {
"description": "Boolean value indicating whether the catalog item variant is published.",
"type": "boolean",
"example": true,
"nullable": true
},
"created": {
"description": "Date and time when the catalog item variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
},
"updated": {
"description": "Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00",
"nullable": true
}
}
},
"relationships": {
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
},
"id": {
"type": "string"
}
},
"required": [
"type",
"id"
]
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
]
}