GET /v1/commerce/categories

GET/v1/commerce/categories

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

limitinteger<int32>

min 1 · max 100 · default: 20

offsetinteger<int32>

min 0 · default: 0

Responses

200OK

itemsCategoryNode[] | nullrequired

Show properties

Array of CategoryNode

childrenCategoryNode[] | null

Show properties

Array of CategoryNode

Circular reference to CategoryNode.

idstringrequired

namestringrequired

slugstringrequired

sort_orderinteger<int32>required

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/categories"

const response = await fetch("/v1/commerce/categories", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/categories",
)

Response

{
  "items": [
    {
      "children": [
        null
      ],
      "id": "string",
      "name": "string",
      "slug": "string",
      "sort_order": 0
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}