Skip to main content
POST
/
v1
/
orders
Create order
curl --request POST \
  --url https://api.production.orderprotection.com/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "sourceOrderId": "#517AB",
  "sourceOrderNumber": "#634C",
  "sourceCreatedAt": "2000-05-15T21:00:00.000Z",
  "currency": "USD",
  "total": 15.4,
  "subtotal": 11.3,
  "customerEmail": "[email protected]",
  "customerName": "John",
  "originalSourceOrderId": "12345",
  "sourceUpdatedAt": "2000-05-15T21:00:00.000Z",
  "sourceCancelledAt": "2000-05-15T21:00:00.000Z",
  "policyCancelledAt": "2024-03-20T12:00:00.000Z",
  "platformId": "api",
  "premiumPaid": 1.5,
  "premiumCost": 1,
  "premiumDiscount": 1,
  "discountTotal": 1.2,
  "customerIp": "123.123.123.123",
  "exchangeRate": 1.024,
  "shippingCost": 3.5,
  "tax": 0.55,
  "customerPhone": "+1-555-796-3644",
  "shippingCostTax": 234,
  "orderItems": [
    {
      "productName": "Handcrafted Wooden Table",
      "productUrl": "https://bogus-clarity.name/",
      "productImage": "https://bogus-clarity.name/product/image.jpg",
      "sku": "978-0-10-081434-9",
      "quantity": 4,
      "price": 45.43,
      "sourceItemId": "387179",
      "sourceProductId": "477353",
      "sourceVariantId": "17742",
      "description": "Variant: White Oak. Size: 10'x10'"
    },
    {
      "productName": "Another prod",
      "productUrl": "https://test.site/",
      "sku": "5555",
      "quantity": 4,
      "price": 45.43,
      "sourceItemId": "387180",
      "sourceProductId": "477353",
      "sourceVariantId": "17742",
      "description": "Variant: White Oak. Size: 10'x10'"
    }
  ],
  "address": [
    {
      "firstName": "Milford",
      "lastName": "Mayert",
      "address1": "991 Nicolas Landing",
      "city": "Rippinfurt",
      "state": "AZ",
      "zip": "08731",
      "country": "US",
      "type": "SHIPPING",
      "address2": "Apt. 796",
      "stateAbr": "AZ",
      "lat": 40.7128,
      "lng": -74.006
    }
  ]
}
EOF
{
  "status": "ok"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
sourceOrderId
string
required

Order ID on your platform

Example:

"#517AB"

​
sourceOrderNumber
string
required

Order Number on your platform

Example:

"#634C"

​
sourceCreatedAt
string<date-time>
required

Creation date of the order on your platform

Example:

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

​
currency
enum<string>
required

Order currency

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"

​
total
number
required

Order total

Example:

15.4

​
subtotal
number
required

Order subtotal

Example:

11.3

​
customerEmail
string
required

Customer email

Example:

"[email protected]"

​
customerName
string
required

Customer name

Example:

"John"

​
originalSourceOrderId
string

If this was a replacement for another Order, you can include the original order id here.

Example:

"12345"

​
sourceUpdatedAt
string<date-time> | null

Updated date of the order on your platform

Example:

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

​
sourceCancelledAt
string<date-time> | null

Cancellation date of the order on your platform

Example:

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

​
policyCancelledAt
string<date-time> | null

Date when the policy was cancelled

Example:

"2024-03-20T12:00:00.000Z"

​
platformId
enum<string>

Platform identifier

Available options:
shopify,
woocommerce,
magento,
bigcommerce,
api
Example:

"api"

​
premiumPaid
number

Premium paid after discounts

Example:

1.5

​
premiumCost
number

Gross cost of revenue

Example:

1

​
premiumDiscount
number

Premium Discount

Example:

1

​
discountTotal
number

Order discount

Example:

1.2

​
customerIp
string | null

Customer IP address

Example:

"123.123.123.123"

​
exchangeRate
number | null

This should only be set if the store currency is USD and the order currency is not USD

Example:

1.024

​
shippingCost
number

Order shipping cost

Example:

3.5

​
tax
number

Order tax

Example:

0.55

​
customerPhone
string

Customer phone number

Example:

"+1-555-796-3644"

​
shippingCostTax
number

Tax associated with shipping

Example:

234

​
orderItems
object[]

Array of product items

Example:
[
  {
    "productName": "Handcrafted Wooden Table",
    "productUrl": "https://bogus-clarity.name/",
    "productImage": "https://bogus-clarity.name/product/image.jpg",
    "sku": "978-0-10-081434-9",
    "quantity": 4,
    "price": 45.43,
    "sourceItemId": "387179",
    "sourceProductId": "477353",
    "sourceVariantId": "17742",
    "description": "Variant: White Oak. Size: 10'x10'"
  },
  {
    "productName": "Another prod",
    "productUrl": "https://test.site/",
    "sku": "5555",
    "quantity": 4,
    "price": 45.43,
    "sourceItemId": "387180",
    "sourceProductId": "477353",
    "sourceVariantId": "17742",
    "description": "Variant: White Oak. Size: 10'x10'"
  }
]
​
address
object[]

Shipping or Billing Address

Response

The order passes validation and has been successfully created.

​
status
string
required
Example:

"ok"