Class: ProductCategoriesService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:23

Extends

• BaseService

Constructors

Constructor

new ProductCategoriesService(client): ProductCategoriesService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:12

Parameters

client

TanqoryClient

Returns

ProductCategoriesService

Inherited from

BaseService.constructor

Properties

client

protected client: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:10

Inherited from

BaseService.client

Methods

buildQuery()

protected buildQuery(options?): Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:26

Build query parameters

Parameters

options?

ListOptions

Returns

Record<string, any>

Inherited from

BaseService.buildQuery

---

generateIdempotencyKey()

protected generateIdempotencyKey(prefix): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:19

Generate idempotency key

Parameters

prefix

string

Returns

string

Inherited from

BaseService.generateIdempotencyKey

---

get()

get(id): Promise<ProductCategoryTreeNode>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:98

Get a single category by ID (with immediate children)

Parameters

id

string

Category ID

Returns

Promise<ProductCategoryTreeNode>

Category with children

---

getAncestors()

getAncestors(id): Promise<{ data: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:126

Get ancestors (breadcrumb path) for a category

Parameters

id

string

Category ID

Returns

Promise<{ data: object[]; }>

List of ancestor categories from root to parent

---

getAttributeByHandle()

getAttributeByHandle(handle): Promise<{ description?: string; entrySchema?: { baseValueMultiSelect?: boolean; baseValueRequired?: boolean; relatedAttributes?: object[]; showColorPicker?: boolean; showImageSelector?: boolean; }; extendedAttributes?: object[]; handle: string; id: number; isExtended?: boolean; name: string; values: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:209

Get a specific attribute by handle with all its default values (entries)

Parameters

handle

string

Attribute handle (e.g., "color", "age-group")

Returns

Promise<{ description?: string; entrySchema?: { baseValueMultiSelect?: boolean; baseValueRequired?: boolean; relatedAttributes?: object[]; showColorPicker?: boolean; showImageSelector?: boolean; }; extendedAttributes?: object[]; handle: string; id: number; isExtended?: boolean; name: string; values: object[]; }>

Attribute with all values

---

getAttributeById()

getAttributeById(attributeId): Promise<{ description?: string; entrySchema?: { baseValueMultiSelect?: boolean; baseValueRequired?: boolean; relatedAttributes?: object[]; showColorPicker?: boolean; showImageSelector?: boolean; }; extendedAttributes?: object[]; handle: string; id: number; isExtended?: boolean; name: string; values: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:196

Get a specific attribute by ID with all its default values (entries)

Parameters

attributeId

number

Attribute ID

Returns

Promise<{ description?: string; entrySchema?: { baseValueMultiSelect?: boolean; baseValueRequired?: boolean; relatedAttributes?: object[]; showColorPicker?: boolean; showImageSelector?: boolean; }; extendedAttributes?: object[]; handle: string; id: number; isExtended?: boolean; name: string; values: object[]; }>

Attribute with all values

---

getAttributes()

getAttributes(categoryId, options?): Promise<GetCategoryAttributesResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:179

Get all attributes applicable to a category Includes inherited attributes from parent categories. Each attribute contains its default values (entries).

Parameters

categoryId

string

Category ID

options?

Options for fetching attributes

includeInherited?

boolean

Returns

Promise<GetCategoryAttributesResponse>

Category with all applicable attributes and their values

---

getByLevel()

getByLevel(level, options?): Promise<{ data: object[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:156

Get categories by level

Parameters

level

number

Hierarchy level (0 = root)

options?

Pagination params

limit?

number

page?

number

Returns

Promise<{ data: object[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Paginated list of categories at the specified level

---

getChildren()

getChildren(parentId, options?): Promise<{ data: object[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:109

Get children of a category (paginated)

Parameters

parentId

string

Parent category ID

options?

Pagination params

limit?

number

page?

number

Returns

Promise<{ data: object[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Paginated list of child categories

---

getExportMimeType()

protected getExportMimeType(format): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:45

Get MIME type for export format

Parameters

format

string

Returns

string

Inherited from

BaseService.getExportMimeType

---

getFullPath()

getFullPath(id): Promise<string>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:144

Get full category path as string Fetches ancestors and builds a breadcrumb string.

Parameters

id

string

Category ID

Returns

Promise<string>

Full path string like "Animals & Pet Supplies > Pet Supplies > Bird Supplies"

---

list()

list(options?): Promise<{ data: object[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:35

List product categories (flat list with pagination) Supports filtering by parentId, level, and search.

Parameters

options?

Query params for filtering and pagination

childrenDepth

number

includeChildren

boolean

level?

number

limit

number

page

number

parentId?

string

search?

string

Returns

Promise<{ data: object[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Paginated list of categories

---

listRoot()

listRoot(options?): Promise<{ data: object[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:47

List root categories (level 0)

Parameters

options?

Pagination params

limit?

number

page?

number

Returns

Promise<{ data: object[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Paginated list of root categories

---

listTree()

listTree(options?): Promise<{ data: ProductCategoryTreeNode[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:63

List categories as a hierarchical tree Returns categories with nested children.

Parameters

options?

Query params including childrenDepth

childrenDepth

number

includeChildren

boolean

level?

number

limit

number

page

number

parentId?

string

search?

string

Returns

Promise<{ data: ProductCategoryTreeNode[]; pagination: { hasNext: boolean; hasPrev: boolean; limit: number; page: number; total: number; totalPages: number; }; }>

Paginated tree of categories

---

search()

search(query, limit?): Promise<{ data: object[]; total: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/product-categories.ts:80

Search categories by name

Parameters

query

string

Search string

limit?

number

Max results (default: 20)

Returns

Promise<{ data: object[]; total: number; }>

Search results