HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Update Catalog Item

Update a catalog item with the given item ID.

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

Scopes:
catalogs:write

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

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.

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

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.

object
required
string
Defaults to Ocean Blue Shirt (Sample)

The title of the catalog item.

number
Defaults to 42

This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the price on any child variants, using the Update Catalog Variant Endpoint.

string
Defaults to A description of the catalog item.

A description of the catalog item.

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

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

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

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

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

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

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

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

images
object

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

string
boolean
Defaults to true

Boolean value indicating whether the catalog item is published.

object
object
array of objects
required
data*
string
required
string
required
Defaults to $custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL

A list of catalog category IDs representing the categories the item is in

Headers
string
required
Defaults to 2024-02-15

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

Responses

Language
Credentials