Order Summaries, Preview Cancel

Retrieve the expected change order values for canceling one or more OrderItemSummaries from an OrderSummary, without actually executing the cancel.
Resource
/commerce/order-management/order-summaries/orderSummaryId/actions/preview-cancel
Available version
48.0
HTTP methods
POST
Request body for POST
Change Input
Root XML tag
<changeInput>
JSON example
{
  "changeItems": [
    {
      "orderItemSummaryId": "10uxx0000004FYDAA2",
      "quantity": 1.0,
      "reason": "Wrong Item",
      "shippingReductionFlag": true
    }
  ]
}
Properties
Name Type Description Required or Optional Available Version
changeItems Change Item Input[] List of changes to OrderItemSummaries. Required 48.0
Response body for POST
  • When the HTTP status code indicates success, the response body is a Preview Cancel Output. The response body can still indicate processing errors.
  • When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The output property is a Preview Cancel Output, and the value of the enhancedErrorType property can be ignored.