Bulk Product Details Input

Input representation of the request to retrieve the details of multiple products.
JSON example
{
  "correlationId": "cbfabffb-093f-45b3-8c2d-88b4acbd4867",
  "productIds": [
    "01tT1000000F0afIAC",
    "01tT1000000F0afIAC"
  ],
  "uptoLevel": 1,
  "additionalFields": {
    "Product2": {
      "fields": [
        "code__c"
      ]
    },
    "ProductAttributeDefinition": {
      "fields": [
        "scope"
      ]
    }
  }
}
Properties
Name Type Description Required or Optional Available Version
additional​Fields Map<String, Additional Fields Input>

Map of object and list of additional standard or custom fields to be included in the response.

The supported objects are:

  • Product2
  • ProductAttributeDefinition—If the fields defined for the ProductAttributeDefinition object aren’t available for the ProductClassificationAttr object, then the API request fails.
Optional 61.0
correlation​Id String Unique token to track and associate related events or transactions across different components of the application. If unspecified, a Universally Unique Identifier (UUID) is generated. Optional 61.0
product​Ids String[]

List of product IDs that details must be returned for.

If any product ID is blank, invalid, or not found, then the request is processed with valid and available product IDs.

Required 61.0
upto​Level Integer

Hierarchy level to follow to return the product details. For a bundle, this property determines the number of levels of child components to be returned. You can specify up to a hierarchy level of 1.

If unspecified, the default level is the full bundle hierarchy.

Optional 61.0