HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for a deprecated API version. Click here to use the latest version.

Update Catalog Variant

Update a catalog item variant with the given variant ID.

Rate limits:
Burst: 75/s
Steady: 700/m

Scopes:
Catalogs Write

Path Params
string
required
Defaults to $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM

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.

Body Params
object
required
string
required
string
required
Defaults to $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM

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.

object
required
string
Defaults to Ocean Blue Shirt (Sample) Variant Medium

The title of the catalog item variant.

string
Defaults to Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.

A description of the catalog item variant.

integer
Defaults to 2

This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:
1: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.
0 or 2: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.

number
Defaults to 25

The quantity of the catalog item variant currently in stock.

number
Defaults to 42

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.

string
Defaults to https://via.placeholder.com/150

URL pointing to the location of the catalog item variant on your website.

string
Defaults to https://via.placeholder.com/300

URL pointing to the location of a full image of the catalog item variant.

string
Defaults to https://via.placeholder.com/150

URL pointing to the location of an image thumbnail of the catalog item variant.

array of strings
Defaults to https://via.placeholder.com/150

List of URLs pointing to the locations of images of the catalog item variant.

images
object

Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.

string
boolean
Defaults to true

Boolean value indicating whether the catalog item variant is published.

Headers
string
required
Defaults to 2023-01-24

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials