Skip to main content
POST
Open a return

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Authorization
string
header
required

JWT token for authenticated customers

Headers

x-spree-api-key
string
required
Authorization
string

Bearer token for authenticated customers

x-spree-token
string

Order token for guest access

Path Parameters

order_id
string
required

Order prefixed ID

Body

application/json
items
object[]
required
reason_id
string

One of the store's return reasons.

memo
string

Response

201 - application/json

return opened

id
string
required
number
string
required
status
required

The values listed are the built-in ones; extensions may add more.

Available options:
requested,
approved,
received,
refunded,
canceled
order_id
string | null
required
reason_id
string | null
required
refund_total
string | null
required
display_refund_total
string | null
required
deprecated

refund_total formatted with its currency symbol in the request's language.

refund_tax_total
string | null
required
display_refund_tax_total
string | null
required
deprecated

refund_tax_total formatted with its currency symbol in the request's language.

approved_at
string | null
required
received_at
string | null
required
refunded_at
string | null
required
canceled_at
string | null
required
reason
object
return_line_items
object[]