Skip to main content
POST
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

Body

application/json
label
string
required
Example:

"Gift wrap"

amount
string<decimal>
required
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"

line_item_id
string | null

The line item or fulfillment the fee belongs to. Omitted, the fee is order-level.

fulfillment_id
string | null

The line item or fulfillment the fee belongs to. Omitted, the fee is order-level.

Response

fee created