CategoryTree

Get hierarchical category tree structure

Returns categories as a nested tree. Pass parentId to scope results to children of that category. Public endpoint.

get/category-trees

Request

Base URL
http://localhost:8000/api/shop
Auth
HTTP bearer
TypeScript
https://skmtc.dev/bagisto/apis/bagisto-shop-api/docs/category-trees/get.ts
A function with typed inputs. Its response is checked against the schema.

parentIdinteger

Example:1

Return children of this category ID. Omit to return root categories.

depthinteger

Example:4

Maximum nesting depth (default: 4).

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring

Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring

Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring

Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Nested category tree.

No recorded changes to this operation across all 13 revisions of this API.