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

Bearer token for admin authentication

Path Parameters

order_id
string
required

Order ID

id
string
required

Fulfillment ID

Body

application/json
items
object[]

Line item quantities to ship. Omit to ship everything the fulfillment holds; a subset is split onto a new fulfillment, which is the one that ships.

tracking
string

Carrier tracking number or a full https:// tracking link, stored on the fulfillment that ships.

tracking_carrier
string

Which carrier the number belongs to; detected from the number when omitted.

notify_customer
boolean

Whether the customer gets the shipment email. Defaults to true; pass false to suppress it for this dispatch only.

force
boolean

Hand the goods over even though the order is unpaid or holds backordered units.

Response

200 - application/json

fulfillment fulfilled