Order Details Schema

Object representing a single successful e-commerce order with details about it's items, payment, shipping, price, etc.

Schema Reference

PropertyDetails
customerId string
Subscribe Pro Customer ID
customerEmail string
Customer Email
platformCustomerId string
eCommerce Platform Customer ID
platformOrderId string
eCommerce Platform Order ID
orderNumber (required)string
Order Number
Unique alpha-numeric order number that identifies this order.
salesOrderToken string
Sales Order Token
Return the Subscribe Pro order token when passing order details. This is a unique token which was provided by Subscribe Pro when placing an order.
orderStatus (required)string
Order Status
orderState string
Order State
orderDateTime (required)string
Order Date / Time
Date / time when the order was placed.
Example: "2021-04-01T17:43:00Z"
currency string
Currency Code
3 Digit ISO Currency Code
discountTotal string
Discount Total
Discount total for the order.
Example: "2.0000"
shippingTotal string
Shipping Total
Shipping total for the order.
Example: "1.6000"
taxTotal string
Tax Total
Tax total for the order.
Example: "0.6000"
total (required)string
Order Total
Grand total for the order (include shipping, tax and discount).
Example: "30.8000"
billingAddress (required)object
Billing Address
Customer's billing address associated with the order.
billingAddress.firstName (required)string
First Name
billingAddress.lastName (required)string
Last Name
billingAddress.company string
Company
Company name associated with the address
billingAddress.street1 string
Street Address Line 1
billingAddress.street2 string
Street Address Line 2
billingAddress.street3 string
Street Address Line 3
billingAddress.city string
City
billingAddress.region string
Region
Region, state or province
billingAddress.postcode string
Postcode
billingAddress.country string
Country
Country name, code or abbreviation
billingAddress.countryName string
Country Name
billingAddress.phone string
Phone
The phone number associated with the address.
shippingAddress object
Shipping Address
Customer's shipping address associated with the order.
shippingAddress.firstName string
First Name
shippingAddress.lastName string
Last Name
shippingAddress.company string
Company
Company name associated with the address
shippingAddress.street1 string
Street Address Line 1
shippingAddress.street2 string
Street Address Line 2
shippingAddress.street3 string
Street Address Line 3
shippingAddress.city string
City
shippingAddress.region string
Region
Region, state or province
shippingAddress.postcode string
Postcode
shippingAddress.country string
Country
Country name, code or abbreviation
shippingAddress.countryName string
Country Name
shippingAddress.phone string
Phone
The phone number associated with the address.
items (required)array
Items
Array of order line items for this order.
items[].platformOrderItemId (required)string
eCommerce Platform Order Item Id
items[].productSku (required)string
Product SKU
items[].productName string
Product Name
items[].shortDescription string
Line Item Short Description
items[].qty (required)string
Quantity
Quantity for the line item.
Example: "2.00"
items[].unitPrice string
Unit Price
Unit price for the line item.
Example: "1.6000"
items[].discountTotal string
Discount Total
Discount total for the line item.
Example: "0.6000"
items[].shippingTotal string
Shipping Total
Shipping total for the line item.
Example: "1.2000"
items[].lineTotal (required)string
Line Total
Line total for the line item (include shipping and discount).
Example: "3.2000"
items[].requiresShipping boolean
Requires Shipping
Does this line item require shipping to the customer?
items[].subscriptionId string
Subscription ID
Subscribe Pro subscription ID of the subscription item which is associated with this line item.