Skip to main content
PATCH
Spree Seller SDK

Authorizations

Authorization
string
header
required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id
string
required

Path Parameters

order_id
string
required
id
string
required

Body

application/json
refund_method
enum<string>

Defaults to store_credit.

Available options:
original_payment,
store_credit

Response

200 - application/json

replacement sent

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,
fulfilled,
canceled
order_id
string | null
required
reason_id
string | null
required
price_difference
string
required
approved_at
string | null
required
received_at
string | null
required
fulfilled_at
string | null
required
canceled_at
string | null
required
memo
string | null
required
stock_location_id
string | null
required
reason
object
exchange_line_items
object[]