categories

Requires permission categories:category:list.

Lists the categories of your organization with their subcategories and product counts. Narrow the list by search text, parent, status or level. Requires permission to list categories.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Categories {
  categories {
    id
    code
    name
    createdAt
    childrenCount
    deletedAt
    children {
      id
      code
      name
      createdAt
      childrenCount
      deletedAt
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Categories {\n  categories {\n    id\n    code\n    name\n    createdAt\n    childrenCount\n    deletedAt\n    children {\n      id\n      code\n      name\n      createdAt\n      childrenCount\n      deletedAt\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "categories": [
      {
        "id": "id",
        "code": "string",
        "name": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "childrenCount": 0,
        "deletedAt": "2025-01-15T00:00:00Z",
        "children": [
          {
            "id": "id",
            "code": "string",
            "name": "string",
            "createdAt": "2025-01-15T00:00:00Z",
            "childrenCount": 0,
            "deletedAt": "2025-01-15T00:00:00Z"
          }
        ]
      }
    ]
  }
}

categories(
  filters: CategoryFiltersInput
): [Category!]!

Arguments

categories.filters ● CategoryFiltersInput input

Optional filters: search text, parent category, active status, level, or root categories only.

Type

Category object

A node in the category tree. A root category is an ordinary category.