Bulk Product Details (POST)

Retrieve details for multiple products.

Resource

1/connect/pcm/products/bulk

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/pcm/products/bulk

Available Version: 61.0

HTTP Methods: POST

Request Body for POST

JSON Example

1{
2  "correlationId": "cbfabffb-093f-45b3-8c2d-88b4acbd4867",
3  "productIds": [
4    "01tT1000000F0afIAC",
5    "01tT1000000F0afIAC"
6  ],
7  "uptoLevel": 1,
8  "language": "french",
9  "additionalFields": {
10    "Product2": {
11      "fields": [
12        "code__c"
13      ]
14    },
15    "ProductAttributeDefinition": {
16      "fields": [
17        "scope"
18      ]
19    }
20  }
21}

This example shows a sample request to fetch data from Enterprise Product Catalog.

1{
2  "productIds": [
3    "01tLT000009vGXfYAM"
4  ],
5  "catalogSystems": [
6    "epc"
7  ],
8  "additionalFields": {
9    "AttributeDefinition": {
10      "fields": [
11        "OptOutAssetization",
12        "OptOutDecompositionAction",
13        "OptOutSupplementalAction"
14      ]
15    }
16  }
17}

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalFields`	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 and ProductAttributeDefinition. If the fields defined for the ProductAttributeDefinition object aren’t available for the ProductClassificationAttr object, then the API request fails. If the Dynamic Revenue Orchestrator permission is enabled, then this property supports AttributeDefinition as key with these supported values: `OptOutAssetization`, `OptOutDecompositionAction`, or `OptOutSupplementalAction`.	Optional	61.0
`catalogSystems`	String[]	Name of the catalog system. Valid values are `epc`—Enterprise Product Catalog or `pcm`—Product Catalog Management. Although this property accepts a list, you can pass only one value. If you don’t specify a value, the default behavior is to fetch data from the `pcm` catalog.	Optional	66.0
`correlationId`	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
`language`	String	Custom language that you can specify to get translated data for the fields of an object that’s enabled for translation. See Translate Product and Product Category Data.	Optional	64.0
`productIds`	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
`uptoLevel`	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

Response Body for POST: Products Output