Change Order Summary Preview
Previews the requested changes to an order summary without submitting them. Use this
action to review changes before submitting.
Resource
1/services/data/vXX.X/actions/standard/changeOrderSummaryPreviewHTTP Methods
GET, HEAD, POST
Authentication
Authorization: Bearer token
Format
JSON
Inputs
| Input | Type | Description |
|---|---|---|
| changeOrderAdjustmentGroupSummariesInput | Collection | A collection of order adjustment group summary changes to preview. Each record contains the details for one adjustment group change. |
| changeOrderDeliveryGroupSummariesInput | Collection | A collection of order delivery group summary changes to preview. Each record contains the details for one delivery group change. |
| changeOrderItemAdjustmentLineSummariesInput | Collection | A collection of order item adjustment line summary changes to preview. Each record contains the details for one adjustment line change. |
| changeOrderItemSummariesInput | Collection | A collection of order item summary changes to preview. Each record contains the details for one item change. |
| changeOrderItemTaxLineItemSummariesInput | Collection | A collection of order item tax line item summary changes to preview. Each record contains the details for one tax line item change. |
| changeOrderReferenceNumber | String | The reference number of the change order associated with the order summary. |
| changeReason | String | The reason for the requested changes to the order. |
| orderSummary | Object | The order summary record to preview changes for. |
| orderSummaryId | ID | Required. The ID of the order summary record to preview changes for. |
Outputs
| Output | Type | Description |
|---|---|---|
| previewChangeOrderSummaryOutput | Object | The preview result of the requested change order summary, including estimated impacts before submission. |