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

Bearer token for admin authentication

Path Parameters

id
string
required

Order ID

Response

200 - application/json

digital links resent

id
string
required
market_id
string | null
required
withdrawal_period_ends_at
string | null
required
within_withdrawal_period
boolean
required
shipping_eq_billing_address
boolean
required
cart_id
string | null
required
channel_id
string | null
required
company_id
string | null
required
company_name
string | null
required
po_document_filename
string | null
required
po_document_byte_size
number | null
required
number
string
required
email
string
required
customer_note
string | null
required
po_number
string | null
required
currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BYR,
BZD,
CAD,
CDF,
CHF,
CLF,
CLP,
CNY,
COP,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EEK,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LVL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MRU,
MTL,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SKK,
SLE,
SLL,
SOS,
SRD,
SSP,
STD,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMM,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYI,
UYU,
UYW,
UZS,
VED,
VEF,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XCG,
XOF,
XPF,
YER,
ZAR,
ZMK,
ZMW,
ZWD,
ZWG,
ZWL,
ZWN,
ZWR
locale
enum<string> | null
required
Available options:
aa,
ab,
ae,
af,
ak,
am,
an,
ar,
as,
av,
ay,
az,
ba,
be,
bg,
bh,
bi,
bm,
bn,
bo,
br,
bs,
ca,
ce,
ch,
co,
cr,
cs,
cu,
cv,
cy,
da,
de,
de-AT,
de-CH,
dv,
dz,
ee,
el,
en,
en-AU,
en-CA,
en-GB,
en-IN,
en-NZ,
en-US,
eo,
es,
es-419,
es-CL,
es-EC,
es-MX,
et,
eu,
fa,
ff,
fi,
fj,
fo,
fr,
fr-CA,
fy,
ga,
gd,
gl,
gn,
gu,
gv,
ha,
he,
hi,
ho,
hr,
ht,
hu,
hy,
hz,
ia,
id,
ie,
ig,
ii,
ik,
io,
is,
it,
iu,
ja,
jv,
ka,
kg,
ki,
kj,
kk,
kl,
km,
kn,
ko,
kr,
ks,
ku,
kv,
kw,
ky,
la,
lb,
lg,
li,
ln,
lo,
lt,
lu,
lv,
mg,
mh,
mi,
mk,
ml,
mn,
mr,
ms,
mt,
my,
na,
nb,
nd,
ne,
ng,
nl,
nn,
no,
nr,
nv,
ny,
oc,
oj,
om,
or,
os,
pa,
pi,
pl,
ps,
pt,
pt-BR,
pt-PT,
qu,
rm,
rn,
ro,
ru,
rw,
sa,
sc,
sd,
se,
sg,
si,
sk,
sl,
sl-SI,
sm,
sn,
so,
sq,
sr,
ss,
st,
su,
sv,
sw,
ta,
te,
tg,
th,
ti,
tk,
tl,
tn,
to,
tr,
ts,
tt,
tw,
ty,
ug,
uk,
ur,
uz,
ve,
vi,
vo,
wa,
wo,
xh,
yi,
yo,
za,
zh-CN,
zh-HK,
zh-TW,
zu
total_quantity
number
required
coupon_code
string | null
required
fulfillment_status
enum<string> | null
required
Available options:
backorder,
canceled,
partial,
unfulfilled,
fulfilled,
delivered,
pending,
ready,
shipped
payment_status
enum<string> | null
required
Available options:
none,
authorized,
partially_paid,
paid,
partially_refunded,
refunded,
overcharged,
voided
completed_at
string | null
required
item_total
string
required

The line items: each price times its quantity, before discounts, fees and delivery.

discount_total
string
required

What promotions take off, as a negative amount. Manual discounts are not included.

tax_total
string
required

All tax, both included in prices and added on top.

included_tax_total
string
required

Tax already included in the prices, as in a store whose prices are tax-inclusive.

additional_tax_total
string
required

Tax added on top of the prices.

delivery_total
string
required

What delivery costs, before delivery discounts.

fee_total
string
required

Every fee charged, such as handling or a customs duty.

gift_card_total
string
required

What a gift card pays.

store_credit_total
string
required

What store credit pays, apart from gift cards.

total
string
required

What the customer pays in all: items, delivery, fees and added tax, less discounts.

amount_due
string
required

What is left to pay after payments and store credit.

covered_by_store_credit
boolean
required
adjustment_total
string
required

Every discount, fee and added tax together, as one amount.

gift_card
object | null
required
market
object | null
required
external_references
object
required
status
enum<string>
required
Available options:
draft,
placed,
canceled
last_ip_address
string | null
required
considered_risky
boolean
required
confirmation_delivered
boolean
required
store_owner_notification_delivered
boolean | null
required
metadata
object
required
cancel_note
string | null
required
canceled_at
string | null
required
approved_at
string | null
required
created_at
string
required
updated_at
string
required
payment_total
string
required
commission_amount_total
string
required
commission_tax_total
string
required
commission_total
string
required
preferred_stock_location_id
string | null
required
po_document_url
string | null
required
seller_id
string | null
required
order_group_id
string | null
required
tags
string[]
required
internal_note
string | null
required
internal_note_html
string | null
required
approver_id
string | null
required
approver_type
required

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

Available options:
admin_user,
api_key
canceler_id
string | null
required
canceler_type
required

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

Available options:
admin_user,
api_key
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
cancel_reason_id
string | null
required
cancel_reason_name
string | null
required
customer_id
string | null
required
freight_summary
object | null
required
payments
object[]
items
object[]
fulfillments
object[]
billing_address
object | null
shipping_address
object | null
custom_fields
object[]
seller
object
approver
object
canceler
object
created_by
object
applied_promotions
object[]
payment_splits
object[]
cart
object
channel
object
preferred_stock_location
object
payment_methods
object[]
customer
object
cancel_reason
object
returns
object[]
exchanges
object[]
claims
object[]