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

Get Catalog Variant

Get a catalog item variant with the given variant ID.

Rate limits:
Burst: 350/s
Steady: 3500/m

Scopes:
catalogs:read

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.

Query Params
array of strings
fields[catalog-variant]
Headers
string
required
Defaults to 2023-09-15

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

Responses

Language
Credentials