Skip to main content
POST
Request a return or exchange

Authorizations

Authorization
string
header
required

API key as a bearer token. Secret keys (sk_) allow writes; publishable keys (pk_) are read-only. live = production, test = sandbox.

Body

application/json
order_id
string<uuid>
required
reason
enum<string>
required
Available options:
damaged_in_transit,
defective,
wrong_item,
not_as_described,
changed_mind,
other
customer_note
string
items
object[]

The line items being returned (partial returns supported).

Response

Return created.

return
object