Supplemental Transaction Input

Input representation of the details of the request to create a supplemental order.

JSON Example

This sample creates a supplemental order, which is a clone of the original order. The supplemental order is related to the original order.

1{
2  "relatedSalesTransactionId": "801S70000001VKgIAM"
3}

This sample overrides a field value of an order line item to supplement the order item with ID value as 802SG000003vZ15YAE.

1{
2    "relatedSalesTransactionId": "801S70000001VKgIAM",
3    "pricingPref": "System",
4    "supplementalGraph": {
5        "graphId": "1",
6        "records": [
7            {
8                "referenceId": "refOrder",
9                "record": {
10                    "attributes": {
11                        "type": "Order",
12                        "method": "PATCH",
13                        "id": "801S70000001VKgIAM"
14                    },
15                    "EffectiveDate": "2025-03-01",
16                    "QuoteId": "0Q0xx0000004DQ4CAM"
17                }
18            },
19            {
20                "referenceId": "refOrderItem",
21                "record": {
22                    "attributes": {
23                        "type": "OrderItem",
24                        "method": "PATCH",
25                        "id": "802SG000003vZ15YAE"
26                    },
27                    "QuoteLineItemId": "0Q0xx0000004E2mYLK"
28                }
29            }
30        ]
31    }
32}

Properties

Name	Type	Description	Required or Optional	Available Version
`pricingPref`	String	Pricing preference for this supplemental transaction or order ingestion process. If `pricingPref` value is defined as either `Force` or `System`, the supplemental order can have a different pricing from the original order.	Optional	64.0
`relatedSalesTransactionId`	String	Related or the original sales transaction upon which a supplemental transaction is created.	Required	64.0
`supplementalGraph`	Object Graph Input	The sObject graph that represents a payload with the additional changes to be ingested. The attribute’s HTTP method must be PATCH. The attribute ID must be the ID of the original order or order item that you want to supplement.	Optional	64.0

Valid values are:

Force—Enforces pricing during the creation of sales transactions.
Skip—Skips pricing during the creation of sales transactions.
System—Determines whether a pricing calculation is required.