GET categories/getcategorytree

No documentation available.

Request Information

» Expands

Name	Description	Usage
categoryNodes	This will retrieve the related list of category nodes.	GET categories/getcategorytree?expand=categorynodes
product	This will retrieve the related product.	GET categories/getcategorytree?expand=product
productIds	This will retrieve the related list of product IDs.	GET categories/getcategorytree?expand=productids
subcategories	This will retrieve the related list of subcategories.	GET categories/getcategorytree?expand=subcategories

» Filters

Name	Description	Usage
externalId	This will filter the request by external ID.	GET categories/getcategorytree?filter=externalid~{operator}~{value}
isVisible	This will filter the request by the is visible flag.	GET categories/getcategorytree?filter=isvisible~{operator}~{value}
name	This will filter the request by name.	GET categories/getcategorytree?filter=name~{operator}~{value}
portalId	This will filter the request by portal ID.	GET categories/getcategorytree?filter=portalid~{operator}~{value}
title	This will filter the request by title.	GET categories/getcategorytree?filter=title~{operator}~{value}

» Sorting

Name	Description	Usage
categoryId	This will sort the response by category ID.	GET categories/getcategorytree?sort=categoryid
displayOrder	This will sort the response by display order.	GET categories/getcategorytree?sort=displayorder
name	This will sort the response by name.	GET categories/getcategorytree?sort=name
title	This will sort the response by title.	GET categories/getcategorytree?sort=title

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET categories/getcategorytree?page=index~{value}
size	The size of the page when retrieving paged results.	GET categories/getcategorytree?page=size~{value}