Update Ramp Deal (POST)

Modify a ramp deal in scenarios where a segment has updates such as quantity, discount, or date change.

Update a ramp deal in these scenarios.

A segment has quantity or discount changes.
A trial segment or custom segment has a date change. A custom segment is an added or deleted segment. In this scenario, you can update a ramp deal during the initial sale before assetization.

This API request returns the updated context with the context ID. You must call the Place Sales Transaction (POST) API by specifying this context ID to apply the ramp deal updates. See Place Sales Transaction (POST) API.

This API is applicable when you’re working with line ramps. To work with ramp deals for groups, you must use the Place Sales Transaction API and specify the groupRampActions property.

Resource

1/connect/revenue-management/sales-transaction-contexts/{resourceId}/actions/ramp-deal-update

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/revenue-management/sales-transaction-contexts/{4f23961a5c98806f89305e064c67b397e93f1bb8a2a7a3a80db506f1d4110ee9}/actions/ramp-deal-update

Available Version

62.0

HTTP Methods

POST

Path Parameter for POST

Name	Type	Description	Required or Optional	Available Version
`resourceId`	String	ID of the context data that’s used to build the pricing procedure. Get the context instance ID by invoking the Context Service API. See Context Service (POST).	Required	62.0

Request Body for POST

JSON Example

1{
2  "executionSettings": {
3       "executePricing": true,
4       "executeConfigRules": false
5  },
6  "addedNodes": [
7    {
8      "contextNodePath": [
9        "4f23961a5c98806f89305e064c67b397e93f1bb8a2a7a3a80db506f1d4110ee9", // Context ID
10        "0Q0xx0000004CPACA2", //Quote or Order ID
11        "RandomUUID" // random UUID for Quote Line Item or Order Item ID
12      ],
13      "contextNode": {
14         "Discount": 10,
15         "Quantity": 5,
16         "ItemSegmentName": "Year 5",
17         "StartDate":"2024-09-07T00:00:00.000Z",
18         "EndDate":"2024-09-07T00:00:00.000Z"
19      }
20    }
21  ],
22  "updatedNodes": [
23     {
24      "contextNodePath": [
25        "4f23961a5c98806f89305e064c67b397e93f1bb8a2a7a3a80db506f1d4110ee9", // Context ID
26        "0Q0xx0000004CPACA2", //Quote or Order ID
27        "0QLxx0000004CfIGAU" // Quote Line ID or Order Line ID to update
28      ],
29      "contextNode": {
30          "Discount": 10,
31          "Quantity": 5
32      }
33    } 
34  ],
35  "deletedNodes": [
36    {
37      "contextNodePath": [
38        "4f23961a5c98806f89305e064c67b397e93f1bb8a2a7a3a80db506f1d4110ee9",
39        "0Q0xx0000004CPACA2",
40        "0QLxx0000004CfIGAU" // Quote Line Item ID to delete
41      ]
42    }
43  ]
44}

Properties

Name	Type	Description	Required or Optional	Available Version
`addedNodes`	Context Node Input[]	Details of the nodes to be added.	Required	62.0
`deletedNodes`	Context Node Input[]	Details of the nodes to be deleted.	Required	62.0
`executionSettings`	Execution Settings Input[]	Settings to run the pricing or configuration rules.	Optional	62.0
`updatedNodes`	Context Node Input[]	Details of the nodes to be updated.	Required	62.0

Response Body for POST

Ramp Deal Service