Alokai

getFacetCategories

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

Signature

declare function getFacetCategories(
	context: CommercetoolsIntegrationContext,
	params: CategoryWhereSearch,
	customQuery?: CustomQuery,
	responseOptions?: ResponseOptions
): Promise<GetFacetCategoriesResponse>;

Parameters

NameRequiredTypeDescription
contextRequiredCommercetoolsIntegrationContextAutomatically injected context. Refer to CommercetoolsIntegrationContext
paramsRequiredCategoryWhereSearchFiltering and pagination options
customQueryOptionalCustomQueryCustom queries included in the request
responseOptionsOptionalResponseOptions

Returns

Paginated categories data

Referenced Types

On this page