Catalogue

Category tree, for filtering searches

Live

GET https://shopitup.ca/api/v1/categories

The departments and categories that have items for sale, most items first, each with how many. A category's path is exactly what the search's category filter takes.

Access: catalog:read How to get a token
Returns: Departments and their categories

Request

curl "https://shopitup.ca/api/v1/categories" \
  -H "Authorization: Bearer $TOKEN"

const response = await fetch("https://shopitup.ca/api/v1/categories", {
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

import requests

response = requests.get(
    "https://shopitup.ca/api/v1/categories",
    headers={"Authorization": f"Bearer {token}"},
)

data = response.json()

Response

200 · Departments and their categories

{
  "data": [
    {
      "name": "Women",
      "path": "Women",
      "count": 4270,
      "children": [
        {
          "name": "Shoes",
          "path": "Women > Shoes",
          "count": 296,
          "children": [
            {
              "name": "Boots",
              "path": "Women > Shoes > Boots",
              "count": 64,
              "children": []
            }
          ]
        }
      ]
    }
  ]
}

401 · Missing, invalid or expired access token

{
  "error": {
    "code": "unauthorized",
    "message": "The access token is missing, invalid or expired."
  }
}

403 · The token does not carry the scope this endpoint needs

{
  "error": {
    "code": "insufficient_scope",
    "message": "This request needs a token with the catalog:read scope."
  }
}

429 · Too many requests; retry after the number of seconds in `Retry-After`

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Try again in 30 seconds."
  }
}

503 · A service the API depends on is briefly unavailable; retry after the number of seconds in `Retry-After`

{
  "error": {
    "code": "unavailable",
    "message": "A service the API depends on is briefly unavailable. Try again in a few seconds."
  }
}

Response

200 Departments and their categories

data array of Category Required
4 child attributes
- name string
- path string
  
  The value the search's category filter takes
- count integer
  
  Items for sale in this category and everything below it
- children array of Category
  
  Each entry has the same fields as this Category.

Status codes

200

Departments and their categories

401

Missing, invalid or expired access token

403

The token does not carry the scope this endpoint needs

429

Too many requests; retry after the number of seconds in Retry-After

503

A service the API depends on is briefly unavailable; retry after the number of seconds in Retry-After

Errors share one shape — see Errors and rate limits.