Retrieving Product Details

You can retrieve products using GET /products to view their details before adding them to the cart. The API retrieves the following basic product details:

Product header details, including the product name, description, configuration type, associated images, and if the product has options or attributes.
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: GET /products?page=1&limit=12&sort=asc(Name)

Purpose: Retrieves the details of the first 12 products in the given price list and sorts them alphabetically based on the product names.

API: GET /products?filers=eq(ConfigurationType='Standalone')&page=1&limit=12&sort=asc(Name)

Purpose: Retrieves standalone product details with their associated pricing details.

API: GET /products filers=eq(ConfigurationType='Bundle')&includes=options&includes=price&page=1&limit=12&sort=asc(Name)

Purpose: Retrieves bundle product details with their options and associated pricing details.

Example API with Parameter Details and Responses

The following example is for retrieving bundle product details with options and associated pricing details.

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'

Parameters	Value
Page	1
Limit	2
Sort	`asc(Name)`
Filter	`ConfigurationType:'bundle'`
Includes	options, prices
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  
  }  
\]