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

Fee prefixed ID

Body

application/json
label
string
Example:

"Gift wrap"

amount
string<decimal>
Pattern: ^-?\d+(\.\d+)?$
Example:

"4.00"

kind

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

Available options:
surcharge,
handling,
gift_wrap,
cod,
payment,
duty,
exchange
Example:

"gift_wrap"

Response

200 - application/json

fee updated

id
string
required
label
string
required
kind
required

What sort of charge this is. duty is a customs duty on a cross-border order and is not taxed; the other kinds are. Extensions may register further kinds.

Available options:
surcharge,
handling,
gift_wrap,
cod,
payment,
duty,
exchange
line_item_id
string | null
required
fulfillment_id
string | null
required
amount
string
required
metadata
object | null
required
created_at
string
required
updated_at
string
required