GET v2/categories?catalogIds={catalogIds}

No documentation available.

Request Information

» Parameters

Name	Description	Additional information
catalogIds	No documentation available.	Define this parameter in the request URI.

» Expands

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

» Filters

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

» Sorting

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

» Paging

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