Sales Order Object

Sales Order

PropertyDescription
sales_order_idstring
external_order_idstring
This is the Order ID we received from the order source.
external_order_numberstring
This is the Order ID we received from the order source.
order_sourceOrder Source
The order source associated with the sales order.
sales_order_statusSales Order Status
The reported status from the order source, via the last refresh.
order_datedate string, (ISO 8601 Standard)
2019-07-25T15:24:46.657Z
When the SalesOrder was originally created/received by the order source. This is not to be confused with created_at.
created_atdate string, (ISO 8601 Standard)
2019-07-25T15:24:46.657Z
When the SalesOrder was created originally in our system. This is not to be confused with order_date.
modified_atdate string, (ISO 8601 Standard)
2019-07-25T15:24:46.657Z
When the SalesOrder was modified last in our system.
payment_detailsPayment Details
Summary of the totals for the SalesOrder as a whole.
customerCustomer
The customer for the sales order.
bill_toBill To
The billing information for the sales order.
ship_toAddress
The shipping address for the sales order.
sales_order_itemsArray of Sales Order Item
The line items associated with the order.

Order Source

PropertyDescription
order_source_idstring
order_source_nicknamestring
Nickname you assign to the order source when connecting, e.g. "My Amazon Store".
order_source_codestring
The API code used to identify the type of order source, e.g. "amazon_ca"
order_source_friendly_namestring
The human-readable name for the order source, e.g. "Amazon CA" instead of "amazon_ca"
refresh_infoRefreshInfo
activebool
Whether or not your order source is currently activated or deactivated

Refresh Info

PropertyDescription
statusenumerated string, idle, preparing_update, updating, error, unknown
last_refresh_attemptdate string, (ISO 8601 Standard)
2019-07-25T15:24:46.657Z
refresh_datedate string, (ISO 8601 Standard)
2019-07-25T15:24:46.657Z

Sales Order Item

PropertyDescription
sales_order_item_idstring (not a GUID)
line_item_detailsLineItemDetails
ship_toAddress
requested_shipping_optionsRequestedShippingOptions
price_summaryPriceSummary
quantityint
is_giftbool

Sales Order Status

PropertyDescription
payment_statusenumerated string, unknown, paid, unpaid, partially_paid
fulfillment_statusenumerated string, unknown, fulfilled, unfulfilled, partially_fulfilled, on_hold.
is_cancelledbool

Line Item Details

PropertyDescription
namestring
skustring
weightWeight

Requested Shipping Options

PropertyDescription
shipping_servicestring
ship_datedate string, (ISO 8601 Standard)
2019-07-25T15:24:46.657Z

Price Summary

This contains price information for this line item; taxes and shipping show what was quoted or charged for this item.

PropertyDescription
unit_priceCurrency
Individual price of the item.
estimated_taxCurrency
Taxes quoted or collected for the item.
estimated_shippingCurrency
Shipping amount quoted or collected for the item.
totalCurrency
Total collected for this line item, including taxes and shipping.

Payment Details

PropertyDescription
subtotalCurrency
The amount of the order without taxes or shipping costs.
estimated_shippingCurrency
Shipping amount quoted or collected for the item.
estimated_taxCurrency
Taxes quoted or collected for the item.
grand_totalCurrency
Amount charged for the entire sales order.

Customer

PropertyDescription
namestring
phonestring
emailstring

Bill To

BillTo repeats some of the properties that are in the Address model.

PropertyDescription
emailstring
addressAddress

Address

PropertyDescription
namestring
company_namestring
phonestring
address_line1string
address_line2string
address_line3string
city_localitystring
state_provincestring
postal_codestring
country_codestring

Weight

PropertyDescription
unitenumerated string, ounce, pound, gram
valuedecimal
Weight in the unit specified.

Currency

Currently, ShipEngine supports the following currencies: USD, CAD, AUD, GBP, and EUR.

PropertyDescription
amountdecimal
currencyenumerated string, usd, cad, aud, gbp, eur.