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

Claim prefixed ID

Body

application/json
resolution
enum<string>
required

Money back, a replacement shipment, or both.

Available options:
refund,
replacement,
refund_and_replacement
refund_method
enum<string>

Defaults to store_credit.

Available options:
original_payment,
store_credit
amount
string<decimal>

Defaults to the claim total.

Pattern: ^-?\d+(\.\d+)?$
replacement_line_item_ids
string[]

Which claim lines to send a replacement for. Omit to keep what the claim was opened with.

Response

claim resolved

id
string
required
number
string
required
status
required

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

Available options:
open,
approved,
resolved,
denied,
canceled
resolution
enum<string> | null
required
Available options:
refund,
replacement,
refund_and_replacement
order_id
string | null
required
reason_id
string | null
required
refund_total
string
required
approved_at
string | null
required
resolved_at
string | null
required
denied_at
string | null
required
canceled_at
string | null
required
memo
string | null
required
metadata
object
required
created_at
string
required
updated_at
string
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
reason
object
claim_line_items
object[]
created_by
object
order
object
refunds
object[]