Skip to main content
GET
Retrieve Order

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sourceOrderId
string
required

Response

id
string
required
read-only
Example:

"asdasdfasdfasdfasdf"

fulfillments
string[]
required
read-only
Example:
sourceOrderId
string
required
read-only
Example:

"12345"

sourceOrderNumber
string
required
read-only
Example:

"#12345"

sourceCreatedAt
string<date-time>
required
read-only
Example:

"2000-05-15T21:00:00.000Z"

sourceUpdatedAt
string<date-time>
required
read-only
Example:

"2024-05-28T20:05:55.338Z"

sourceCancelledAt
string<date-time> | null
required
Example:

"2024-05-28T20:05:55.339Z"

platformId
enum<string>
required
read-only
Available options:
shopify,
woocommerce,
magento,
bigcommerce,
api
Example:

"api"

premiumPaid
number
required
read-only
Example:

1.5

currency
enum<string>
required
read-only
Available options:
ADP,
AED,
AFA,
AFN,
ALK,
ALL,
AMD,
ANG,
AOA,
AOK,
AON,
AOR,
ARA,
ARP,
ARS,
ARY,
ATS,
AUD,
AWG,
AYM,
AZM,
AZN,
BAD,
BAM,
BBD,
BDT,
BEC,
BEF,
BEL,
BGJ,
BGK,
BGL,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BOP,
BOV,
BRB,
BRC,
BRE,
BRL,
BRN,
BRR,
BSD,
BTN,
BUK,
BWP,
BYB,
BYN,
BYR,
BZD,
CAD,
CDF,
CHC,
CHE,
CHF,
CHW,
CLF,
CLP,
CNY,
COP,
COU,
CRC,
CSD,
CSJ,
CSK,
CUC,
CUP,
CVE,
CYP,
CZK,
DDM,
DEM,
DJF,
DKK,
DOP,
DZD,
ECS,
ECV,
EEK,
EGP,
ERN,
ESA,
ESB,
ESP,
ETB,
EUR,
FIM,
FJD,
FKP,
FRF,
GBP,
GEK,
GEL,
GHC,
GHP,
GHS,
GIP,
GMD,
GNE,
GNF,
GNS,
GQE,
GRD,
GTQ,
GWE,
GWP,
GYD,
HKD,
HNL,
HRD,
HRK,
HTG,
HUF,
IDR,
IEP,
ILP,
ILR,
ILS,
INR,
IQD,
IRR,
ISJ,
ISK,
ITL,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAJ,
LAK,
LBP,
LKR,
LRD,
LSL,
LSM,
LTL,
LTT,
LUC,
LUF,
LUL,
LVL,
LVR,
LYD,
MAD,
MDL,
MGA,
MGF,
MKD,
MLF,
MMK,
MNT,
MOP,
MRO,
MRU,
MTL,
MTP,
MUR,
MVQ,
MVR,
MWK,
MXN,
MXP,
MXV,
MYR,
MZE,
MZM,
MZN,
NAD,
NGN,
NIC,
NIO,
NLG,
NOK,
NPR,
NZD,
OMR,
PAB,
PEH,
PEI,
PEN,
PES,
PGK,
PHP,
PKR,
PLN,
PLZ,
PTE,
PYG,
QAR,
RHD,
ROK,
ROL,
RON,
RSD,
RUB,
RUR,
RWF,
SAR,
SBD,
SCR,
SDD,
SDG,
SDP,
SEK,
SGD,
SHP,
SIT,
SKK,
SLL,
SOS,
SRD,
SRG,
SSP,
STD,
STN,
SUR,
SVC,
SYP,
SZL,
THB,
TJR,
TJS,
TMM,
TMT,
TND,
TOP,
TPE,
TRL,
TRY,
TTD,
TWD,
TZS,
UAH,
UAK,
UGS,
UGW,
UGX,
USD,
USN,
USS,
UYI,
UYN,
UYP,
UYU,
UYW,
UZS,
VEB,
VEF,
VES,
VNC,
VND,
VUV,
WST,
XAF,
XAG,
XAU,
XBA,
XBB,
XBC,
XBD,
XCD,
XDR,
XEU,
XFO,
XFU,
XOF,
XPD,
XPF,
XPT,
XRE,
XSU,
XTS,
XUA,
XXX,
YDD,
YER,
YUD,
YUM,
YUN,
ZAL,
ZAR,
ZMK,
ZMW,
ZRN,
ZRZ,
ZWC,
ZWD,
ZWL,
ZWN,
ZWR
Example:

"USD"

orderItems
string[]
required
read-only
Example:
total
number
required
read-only
Example:

12.55

discountTotal
number
required
read-only
Example:

2.55

shippingCost
number
required
read-only
Example:

7.55

shippingCostTax
number
required
read-only
Example:

1.44

tax
number
required
read-only
Example:

1.44

subtotal
number
required
read-only
Example:

1200

customerEmail
string
required
read-only
Example:

"customer@email.com"

customerName
string
required
read-only
Example:

"John Doe"

customerPhone
string<phone>
required
read-only
Example:

"(801) 555-5555"

exchangeRate
number
required
read-only
Example:

1

storeId
string
required
read-only
Example:

"test"

policyId
string
required
read-only
Example:

"asdadsasdad"

eligibleForOta
boolean
required
read-only
Example:

false

createdAt
string<date-time>
required
read-only
Example:

"2024-05-28T20:05:55.339Z"

activities
string[]
required
read-only
Example:
updatedAt
string<date-time>
required
read-only
Example:

"2024-05-28T20:05:55.339Z"

deletedAt
string<date-time>
required
read-only
Example:

"2024-05-28T20:05:55.339Z"