Salesforce Docs Portal

Waterfall Download (POST)

Retrieves pricing waterfall data for multiple line items in a single request.

Resource

/connect/core-pricing/waterfalls/retrieve

Available Version

67.0

HTTP Methods

POST

Query Parameters for POST

Parameter Name Type Description Required or Optional
water​fall​View String

Controls how much detail is returned for each line item. Valid values are:

  • lsc-summary: Runs a server-side optimization that removes elements that don't affect the net unit price, such as proration, formula pricing, zero-value adjustments, and hidden elements.

If this parameter isn't specified, the API returns the complete waterfall from PricingWaterfallLog.

 Optional

JSON example

{
  "lineItems": [
    {
      "lineItemId": "0Q0fj0000005csfCAA",
      "executionId": "6719855753007"
    },
    {
      "lineItemId": "0Q0fj0000005csfCAB",
      "executionId": "6719855753008"
    }
  ]
}

Properties

Property Name Type Description Required
lineItems List<Object> A list of line item and execution ID pairs used to retrieve pricing waterfall data. Required
lineItemId String The Salesforce ID of the line item for which to fetch the pricing waterfall. This property is a child of each object in lineItems. Required
executionId String The execution key that identifies which pricing run’s waterfall to fetch. A line item can have multiple pricing executions over time. This property is a child of each object in lineItems. Required

Response Body for POST

Waterfall Download Output