HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Get Catalog Category

Get a catalog category with the given category ID.

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

Scopes:
catalogs:read

Path Params
string
required
Defaults to $custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL

The catalog category 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-category]
Headers
string
required
Defaults to 2024-06-15

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

Responses

Language
Credentials