Sign in

v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Get Categories

get/sites/multiscreen/{site_name}/ecommerce/categories

Path parameters

site_namestring required

The unique identifier for the target Site.

Query parameters

limitinteger

The number of results returned.

offsetinteger

How many categories to skip to get the next limit/resutlts.

sortstring

Sort the results by this field. Only works for title today.

directionstring

[asc,desc] Order direction for the property specified in sort.

searchstring

Search by category name containing given string exactly and ignore-case

product_idstring

Product id to filter by

parent_idstring

Id of parent to filter subcategories. Send 'ROOT' to filter root categories

Response

200

limitinteger
offsetinteger
site_namestring
total_responsesinteger

Example response

{
  "limit": 20,
  "results": [
    {
      "id": "a1xcgrXw",
      "parent_id": "ROOT",
      "products_count": 6,
      "title": "Dining room"
    }
  ],
  "site_name": "1ed21e7e",
  "total_responses": 6
}