Znode

GET categories/catalog/{catalogId}/{profileId}

No documentation available.

Request Information

» Parameters

Name Description Additional information
catalogId No documentation available.

Define this parameter in the request URI.

profileId 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 categories/catalog/{catalogId}/{profileId}?expand=categorynodes
productIds This will retrieve the related list of product IDs. GET categories/catalog/{catalogId}/{profileId}?expand=productids
subcategories This will retrieve the related list of subcategories. GET categories/catalog/{catalogId}/{profileId}?expand=subcategories

» Filters

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

» Sorting

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

» Paging

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