The createReturn
actor-chain initiates a return request specific to the order ID passed in and sets the Commerce Service Center environment settings, such as price lists. Note that this actor-chain calls the StartReturnExchangeProcess
form handler. The external createReturn
actor-chain uses the ReturnFormHandler
. For information on the external createReturn
actor-chain, refer to the Initiating a Return section. Subsequent Return REST calls use this return request for the order specific return details. It contains the following parameters:
Parameter | Description |
---|---|
| The ID of the order to be returned. |
Initiate Returns and Exchanges Example
curl -L -v -b agent_cookies.txt -H "Content-Type: application/json" -d "{\"newOrderId\":\"xco30045\"}" "http://localhost:8181/rest/model/atg/commerce/ custsvc/returns/CSRReturnsActor/createReturn"
The server response may be similar to the following:
{ "returnRequest":{ "shippingGroupList":[ { "shippingPriceRaw":18.95, "shippingMethod":"Next Day", "shippingGroupId":"xcsg20080", "itemList":[ { "returnItemId":"xcr10101", "quantityShipped":1, "quantityReturned":0, "quantityAvailable":1, "description":"Boyfriend Jeans", "commerceItemId":"xci1000051", "catalogRefId":"xsku2519_2" }, { "returnItemId":"xcr10102", "quantityShipped":1, "quantityReturned":0, "quantityAvailable":1, "description":"Corduroy Cargo Pants", "commerceItemId":"xci1000052", "catalogRefId":"xsku2512_2" }, { "returnItemId":"xcr10103", "quantityShipped":1, "quantityReturned":0, "quantityAvailable":1, "description":"Huey Martini Glass", "commerceItemId":"xci1000053", "catalogRefId":"xsku2076" } ], "shippingAddress":{ "lastName":"Robinson", "state":"NY", "address1":"604 Red Mountain Road", "address2":null, "country":"US", "city":"Rochester", "postalCode":"14603", "phoneNumber":"212-555-8885", "email":null, "firstName":"Adrian" } } ], "orderCurrencyCode":"USD", "orderId":"xco30045" } }