Skip to main content
PATCH
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Path Parameters

order_id
string
required

Order prefixed ID

id
string
required

Return prefixed ID

Body

application/json
external_references
object

Identities the record has in external systems, keyed by system: the same { system: external_id } map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of { system, external_id } entries is accepted too.

stock_location_id
string

Where the goods come back to. Defaults to the location that shipped them.

reason_id
string

One of the store's return reasons.

memo
string
metadata
object

Response

200 - application/json

return updated

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
required
refund_tax_total
string
required
approved_at
string | null
required
received_at
string | null
required
refunded_at
string | null
required
canceled_at
string | null
required
external_references
object
required
memo
string | null
required
metadata
object
required
created_at
string
required
updated_at
string
required
stock_location_id
string | null
required
created_by_id
string | null
required
created_by_type
required

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

Available options:
admin_user,
api_key
refunded_total
string
required
refundable_total
string
required
documents
object[]
required
labels
object[]
required
deliveries
object[]
required
reason
object
return_line_items
object[]
created_by
object
order
object
stock_location
object
refunds
object[]