Class CategoriesResource

Index

Constructors

Methods

getByHandle getProducts list listPage

Constructors

constructor

new CategoriesResource(http: HttpClient): CategoriesResource
Parameters
- http: HttpClient
Returns CategoriesResource
- Defined in services/api/packages/storefront-sdk/src/resources/categories.ts:16

Methods

getByHandle

getByHandle(handle: string): Promise<StorefrontCategory>
Get a single category by URL handle
Parameters
- handle: string
Returns Promise<StorefrontCategory>
- Defined in services/api/packages/storefront-sdk/src/resources/categories.ts:53

getProducts

getProducts(params?: ProductSearchParams): Promise<ProductSearchResponse>
Get products in a category (uses the search engine)
Parameters
- params: ProductSearchParams = {}
Returns Promise<ProductSearchResponse>
- Defined in services/api/packages/storefront-sdk/src/resources/categories.ts:58

list

list(locale?: string): Promise<StorefrontCategory[]>
Get ALL categories for the market (flat list; build the tree from parentId).

Pages through /categories?page&limit so large trees are never truncated. Against an older API that ignores the paging params (and answers with a plain array), the array is returned as-is.
Parameters
- Optionallocale: string
Returns Promise<StorefrontCategory[]>
- Defined in services/api/packages/storefront-sdk/src/resources/categories.ts:25

listPage

listPage(params?: CategoryListParams): Promise<StorefrontCategoryPage>
One page of categories: { categories, pagination } (limit max 250).
Parameters
- params: CategoryListParams = {}
Returns Promise<StorefrontCategoryPage>
- Defined in services/api/packages/storefront-sdk/src/resources/categories.ts:40