Skip to main content
POST
Request Return

Authorizations

Authorization
string
header
required

API Key. Example: sk_live_xxxxx or pk_live_xxxxx

X-Customer-Token
string
header
required

Storefront customer authentication token. Issued via POST /admin/customers/{id}/token. Required for accessing /storefront/customers/, /storefront/orders/.

Path Parameters

id
string
required

Resource ID

Body

application/json
return_type
enum<string>
required
Available options:
refund,
exchange
lines
object[]
required
reason
string
reason_category
enum<string>
Available options:
defective,
wrong_item,
changed_mind,
damaged,
other
customer_notes
string

Response

201 - application/json

Created

id
string
order_id
string
customer_id
string
return_type
enum<string>
Available options:
refund,
exchange
status
enum<string>
Available options:
requested,
approved,
rejected,
received,
completed,
cancelled
reason
string
reason_category
enum<string>
Available options:
defective,
wrong_item,
changed_mind,
damaged,
other
customer_notes
string
admin_notes
string
lines
object[]
refund
object
created_at
string<date-time>
updated_at
string<date-time>