Create return

Creates a return for the order you are currently logged in.
Given the asynchronous nature of the operations performed by this endpoint,
after a successful execution, make a new call to get return to have refreshed information about it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
Body Params
items
array of objects
required

Array of objects with the information of the items to be returned.

items*
string
required

The external identifier of the shipping method used for this return.

string

The identifier of the marketplace where the return is made.

string
required

The identifier of the shipping method used for this return.

string
enum
required

The type of the shipping method used for this return.

Allowed:
boolean
required

If true, the return will be processed as an instant exchange.

string
enum
required

The payment method the customer wants to use for the refund of this return (if there is any).

Allowed:
desiredPickUp
object

This information represents the date and a time interval the customer chooses to make the pick up.
Only accepted when shippingType is PickUp.
If the return is a pick up, this information cannot be empty.
If the return is not a pick up, this information must be empty.

boolean
required

Whether the customer accepts the terms and conditions. It is mandatory and must be true; the request is rejected otherwise.

Responses

400

Bad request.

401

Unauthorized.

403

No longer accepted.

404

Not Found.

405

Order blocked. Try again in a few minutes.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json