GET
/
v1
/
orders
/
{sourceOrderId}
curl --request GET \
  --url https://api.production.orderprotection.com/v1/orders/{sourceOrderId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "asdasdfasdfasdfasdf",
  "fulfillments": [
    {
      "id": "12345",
      "sourceOrderId": "12345",
      "fulfillmentStatus": "shipped",
      "trackingCompany": "ups",
      "trackingNumber": "12345",
      "sourceItemIds": [
        {
          "id": "12345",
          "quantity": 1
        }
      ]
    }
  ],
  "sourceOrderId": "12345",
  "originalSourceOrderId": "12345",
  "originalOrderId": "12345",
  "sourceOrderNumber": "#12345",
  "sourceCreatedAt": "2000-05-15T21:00:00.000Z",
  "sourceUpdatedAt": "2025-03-13T21:20:08.238Z",
  "sourceCancelledAt": "2025-03-13T21:20:08.239Z",
  "policyCancelledAt": "2025-03-13T21:20:08.239Z",
  "platformId": "api",
  "premiumPaid": "2025-03-13T21:20:08.239Z",
  "premiumCost": "2025-03-13T21:20:08.239Z",
  "currency": "USD",
  "orderItems": [
    {
      "id": "clv5u1ix00002pheol047kwrv",
      "orderId": "clv5u1ix00000pheoqpxke986",
      "productName": "Handcrafted Wooden Table",
      "productUrl": "https://bogus-clarity.name/",
      "productImage": "https://picsum.photos/seed/orderprotection1/200/300",
      "itemDescription": null,
      "sku": "978-0-10-081434-9",
      "selectedOptions": [],
      "quantity": 20,
      "price": 31.5,
      "discount": 0,
      "tax": 0,
      "sourceItemId": "387179",
      "sourceProductId": "477353",
      "sourceVariantId": "17742",
      "addressId": null,
      "createdAt": "2024-04-18T22:48:08.964Z",
      "updatedAt": "2024-04-18T22:48:08.964Z",
      "refundedQuantity": 0
    },
    {
      "id": "clv5u1ix00003pheom3edzt29",
      "orderId": "clv5u1ix00000pheoqpxke986",
      "productName": "Crazy T-Shirt",
      "selectedOptions": [],
      "productUrl": "https://test.site/",
      "productImage": "https://picsum.photos/seed/orderprotection2/200/300",
      "itemDescription": null,
      "sku": "5555",
      "quantity": 3,
      "price": 32.2,
      "discount": 0,
      "tax": 0,
      "sourceItemId": "387180",
      "sourceProductId": "477353",
      "sourceVariantId": "17742",
      "addressId": null,
      "createdAt": "2024-04-18T22:48:08.964Z",
      "updatedAt": "2024-04-18T22:48:08.964Z",
      "refundedQuantity": 0
    }
  ],
  "total": 12.55,
  "discountTotal": 2.55,
  "shippingCost": 7.55,
  "shippingCostTax": 1.44,
  "tax": 1.44,
  "subtotal": 1200,
  "customerEmail": "customer@email.com",
  "customerName": "John Doe",
  "customerPhone": "(801) 555-5555",
  "exchangeRate": 1,
  "storeId": "test",
  "policyId": "asdadsasdad",
  "eligibleForOta": false,
  "createdAt": "2025-03-13T21:20:08.239Z",
  "activities": [
    {
      "message": "Order created",
      "orderId": "asdasd"
    }
  ],
  "updatedAt": "2025-03-13T21:20:08.239Z",
  "deletedAt": "2025-03-13T21:20:08.239Z"
}

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

200
application/json
id
string
required
Example:

"asdasdfasdfasdfasdf"

fulfillments
string[]
required
Example:
[
  {
    "id": "12345",
    "sourceOrderId": "12345",
    "fulfillmentStatus": "shipped",
    "trackingCompany": "ups",
    "trackingNumber": "12345",
    "sourceItemIds": [{ "id": "12345", "quantity": 1 }]
  }
]
sourceOrderId
string
required
Example:

"12345"

originalSourceOrderId
string
required
Example:

"12345"

originalOrderId
string
required
Example:

"12345"

sourceOrderNumber
string
required
Example:

"#12345"

sourceCreatedAt
string
required
Example:

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

sourceUpdatedAt
string
required
Example:

"2025-03-13T21:20:08.238Z"

sourceCancelledAt
string
required
Example:

"2025-03-13T21:20:08.239Z"

policyCancelledAt
string
required
Example:

"2025-03-13T21:20:08.239Z"

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

"api"

premiumPaid
number
required
Example:

"2025-03-13T21:20:08.239Z"

premiumCost
number
required
Example:

"2025-03-13T21:20:08.239Z"

currency
enum<string>
required
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
Example:
[
  {
    "id": "clv5u1ix00002pheol047kwrv",
    "orderId": "clv5u1ix00000pheoqpxke986",
    "productName": "Handcrafted Wooden Table",
    "productUrl": "https://bogus-clarity.name/",
    "productImage": "https://picsum.photos/seed/orderprotection1/200/300",
    "itemDescription": null,
    "sku": "978-0-10-081434-9",
    "selectedOptions": [],
    "quantity": 20,
    "price": 31.5,
    "discount": 0,
    "tax": 0,
    "sourceItemId": "387179",
    "sourceProductId": "477353",
    "sourceVariantId": "17742",
    "addressId": null,
    "createdAt": "2024-04-18T22:48:08.964Z",
    "updatedAt": "2024-04-18T22:48:08.964Z",
    "refundedQuantity": 0
  },
  {
    "id": "clv5u1ix00003pheom3edzt29",
    "orderId": "clv5u1ix00000pheoqpxke986",
    "productName": "Crazy T-Shirt",
    "selectedOptions": [],
    "productUrl": "https://test.site/",
    "productImage": "https://picsum.photos/seed/orderprotection2/200/300",
    "itemDescription": null,
    "sku": "5555",
    "quantity": 3,
    "price": 32.2,
    "discount": 0,
    "tax": 0,
    "sourceItemId": "387180",
    "sourceProductId": "477353",
    "sourceVariantId": "17742",
    "addressId": null,
    "createdAt": "2024-04-18T22:48:08.964Z",
    "updatedAt": "2024-04-18T22:48:08.964Z",
    "refundedQuantity": 0
  }
]
total
number
required
Example:

12.55

discountTotal
number
required
Example:

2.55

shippingCost
number
required
Example:

7.55

shippingCostTax
number
required
Example:

1.44

tax
number
required
Example:

1.44

subtotal
number
required
Example:

1200

customerEmail
string
required
Example:

"customer@email.com"

customerName
string
required
Example:

"John Doe"

customerPhone
string
required
Example:

"(801) 555-5555"

exchangeRate
number
required
Example:

1

storeId
string
required
Example:

"test"

policyId
string
required
Example:

"asdadsasdad"

eligibleForOta
boolean
required
Example:

false

createdAt
string
required
Example:

"2025-03-13T21:20:08.239Z"

activities
string[]
required
Example:
[
  {
    "message": "Order created",
    "orderId": "asdasd"
  }
]
updatedAt
string
required
Example:

"2025-03-13T21:20:08.239Z"

deletedAt
string
required
Example:

"2025-03-13T21:20:08.239Z"