You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
getCategory
Endpoint for loading categories based on filter parameters. By default, it uses the getCategoryDefaultQuery GraphQL query
Signature
export declare function getCategory(
context: SetupContext,
params: CategoryWhereSearch,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
): Promise<any>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
params | Required | CategoryWhereSearch | Filtering and pagination options |
customQuery | Optional | CustomQuery | Custom queries included in the request |
responseOptions | Optional | ResponseOptions |
Returns
Paginated categories data