Create order

POST

orders

curl --request POST \
  --url https://api.production.orderprotection.com/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sourceOrderId": "#517AB",
  "originalSourceOrderNumber": "12345",
  "sourceOrderNumber": "#634C",
  "sourceCreatedAt": "2000-05-15T21:00:00.000Z",
  "sourceUpdatedAt": "2000-05-15T21:00:00.000Z",
  "sourceCancelledAt": "2000-05-15T21:00:00.000Z",
  "platformId": "api",
  "premiumPaid": 1.5,
  "premiumCost": 1,
  "premiumDiscount": 1,
  "riskLevel": "low",
  "currency": "USD",
  "total": 15.4,
  "discountTotal": 1.2,
  "shippingCost": 3.5,
  "tax": 0.55,
  "subtotal": 11.3,
  "customerEmail": "john@doe.com",
  "customerName": "John",
  "customerPhone": "+1-555-796-3644",
  "shippingCostTax": 23.55,
  "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",
    "address2": "Apt. 796",
    "city": "Rippinfurt",
    "state": "AZ",
    "zip": "08731",
    "country": "PR"
  },
  "tags": "test,this,out"
}'

{
  "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"

sourceCreatedAt

string

required

Creation date of the order on your platform

Example:

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

platformId

enum<string>

required

Platform identifier

Available options:

shopify,

woocommerce,

magento,

bigcommerce,

api

Example:

"api"

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

orderItems

object[]

required

Array of product items

orderItems.productName

string

required

Product name

Example:

"Handcrafted Soft Mouse"

orderItems.productUrl

string

required

Product URL

Example:

"https://example.net/product/5"

orderItems.productImage

string

required

Product Image URL

Example:

"https://example.net/product/5/image.jpg"

orderItems.sku

string

required

Product sku

Example:

"978-0-279-23986-8"

orderItems.quantity

number

required

Product quantity

Example:

2

orderItems.price

number

required

Product price

Example:

1050

orderItems.discount

number

required

Product discount

Example:

1050

orderItems.tax

number

required

Product tax

Example:

1050

orderItems.sourceItemId

string

required

Product source item id

Example:

"396568"

orderItems.sourceProductId

string

required

Product source product id

Example:

"164073"

orderItems.sourceVariantId

string

required

Product source variant id

Example:

"449493"

orderItems.itemDescription

string

Product variant information to help determine which item was purchased

Example:

"Color: White. Size: 12"

orderItems.selectedOptions

object[]

Options associated with a variant. e.g. size, color

Example:

[{ "name": "Size", "value": "XS" }]

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

required

Shipping Address

Example:

{
  "firstName": "Milford",
  "lastName": "Mayert",
  "address1": "991 Nicolas Landing",
  "address2": "Apt. 796",
  "city": "Rippinfurt",
  "state": "AZ",
  "zip": "08731",
  "country": "PR"
}

originalSourceOrderNumber

string

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

Example:

"12345"

sourceOrderNumber

string

Order Number on your platform

Example:

"#634C"

sourceUpdatedAt

string

Updated date of the order on your platform

Example:

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

sourceCancelledAt

string

Cancellation date of the order on your platform

Example:

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

premiumPaid

number

Premium paid after discounts

Example:

1.5

premiumCost

number

Gross cost of revenue

Example:

1

premiumDiscount

number

Premium Discount

Example:

1

riskLevel

string

The fraud analysis level for an order

Example:

"low"

discountTotal

number

Order discount

Example:

1.2

shippingCost

number

Order shipping cost

Example:

3.5

tax

number

Order tax

Example:

0.55

customerEmail

string

Customer email

Example:

"john@doe.com"

customerName

string

Customer name

Example:

"John"

customerPhone

string

Customer phone number

Example:

"+1-555-796-3644"

shippingCostTax

number

Tax associated with shipping

Example:

23.55

Response

201

application/json

The order passes validation and has been successfully created.

status

string

required

Example:

"ok"

List Orders Get Fulfillment

curl --request POST \
  --url https://api.production.orderprotection.com/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sourceOrderId": "#517AB",
  "originalSourceOrderNumber": "12345",
  "sourceOrderNumber": "#634C",
  "sourceCreatedAt": "2000-05-15T21:00:00.000Z",
  "sourceUpdatedAt": "2000-05-15T21:00:00.000Z",
  "sourceCancelledAt": "2000-05-15T21:00:00.000Z",
  "platformId": "api",
  "premiumPaid": 1.5,
  "premiumCost": 1,
  "premiumDiscount": 1,
  "riskLevel": "low",
  "currency": "USD",
  "total": 15.4,
  "discountTotal": 1.2,
  "shippingCost": 3.5,
  "tax": 0.55,
  "subtotal": 11.3,
  "customerEmail": "john@doe.com",
  "customerName": "John",
  "customerPhone": "+1-555-796-3644",
  "shippingCostTax": 23.55,
  "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",
    "address2": "Apt. 796",
    "city": "Rippinfurt",
    "state": "AZ",
    "zip": "08731",
    "country": "PR"
  },
  "tags": "test,this,out"
}'

{
  "status": "ok"
}

API Documentation

Orders

Fulfillments

Claims

Products

Quote

Tests

Authorizations

Body

Response