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
Salesforce Pricing
Salesforce Pricing Standard Objects
Salesforce Pricing Business APIs
Salesforce Pricing Standard Invocable Actions
Run Salesforce Headless Pricing Action
Run Salesforce Pricing Action
Salesforce Pricing Metadata API Types
Salesforce Pricing Tooling API Objects
Product Configurator
Transaction Management
Usage Management
Rate Management
Dynamic Revenue Orchestrator
Billing
Revenue Cloud Associated Objects
PDF

Run Salesforce Headless Pricing Action

Invoke the Pricing Connect API by providing the pricing data and details of a context, pricing procedure, and price waterfall.

This action is available in API version 60.0 and later.

Special Access Rules

The Run Salesforce Headless Pricing action is available in Enterprise, Unlimited, and Developer Editions where Salesforce Pricing is enabled.

Supported REST HTTP Methods

URI
/services/data/v64.0/actions/standard/runSalesforceHeadlessPricing
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
contextDefinitionId
Type
string
Description

Required.

ID of the context definition record that’s used to build the pricing data.
contextMappingId
Type
string
Description

Required.

ID of the context-mapping record that identifies which Salesforce object and mappings to use to build the pricing data.
discoveryProcedure
Type
string
Description

Name of the discovery procedure that’s used to execute the discovery process.
displayContext
Type
boolean
Description

Indicates whether to display the context structure for pricing (true) or not (false).
effectiveDate
Type
string
Description

Date when the pricing rules, as specified in the pricing procedure, are applied.

The effectiveDate parameter determines which pricing procedure to execute when multiple active versions of pricing procedures are available with different date ranges.
isHighVolumeLineItems
Type
boolean
Description

Indicates whether the pricing API returns pricing details for more than 100 line items (true) or not (false).
isSkipWaterfall
Type
boolean
Description

Indicates whether to generate the price waterfall data (true) or not (false).
persistContext
Type
boolean
Description

Indicates whether to store the context (true) or not (false).
pricingData
Type
string
Description

Required.

JSON data that’s used to build the pricing data. The JSON must be escaped.
pricingProcedureId
Type
string
Description

Required.

ID of the expression set definition record that’s used to execute the pricing process.
skipDiscovery
Type
boolean
Description

Indicates whether to skip executing the discovery procedure (true) or not (false).
taggedData
Type
boolean
Description

Indicates whether the associated context node contains a key (true) or not (false).
useSessionScopedContext
Type
boolean
Description

Indicates whether to store the context in a session (true) or a request (false).

Outputs

Output Details
contextDetails
Type
string
Description
Context structure for pricing that’s generated when the displayContext parameter is set to true.
executionId
Type
string
Description
ID of the executed pricing data.
pricingProcessErrors
Type
string
Description
Errors that are generated due to context tags in a pricing process.
pricingProcessStatus
Type
string
Description
Status of the pricing process, which is executed as an API call.
pricingResult
Type
string
Description
Outcome of the executed pricing process that’s based on the output tags defined in the associated context definition.

Example

POST

This sample request is for the Run Salesforce Headless Pricing action.

{
  "inputs": [
    {
      "contextMappingId": "11jSB000002Bn13YAC",
      "contextDefinitionId": "11OSB0000000WSv2AM",
      "pricingProcedureId": "9QLSB0000001lT74AI",
      "discoveryProcedure": "ES1",
      "displayContext": true,
      "effectiveDate": "2023-11-16T12:20:00.000Z",
      "isHighVolumeLineItems": true,
      "skipDiscovery": true,
      "taggedData": false,
      "pricingData": "{\"SalesTransaction\":{\"businessObjectType\":\"SalesTransaction\",\"Pricebook\":\"01sDE0000000LoeYAE\",\"CurrencyIsoCode\":\"USD\",\"SalesTransactionItem\":[{\"businessObjectType\":\"SalesTransactionItem\",\"Product\":\"01tDE000000FU99YAG\",\"ProductSellingModel\":\"0jPDE000000042K2AQ\",\"Quantity\":5,\"StartDate\":\"2023-11-16T12:20:00.000Z\",\"SalesTransactionItemSource\":\"LINE_ITEM1\"}]}}",
      "isSkipWaterfall": false,
      "persistContext": true,
      "useSessionScopedContext": false
    }
  ]
}

This sample response is for the Run Salesforce Headless Pricing action.

{
  "actionName": "runSalesforceHeadlessPricing",
  "errors": null,
  "isSuccess": true,
  "outputValues": {
    "contextDetails": {
      "SalesTransaction": [
        {
          "PriceBooks": "01sxx0000005q3VAAQ",
          "Subtotal": 587.2095,
          "PriceAdjustmentSchedule": "84Xxx0000004CMxEAM",
          "EffectiveDate": "2024-02-12T00:00:00.000Z",
          "SalesTransactionItem": [
            {
              "LineItemQuantity": 5,
              "ProductSellingModel": "0jPxx000000009hEAA",
              "DerivedPricingAttribute": false,
              "Product": "01txx0000006iLwAAI",
              "LineItem": "LineItem1",
              "NetUnitPrice": 117.4419,
              "SalesTrxnAdjustmentGroup": [
                {
                  "AdjustmentType": "Percentage",
                  "AdjustmentValue": 10
                }
              ]
            }
          ]
        }
      ]
    },
    "executionId": "1708488641379821",
    "pricingProcessStatus": "Completed",
    "pricingResult": {
      "StartDate": [
        {
          "value": 1700137200000,
          "dataPath": [
            "CTX_ece1667e-7a09-40ab-9718-23bdc179a0a5",
            "CTX_d3b9ffd5-2be7-4366-92d8-c2bcf03b69ed"
          ],
          "errors": [],
          "isSuccess": true
        }
      ],
      "NetUnitPrice": [
        {
          "value": 115,
          "dataPath": [
            "CTX_ece1667e-7a09-40ab-9718-23bdc179a0a5",
            "CTX_d3b9ffd5-2be7-4366-92d8-c2bcf03b69ed"
          ],
          "errors": [],
          "isSuccess": true
        }
      ],
      "ProductSellingModel": [
        {
          "value": "0jPDE000000042K2AQ",
          "dataPath": [
            "CTX_ece1667e-7a09-40ab-9718-23bdc179a0a5",
            "CTX_d3b9ffd5-2be7-4366-92d8-c2bcf03b69ed"
          ],
          "errors": [],
          "isSuccess": true
        }
      ],
      "Pricebook": [
        {
          "value": "01sDE0000000LoeYAE",
          "dataPath": [
            "CTX_ece1667e-7a09-40ab-9718-23bdc179a0a5"
          ],
          "errors": [],
          "isSuccess": true
        }
      ],
      "NetTotalPrice": [
        {
          "value": 1150,
          "dataPath": [
            "CTX_ece1667e-7a09-40ab-9718-23bdc179a0a5",
            "CTX_d3b9ffd5-2be7-4366-92d8-c2bcf03b69ed"
          ],
          "errors": [],
          "isSuccess": true
        }
      ],
      "Subtotal": [
        {
          "value": 1150,
          "dataPath": [
            "CTX_ece1667e-7a09-40ab-9718-23bdc179a0a5"
          ],
          "errors": [],
          "isSuccess": true
        }
      ],
      "Quantity": [
        {
          "value": 10,
          "dataPath": [
            "CTX_ece1667e-7a09-40ab-9718-23bdc179a0a5",
            "CTX_d3b9ffd5-2be7-4366-92d8-c2bcf03b69ed"
          ],
          "errors": [],
          "isSuccess": true
        }
      ],
      "Product": [
        {
          "value": "01tDE000000FU99YAG",
          "dataPath": [
            "CTX_ece1667e-7a09-40ab-9718-23bdc179a0a5",
            "CTX_d3b9ffd5-2be7-4366-92d8-c2bcf03b69ed"
          ],
          "errors": [],
          "isSuccess": true
        }
      ],
      "CurrencyIsoCode": [
        {
          "value": "USD",
          "dataPath": [
            "CTX_ece1667e-7a09-40ab-9718-23bdc179a0a5"
          ],
          "errors": [],
          "isSuccess": true
        }
      ]
    }
  },
  "version": 1
}