Return cart items

POST {{baseUrl}}/v2/customer_sessions/:customerSessionId/returns?dry=true

Create a new return request for the specified cart items.

This endpoint automatically changes the session state from closed to partially_returned.

Note: This will roll back any effects associated with these cart items. For more information, see our documentation on session states and this tutorial.

Request Params

KeyDatatypeRequiredDescription
drybooleanIndicates whether to persist the changes. Changes are ignored when dry=true.

Request Body

{"return"=>{"returnedCartItems"=>[{"position"=>2, "quantity"=>1}, {"position"=>2, "quantity"=>1}]}, "responseContent"=>["customerSession", "customerProfile"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring