Get a product's details

get

https://rls.congacloud.com/api/catalog/v1/products/{productId}

Retrieves the details of a product (productId). The API only retrieves active products with an active price list and price list item.

The API returns details of the following fields, among others.

Product Name
Product Code
Associated Categories
Associated Attributes
Configuration Type
List Price
Charge Type
Options products (if the provided product is a bundle)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

productId

string

required

The ID of the product to retrieve associated records.

Query Params

includes

array of strings

Related data to include in the response. Available values are attributes, options, prices, and categories.

includes

optionGroupIds

array of strings

The IDs of the leaf option groups with details to be fetched. Works only when isOptimizedFetch is passed as true.

optionGroupIds

depth

string

Defaults to 3

The depth of the bundle level. The API retrieves the details of all options and sub-bundles to this level. The product ID provided in the parameters is at level 0.

disableCurrencyConversion

boolean

Defaults to false

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

fetchNonLeafOptionGroups

boolean

Defaults to false

Flag to enable fetching non-leaf ProductOptionGroups and OptionGroups

isOptimizedFetch

boolean

Defaults to false

Flag to enable/disable fetching option groups and options

configName

string

Defaults to ResponseFieldList_Default

Config Name that stores the Product search response field list

Headers

pricelistid

string

The price list ID used to filter associated records.

cartId

string

The unique identifier for a cart. Pass a cart ID to filter the data relative to a specific cart.

Responses

204

No Content

500

Internal Server Error

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!