Change Order Summary Preview

Previews the requested changes to an order summary without submitting them. Use this action to review changes before submitting.

GET, HEAD, POST

Authorization: Bearer token

JSON

InputTypeDescription
changeOrderAdjustmentGroupSummariesInputCollectionA collection of order adjustment group summary changes to preview. Each record contains the details for one adjustment group change.
changeOrderDeliveryGroupSummariesInputCollectionA collection of order delivery group summary changes to preview. Each record contains the details for one delivery group change.
changeOrderItemAdjustmentLineSummariesInputCollectionA collection of order item adjustment line summary changes to preview. Each record contains the details for one adjustment line change.
changeOrderItemSummariesInputCollectionA collection of order item summary changes to preview. Each record contains the details for one item change.
changeOrderItemTaxLineItemSummariesInputCollectionA collection of order item tax line item summary changes to preview. Each record contains the details for one tax line item change.
changeOrderReferenceNumberStringThe reference number of the change order associated with the order summary.
changeReasonStringThe reason for the requested changes to the order.
orderSummaryObjectThe order summary record to preview changes for.
orderSummaryIdIDRequired. The ID of the order summary record to preview changes for.
OutputTypeDescription
previewChangeOrderSummaryOutputObjectThe preview result of the requested change order summary, including estimated impacts before submission.