List categories

get

https://rls.congacloud.com/api/catalog/v1/categories

Retrieves all or a filtered list of categories based on provided parameters. For example, passing the price list ID retrieves all categories associated with that price list ID.

The API returns the list of categories with such details as category ID, category name, description, hierarchy ID, and the category's parent and child categories.

The API also executes visibility rules at runtime. The API executes one or more visibility rules on the root category and retrieves the list of categories. These visibility rules can include or exclude specific categories. The visibility rule must be associated with the price list to be executed at runtime.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

array of strings

Conditional filter in URI format.

filter

query

string

Enter the name of the category to narrow down the search result. The API can only match a maximum of 20 characters. If the input string is longer than 30 characters, the API retrieves categories where category name matches the first 20 characters of search string. If the parameter is left blank, all relevant categories after the filter is executed are retrieved.

sort

string

Enter the fields and sort order for the result. Add multiple fields to sort the result further. By default, sort order is ascending based on the category name.

page

int32

Defaults to 1

Enter the page number of the search result from where to view the result.

limit

int32

Defaults to 50

Enter the number of records to display on each page. By default, the API displays 50 records on each page. A maximum of 500 records are displayed on each page.

depth

string

Enter the depth to fetch categories till that level.

fetchEmptyCategories

boolean

Defaults to true

Set value to false to only get the Categories that are associated with Products

configName

string

Defaults to ResponseFieldList_Default

Config Name that stores the Category search response field list

Headers

pricelistid

string

Identifier for a price list entity.

storeFrontId

string

Enter the storefront ID to retrieve its visibility rules.

cartId

string

Pass a cart id to filter the data relative to a specific cart.

Response

200OK