Revenue Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Revenue Cloud Developer Resources
Product Catalog Management
Product Catalog Management
Product Catalog Management Standard Objects
Product Catalog Management Fields on Standard Objects
Product Catalog Management Business APIs
Resources
Bulk Product Details (POST)
Catalog List (POST)
Catalog By ID (GET)
Categories List (GET)
Category By ID (GET)
Deep Clone (POST)
Index Configuration Collection (GET, PUT)
Index Setting (GET, PATCH)
Product Details (GET)
Product Related Records List (POST)
Products List (POST)
Snapshot Collection (GET)
Snapshot Deployment (POST)
Snapshot Index Error (GET)
Unit of Measure Info (GET)
Unit of Measure Rounded Data (POST)
Request Bodies
Response Bodies
Product Catalog Management Metadata API Types
Product Catalog Management Tooling API Objects
Product Discovery
Salesforce Pricing
Product Configurator
Transaction Management
Usage Management
Rate Management
Dynamic Revenue Orchestrator
Billing
Revenue Cloud Associated Objects
PDF

Product Related Records List (POST)

Retrieve related ProductRampSegment or ProductUsageGrant records for Product2 object.
Resource
/connect/pcm/relatedRecords/entityName
The supported entity or object is Product2.
Resource example
https://yourInstance.salesforce.com/services/data/v64.0/connect/pcm/relatedRecords/product2
Available version
62.0
HTTP methods
POST

POST methods typically create an item, but for this resource POST is used to retrieve information.

Note

Request body for POST
JSON example
{
  "recordIds": [
    "01txx0000006i44AAA",
    "01txx0000006i5gAAA"
  ],
  "relatedObjectNodes": [
    {
      "relatedObjectAPIName": "ProductRampSegment",
      "pageSize": 20,
      "offSet": 0
    },
    {
      "relatedObjectAPIName": "ProductUsageGrant",
      "pageSize": 10,
      "offSet": 0,
      "filter": {
        "criteria": [
          {
            "property": "status",
            "operator": "eq",
            "value": "active"
          },
          {
            "property": "effectivestartdate",
            "operator": "lte",
            "value": "2024-06-25"
          },
          {
            "criteriaType": "CustomWhereCondition",
            "value": "(effectiveenddate = null OR effectiveenddate >= 2024-06-25)"
          }
        ]
      }
    }
  ]
}
Properties
Name Type Description Required or Optional Available Version
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 62.0
recordIds String[] List of record IDs to return the relatedObjects records for. The maximum number of record IDs supported is 20. Required 62.0
related​ObjectNodes Related Object Node Input[] List of nodes for the related objects. The maximum number of related object nodes supported is two. Required 62.0
Response body for POST
Related Records List