getTopCategories(pageNumber, pageSize) ⇒ Promise.<CategoryModelArray>

Gets the top level product categories of a store, using pagination. Categories that do not contain online products on any level are filtered out.

getSubCategories(categoryID, pageNumber, pageSize) ⇒ Promise.<CategoryListModel>

Gets the sub-categories of a specific product category, using pagination. Categories that do not contain online products on any level are filtered out.

getCategoryIDByFriendlyID(categoryFriendlyID) ⇒ Promise.<GUID>

Gets the category's unique ID by its friendly ID.

getCategory(categoryID) ⇒ Promise.<CategoryExtendedModel>

Gets the category by its unique ID.

getCategoryTree(depth) ⇒ Promise.<CategoryTreeModel>

Gets the tree of product categories of a store.

CategoryModelArray : Array.<CategoryModel>

A list of product categories.

GUID : string

globally unique identifier

CategoryModel : Object

Provides information about a category of products.

CategoryListModel : Object

Provides a list of product categories according to the pagination.

SeoConfigurationModel : Object

Provides information about the SEO configuration of a category or product.

CategoryExtendedModel : Object

Provides information about a category, including additional data such as SEO configuration.

CategoryTreeNodeModel : Object

Node representation in a product category tree.

CategoryTreeModel : Object

Node representation in a product category tree.

Gets the top level product categories of a store, using pagination. Categories that do not contain online products on any level are filtered out.

Kind: global function
Returns: Promise.<CategoryModelArray> - Returns a list of product categories according the requested parameters.

Param	Type	Description
pageNumber	number	The requested page number.
pageSize	number	The number of categories on a single page. The maximum is 200.

Gets the sub-categories of a specific product category, using pagination. Categories that do not contain online products on any level are filtered out.

Kind: global function
Returns: Promise.<CategoryListModel> - Returns a list of sub-categories according the requested parameters.

Param	Type	Description
categoryID	GUID	The unique ID of the parent category.
pageNumber	number	The requested page number.
pageSize	number	The number of categories on a single page. The maximum is 200.

Gets the category's unique ID by its friendly ID.

Kind: global function
Returns: Promise.<GUID> - Returns a unique ID for the requested category.

Param	Type	Description
categoryFriendlyID	number	The friendly ID of the category.

Gets the category by its unique ID.

Kind: global function
Returns: Promise.<CategoryExtendedModel> - Returns a category for the requested unique ID. Throws an exception if the requested category does not contain online products on any level.

Param	Type	Description
categoryID	GUID	The unique ID of the category.

Gets the tree of product categories of a store.

Kind: global function
Returns: Promise.<CategoryTreeModel> - Returns a tree of product categories according the requested parameters.

Param	Type	Description
depth	number	The tree depth.

A list of product categories.

Kind: global typedef

globally unique identifier

Kind: global typedef

Provides information about a category of products.

Kind: global typedef
Properties

Name	Type	Description
ID	GUID	The unique ID of the category.
FriendlyID	number	The friendly ID of the category.
Name	string	The name of the category.
Description	string	The description of the category.
HasProducts	boolean	Indicates whether the category contains at least one online product.
HasSubCategories	boolean	Indicates whether the category contains at least one sub-category, of any level, that has an online product.
ImageUrl	string	The URL of the category image.

Provides a list of product categories according to the pagination.

Kind: global typedef
Properties

Name	Type	Description
Categories	Array.<CategoryModel>	The list of the product categories according to the pagination.
Count	number	The total number of product categories without pagination.

Provides information about the SEO configuration of a category or product.

Kind: global typedef
Properties

Name	Type	Description
Title	string	The title of a webpage.
Description	string	The description of a webpage.

Provides information about a category, including additional data such as SEO configuration.

Kind: global typedef
Properties

Name	Type	Description
SeoConfiguration	SeoConfigurationModel	The SEO configuration.
ID	GUID	The unique ID of the category.
FriendlyID	number	The friendly ID of the category.
Name	string	The name of the category.
Description	string	The description of the category.
HasProducts	boolean	Indicates whether the category contains at least one online product.
HasSubCategories	boolean	Indicates whether the category contains at least one sub-category, of any level, that has an online product.
ImageUrl	string	The URL of the category image.

Node representation in a product category tree.

Kind: global typedef
Properties

Name	Type	Description
Category	CategoryModel	The product category of the node.
SubCategories	Array.<CategoryTreeNodeModel>	The sub-categories (child nodes) of the node.

Node representation in a product category tree.

Kind: global typedef
Properties

Name	Type	Description
Categories	CategoryTreeNodeModel	The list of top level (root) categories.