Return Orders

Create a ReturnOrder and ReturnOrderLineItems for items belonging to an OrderSummary.

Resource

1/commerce/returns/return-orders

Available version

50.0

HTTP methods

POST

Request body for POST

Return Order Input

Root XML tag

<returnOrderInput>

JSON example

1{
2  "orderSummaryId": "1Osxx0000004EAqCAM",
3  "status" : "Submitted",
4  "returnOrderLifeCycleType" : "Unmanaged",
5  "returnOrderLineItems": [
6    {
7      "quantityExpected": "1",
8      "reasonForReturn": "Not Satisfied",
9      "canReduceShipping": false,
10      "orderItemSummaryId": "10uxx0000004GKbAAM",
11      "quantityReceived": "0"
12    }
13  ]
14}

Properties

Name	Type	Description	Required or Optional	Available Version
`orderSummaryId`	String	ID of the OrderSummary containing the items to be returned. The OrderSummary’s OrderLifeCycleType must be Managed.	Required	50.0
`returnOrderLifeCycleType`	String	The LifeCycleType of the ReturnOrder. Possible values are: Managed—Process the ReturnOrder using the APIs and actions. It can generate change orders and affects financial fields and rollup calculations. Unmanaged—The ReturnOrder is for tracking purposes only. It isn’t involved in any financial calculations and doesn’t generate any change orders. The system doesn’t prevent the creation of duplicate ReturnOrderLineItems in an unmanaged ReturnOrder for the same OrderItem.	Required	51.0
`returnOrderLineItems`	Return Order Line Item Input[]	List of data for creating ReturnOrderLineItems.	At least one element is required	50.0
`status`	String	Status to assign the ReturnOrder. This value must match an entry in the ReturnOrder object’s Status picklist.	Required	50.0

Response body for POST

Return Order Output

Connect REST API Developer Guide

Return Orders