@plentymarkets/shop-api / getFacet

Function: getFacet()

getFacet(context, params): Promise<Data<Facet>>

Method getFacet - Used to get the category facets.

Parameters

• context: PlentysystemsIntegrationContext

• params: FacetSearchCriteria

categoryId: id of the category. page: current page number. itemsPerPage: number of items per page. sort: type of sorting. facets: search facet

Returns

Promise<Data<Facet>>

Category facets.

Remarks

• Calls /rest/storefront/items
• Method should be used to get the category facets.

Example

const { data } = await useSdk().plentysystems.getFacet({
    categoryId: '17',
    categorySlug: "armchair-stool",
    page: 1,
    itemsPerPage: 20,
    sort: 'sorting.price.avg_asc',
    facets: 'feedback-2'
});

Defined in

api/getFacet/index.ts:40