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

Create Catalog Item

Create a new catalog item.

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

Scopes:
Catalogs Write

Body Params
object
required
string
required
object
required
string
required
Defaults to SAMPLE-DATA-ITEM-1

The ID of the catalog item in an external system.

string

The integration type. Currently only "$custom" is supported.

string
required
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 $default

The type of catalog. Currently only "$default" is supported.

string
required
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.

string
required
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
Headers
string
required
Defaults to 2023-01-24

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

Responses

Language
Credentials