Create a Swap
POST
/store/swapsCreate a Swap for an Order. This will also create a return and associate it with the swap. If a return shipping option is specified, the return will automatically be fulfilled.
To complete the swap, you must use the Complete Cart API Route passing it the ID of the swap's cart.
An idempotency key will be generated if none is provided in the header Idempotency-Key
and added to
the response. If an error occurs during swap creation or the request is interrupted for any reason, the swap creation can be retried by passing the idempotency
key in the Idempotency-Key
header.
Request
Body Params application/json
No schema defined
Example
Not configured
Request samples
Responses
OK(200)
Client Error or Multiple Errors(400)
Not Found Error(404)
Invalid State Error(409)
Invalid Request Error(422)
Server Error(500)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
Example
Not configured
Last modified: a year ago