Home > @vsf-enterprise/commercetools-api > getCategory

getCategory() function

Endpoint for loading categories based on filter parameters. By default, it uses the getCategoryDefaultQuery GraphQL query

Signature:

export declare function getCategory(context: Context, params: CategoryWhereSearch, customQuery?: CustomQuery): Promise<import("@apollo/client/core").ApolloQueryResult<any>>;

Parameters

Parameter	Type	Description
context	Context	Automatically injected context. Refer to Context
params	CategoryWhereSearch	Filtering and pagination options
customQuery	CustomQuery	Custom queries included in the request

Returns:

Promise<import("@apollo/client/core").ApolloQueryResult<any>>

Paginated categories data