List products by price list

get

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

Retrieves details of active products associated with the provided price list ID. The API only retrieves active products with an active price list and price list item. The API also applies visibility rules and only retrieves relevant products.

The API searches, sorts, filters, and applies pagination on the retrieved result.

For example, retrieve a list of products where the product name is "Product A", sort the result by product name.

The API returns the list of products in a price list and details of the following fields, among others.

Product Name
Product Code
Product Description
Product Family
Product Type
Configuration Type
Has Attributes
Configuration Type
Option products (if provided product is a bundle) including the default bundle options
The image associated with the product
List Price
Charge Type

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

array of strings

Contains conditional filter or filters in standard URI format to narrow the search result. For example, "eq(Product Family = 'Hardware')".

filter

query

string

Keyword used to narrow search results. The API can match 20 characters at most. If the input string exceeds 20 characters, the API retrieves products where the product name matches the first 20 characters of search string. If the parameter is left blank, all relevant products after the filter is executed are retrieved.

includes

array of strings

Contains a list of objects associated with the product for inclusion in the search result.

includes

sort

string

Contains the fields and sort order for the result. Adding fields refines the result further. The default sort order is ascending by relevance.

page

int32

Defaults to 1

The page number of the search result to view the result from.

limit

int32

Defaults to 50

Contains the number of records to display on each page. The API displays 50 records per page by default. A maximum of 500 records is 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 currency conversion of price list items

configName

string

Defaults to ResponseFieldList_Default

Product search response field list

Headers

pricelistid

string

Enter the price list ID to retrieve the products associated with it. If an inactive price list ID is entered, the API displays a validation error.

storeFrontId

string

Enter the storefront ID to retrieve visibility rules.

cartId

string

Unique identifier of the cart

Responses

200OK

400Bad Request