Connect REST API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Order Summaries, Submit Return
Return one or more OrderItemSummaries from an OrderSummary, and
create a corresponding change order. This return is a simple return that creates a change
order but not a ReturnOrder.
- Resource
-
/commerce/order-management/order-summaries/orderSummaryId/actions/submit-return - 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 Submit Return 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 Submit Return Output, and the value of the enhancedErrorType property can be ignored.
- Usage
- After submitting a return, process a refund. Pass the changeOrderId from the response body to the Order Summaries, Create Credit Memo resource, then pass the CreditMemo to the Order Summaries, Ensure Refunds Async resource.