GET/v3/live/vendorgraphics/product-catalog/categories

Fetch product categories

Returns product categories with cursor-based pagination, sorted deterministically by category ID. Maximum of 250 categories per page.

Version
v3Open on v2
Rate limit
Tier 3 · 10–200 rps by plan
Billing
Company Vendorgraphics or Person Vendorgraphics · Fetch product categories

Query parameters

  • cursorstringOptional
    Cursor for pagination. Use the cursor value from the previous response to get more results.
  • limitinteger (int32)Optional
    Maximum number of results to return (default: 100, max: 250)
Headers
x-api-key Required · API key for authentication

Response

  • categoriesobject[]
    List of product categories
    • categoryHierarchyobject[]
      Category hierarchy from the top-level category down to this one, which is always the last entry
    • descriptionstring
      Category description
    • idstring
      AggKnowledge category ID
    • namestring
      Category name
  • cursorstring
    Cursor for pagination. Use this value as the cursor parameter in the next request to get more results.

Status codes