Skip to main content

Class: CategoryService

Defined in: service/CategoryService.ts:202

Backwards-compatible class form. New code should call categoryService(client).

Constructors​

Constructor​

new CategoryService(client): CategoryService

Defined in: service/CategoryService.ts:204

Parameters​

client​

GraphQLClient

Returns​

CategoryService

Methods​

addProductsClustersToCategory()​

addProductsClustersToCategory(variables): Promise<CategoryAddProductsClustersResponse>

Defined in: service/CategoryService.ts:235

Adds products/clusters to a category

Parameters​

variables​

CategoryAddProductsClustersVariables

Category add products/clusters input data

Returns​

Promise<CategoryAddProductsClustersResponse>

categoryMoveAbove()​

categoryMoveAbove(variables): Promise<Category[]>

Defined in: service/CategoryService.ts:251

Parameters​

variables​

CategoryMoveAboveVariables

Returns​

Promise<Category[]>

categoryMoveBelow()​

categoryMoveBelow(variables): Promise<Category[]>

Defined in: service/CategoryService.ts:252

Parameters​

variables​

CategoryMoveBelowVariables

Returns​

Promise<Category[]>

createCategory()​

createCategory(variables): Promise<Category>

Defined in: service/CategoryService.ts:220

Creates a new category

Parameters​

variables​

CategoryCreateVariables

Category creation input data

Returns​

Promise<Category>

getAttributeResultByCategoryId()​

getAttributeResultByCategoryId(categoryId, input): Promise<AttributeResultResponse>

Defined in: service/CategoryService.ts:246

Fetches attribute results for a category

Parameters​

categoryId​

number

Category ID

input​

AttributeResultSearchInput

Attribute result search input

Returns​

Promise<AttributeResultResponse>

getCategories()​

getCategories(filter?, userId?): Promise<CategoryResponse>

Defined in: service/CategoryService.ts:210

Fetches a list of categories

Parameters​

filter?​

any

Category filter criteria

userId?​

number

User ID for personalization

Returns​

Promise<CategoryResponse>

getCategory()​

getCategory(variables, fetchOptions?): Promise<Category>

Defined in: service/CategoryService.ts:215

Fetches a single category by ID or slug

Parameters​

variables​

CategoryQueryVariables

Variables for the category query

fetchOptions?​

GraphQLFetchOptions

Returns​

Promise<Category>

getCategoryBySlug()​

getCategoryBySlug(variables): Promise<Category>

Defined in: service/CategoryService.ts:247

Parameters​

variables​

CategoryBySlugVariables

Returns​

Promise<Category>

getCategoryBySource()​

getCategoryBySource(variables): Promise<Category>

Defined in: service/CategoryService.ts:248

Parameters​

variables​

CategoryBySourceVariables

Returns​

Promise<Category>

getCategoryChildren()​

getCategoryChildren(variables): Promise<Category[]>

Defined in: service/CategoryService.ts:249

Parameters​

variables​

CategoryChildrenVariables

Returns​

Promise<Category[]>

getCategoryHierarchy()​

getCategoryHierarchy(variables): Promise<Category[]>

Defined in: service/CategoryService.ts:250

Parameters​

variables​

CategoryHierarchyVariables

Returns​

Promise<Category[]>

importCategoriesCsv()​

importCategoriesCsv(input): Promise<CsvImportResponse>

Defined in: service/CategoryService.ts:230

Imports categories from CSV

Parameters​

input​

CategoryCsvInput

CSV import input data

Returns​

Promise<CsvImportResponse>

removeProductsClustersFromCategory()​

removeProductsClustersFromCategory(variables): Promise<CategoryRemoveProductsClustersResponse>

Defined in: service/CategoryService.ts:240

Removes products/clusters from a category

Parameters​

variables​

CategoryRemoveProductsClustersVariables

Category remove products/clusters input data

Returns​

Promise<CategoryRemoveProductsClustersResponse>

updateCategory()​

updateCategory(variables): Promise<Category>

Defined in: service/CategoryService.ts:225

Updates an existing category

Parameters​

variables​

CategoryUpdateVariables

Category update input data

Returns​

Promise<Category>