Retrieve all service products in a category

post

https://rls.congacloud.com/api/catalog/v1/categories/{categoryId}/services

Retrieves all active service products associated with the provided category ID and price list ID. This can be the ID of the leaf category, sub-category, or root category.

For a leaf category, the API returns all service products associated with it. If the ID of the root or sub-category (not a leaf category ID) is provided, the API returns all the products associated with all child categories. By default, the API returns the following fields with results sorted alphabetically by Product Name.

Product Name
Product Code
Product Description
Product Family
List Price
Charge Type
The image associated with the product.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

categoryId

string

required

Enter the category ID, typically the classification hierarchy ID.

Query Params

filter

array of strings

Add conditional filters in standard URI format to narrow down the search result.

filter

query

string

Enter the name of the product to narrow down the search result. The API can only match a maximum of 20 characters. If the input string is longer than 20 characters, the API retrieves products where the product name matches the first 20 characters of the search string.

includes

array of strings

Add the list of related objects that are associated with the product to include them in the search result.

includes

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 relevance.

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.

productSortEmptyFirst

boolean

Defaults to false

Flag to place products with null values in the sorting field at first or last in the list.

disableCurrencyConversion

boolean

Defaults to false

Flag to enable/disable the currency conversion of price list items

configName

string

Defaults to ResponseFieldList_Default

Product search response field list

Body Params

Input needed to list the service products.

isPointOfSale

boolean

lineItems

array of objects | null

lineItems

Headers

pricelistid

string

Enter the ID of the price list associated with the products to narrow down the search.

cartId

string

Enter the cart Id

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

200OK