Retrieving Product Details

Retrieving products to view the details helps you explore the products before you add them to the cart. You can retrieve the product details using the GET/products endpoint. The API retrieves the following basic product details:

Product header details, which includes Product Name, Description, Configuration Type, images associated, and if the product has options or attribute.
Product pricing details
Attributes and options associated with the product
Recommended similar products

You can use the parameters available in the API to retrieve product details based on a specific requirement.

Method: GET
Endpoint: /products

API Purpose

GET/products?page=1&limit=12&sort=asc(Name) Retrieves the details of the first 12 products in the given pricelist and sorts them alphabetically based on the Product Names

GET/products?filers=eq(ConfigurationType='Standalone')

&page=1&limit=12&sort=asc(Name)

Retrieves details of standalone products with the pricing details associated with them.

GET/products?filers=eq(ConfigurationType='Bundle')

&includes=options&includes=price&page=1&limit=12&sort=asc(Name)

Retrieve details of bundle products with their options and associated pricing details associated with them

Example API with Parameter Details and Responses

The following example is when we have to retrieve details of bundle products with their options and associated pricing details associated with them.

Pass the parameters in the GET/products API, as described in the following table.

Request

'GET' \'https://<URL_of_the_Instance>/api/catalog/v1/products?filter=eq%28ConfigurationType%3A%27Bundle%27%29&includes=options&includes=price&sort=asc%28Name%29&page=1&limit=2'

CODE

Parameters	Value
page	1
limit	2
sort	asc(Name)
filter	ConfigurationType:'bundle'
includes	prices, options
pricelist ID	cbc75112-60e9-47b2-a632-f70d5912b70f

Response

[
  {
    "ConfigurationType": "Bundle",
    "Customizable": null,
    "Description": null,
    "DisplayUrl": null,
    "EffectiveDate": "1900-01-01T00:00:00Z",
    "ExcludeFromSitemap": false,
    "ExpirationDate": "2100-12-31T00:00:00Z",
    "Family": "Hardware",
    "HasAttributes": false,
    "HasDefaults": false,
    "HasOptions": true,
    "HasSearchAttributes": false,
    "ImageURL": null,
    "IsActive": true,
    "IsCustomizable": false,
    "IsTabViewEnabled": false,
    "ProductCode": null,
    "ProductType": "Equipment",
    "QuantityUnitOfMeasure": null,
    "RenewalLeadTime": 0,
    "StockKeepingUnit": null,
    "Uom": "Each",
    "Version": 1,
    "TriggeringPrimaryLineNumbers": null,
    "RuleActionId": null,
    "CreatedBy": null,
    "CreatedDate": null,
    "Id": "beb90aeb-5b10-439c-b177-adf11a6ec63a",
    "ModifiedBy": null,
    "ModifiedDate": null,
    "Name": "3000 Series Memory",
    "Currency": null,
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": null,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": null,
    "CatAuto_DateTime_CstField_c": null,
    "CatAuto_Double_CstField_c": null,
    "CatAuto_Int_CstField_c": null,
    "CatAuto_Multipicklist_CstField_c": null,
    "CatAuto_String_CstField_c": null
  },
  {
    "ConfigurationType": "Bundle",
    "Customizable": null,
    "Description": null,
    "DisplayUrl": null,
    "EffectiveDate": "1900-01-01T00:00:00Z",
    "ExcludeFromSitemap": false,
    "ExpirationDate": "2100-12-31T00:00:00Z",
    "Family": "Hardware",
    "HasAttributes": false,
    "HasDefaults": false,
    "HasOptions": true,
    "HasSearchAttributes": false,
    "ImageURL": null,
    "IsActive": true,
    "IsCustomizable": false,
    "IsTabViewEnabled": false,
    "ProductCode": null,
    "ProductType": "Equipment",
    "QuantityUnitOfMeasure": null,
    "RenewalLeadTime": 0,
    "StockKeepingUnit": null,
    "Uom": "Each",
    "Version": 1,
    "TriggeringPrimaryLineNumbers": null,
    "RuleActionId": null,
    "CreatedBy": null,
    "CreatedDate": null,
    "Id": "9dcb978a-6109-4465-a9fa-4363686e8cdb",
    "ModifiedBy": null,
    "ModifiedDate": null,
    "Name": "3200 Series Memory",
    "Currency": null,
    "ExternalId": null,
    "Digest": null,
    "CatAuto_Boolean_CstField_c": null,
    "CatAuto_Currency_CstField_c": null,
    "CatAuto_CustomFieldPickList_c": null,
    "CatAuto_DateTime_CstField_c": null,
    "CatAuto_Double_CstField_c": null,
    "CatAuto_Int_CstField_c": null,
    "CatAuto_Multipicklist_CstField_c": null,
    "CatAuto_String_CstField_c": null
  }
]

CODE