Catalog
Discover stable codes, localized labels, prices, and photo requirements.
List brands
Returns brands, optionally filtered by category or a search term.
name_locale uses the requested locale and falls back to name when a
translation is unavailable.
query Parameters
localeLocale for *_locale fields. English is always returned separately in
the corresponding non-suffixed field. Missing translations fall back
to English.
pageOne-based catalog result page.
limitCatalog results per page. Maximum 100.
searchOptional brand search term.
category_codeStable category code returned by the categories endpoint.
Catalog code returned by the API. Use it unchanged.
List brands › Responses
A page of matching brands.
pagelimittotalTotal matching brands before pagination.
List categories
Returns supported categories, optionally restricted to a brand. The key
needs either orders:read or orders:write. The response is not
paginated. An unknown brand_code returns 404.
query Parameters
localeLocale for *_locale fields. English is always returned separately in
the corresponding non-suffixed field. Missing translations fall back
to English.
brand_codeRestrict categories to a brand returned by the brands endpoint.
Catalog code returned by the API. Use it unchanged.
List categories › Responses
Supported categories.
List answer times
Returns the answer-time options currently available to the authenticated
account for one brand/category combination. The key needs either
orders:read or orders:write.
code is the integer duration in minutes and is the value accepted by
POST /v1/integrations/orders as answer_time. Availability and price
are account- and catalog-context-specific; refresh them before order
creation.
query Parameters
brand_codeStable brand code returned by the brands endpoint.
Catalog code returned by the API. Use it unchanged.
category_codeStable category code returned by the categories endpoint.
Catalog code returned by the API. Use it unchanged.
localeLocale for *_locale fields. English is always returned separately in
the corresponding non-suffixed field. Missing translations fall back
to English.
List answer times › Responses
Answer-time options for the selected context.
List photo indexes
Returns the photo indexes applicable to a category and, optionally, a
brand and model. Providing more supported context produces more precise
indexes and example images for the item. brand_code is required when
model_code is supplied.
Use each index's code as photos[].index_code; submit every index
marked required and no more than photo_limit images for one index.
query Parameters
category_codeStable category code returned by the categories endpoint.
Catalog code returned by the API. Use it unchanged.
localeLocale for *_locale fields. English is always returned separately in
the corresponding non-suffixed field. Missing translations fall back
to English.
brand_codeOptional brand code used to refine the photo guidance.
Catalog code returned by the API. Use it unchanged.
model_codeOptional model code used to refine the photo guidance. Requires
brand_code and must belong to the submitted brand/category.
Catalog code returned by the API. Use it unchanged.
List photo indexes › Responses
Photo indexes for the selected context.
List models
Returns models for a brand and category, with optional search and pagination.
query Parameters
brand_codeStable brand code returned by the brands endpoint.
Catalog code returned by the API. Use it unchanged.
category_codeStable category code returned by the categories endpoint.
Catalog code returned by the API. Use it unchanged.
localeLocale for *_locale fields. English is always returned separately in
the corresponding non-suffixed field. Missing translations fall back
to English.
pageOne-based catalog result page.
limitCatalog results per page. Maximum 100.
searchOptional model search term.
List models › Responses
A page of models.
pagelimittotalTotal matching models before pagination.