Appearance
getStoreNavigation ​
Definition ​
Get a list of categories by provided search criteria.
Signature ​
ts
export async function getStoreNavigation(
{
requestActiveId,
requestRootId,
depth,
buildTree,
searchCriteria,
}: GetStoreNavigationParams,
contextInstance: ShopwareApiInstance = defaultInstance,
): Promise<StoreNavigationElement[]>
Parameters ​
| Name | Type | Description |
|---|---|---|
| { requestActiveId, requestRootId, depth, buildTree, searchCriteria, } | GetStoreNavigationParams | search criteria for categories |
| contextInstance | ShopwareApiInstance | instance of the api client (by default it's an Axios instance) |
Return type ​
ts
Promise<Array<StoreNavigationElement>>
Usage example ​
WARNING
Example is generated automatically. Sometimes it's required to be adjusted to your needs.
