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

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

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

The title of the catalog item.

number

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

A description of the catalog item.

string

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

string

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

string

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

array of strings

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

Boolean value indicating whether the catalog item is published.

object
object
array of objects
data
string
required
string
required

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

Headers
string
required
Defaults to 2025-01-15

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

Responses

Language
Credentials