Connect REST API Developer Guide
jNewer Version Available
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
-
1/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
-
1{ 2 "changeItems": [ 3 { 4 "orderItemSummaryId": "10uxx0000004FYDAA2", 5 "quantity": 1.0, 6 "reason": "Wrong Item", 7 "shippingReductionFlag": true 8 } 9 ] 10} - 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.