getCategoryTreeGql

Fetches a category tree.

This method sends a GET request to the getCategoryTreeGql endpoint of the Vue Storefront API Middleware. In turn, it receives data from the GraphQL Api.

Signature

declare function getCategoryTreeGql$1(
	options?: MethodOptions
): Promise<GraphQL.CategoryTreeItem[]>;

Parameters

Name	Required	Type	Description
`options`	Optional	`MethodOptions`

Returns

Returns a response with the category tree data.

Referenced Types

CategoryTreeItem

Examples

Fetching category tree.

import { sdk } from '~/sdk.config.ts';

const categoryTree = await sdk.bigcommerce.getCategoryTreeGql();