Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Sales Order Object

The following sections list the properties available for the Sales Order object, along with their descriptions.

Sales Order

PropertyTypeDescription
sales_order_idstring
external_order_idstringThis is the Order ID we received from the order source.
external_order_numberstringThis is the Order ID we received from the order source.
order_sourceOrder SourceThe order source associated with the sales order.
sales_order_statusSales Order StatusThe reported status from the order source, via the last refresh.
order_datedate stringISO 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 stringISO 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 stringISO 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 ItemThe line items associated with the order.

Order Source

PropertyTypeDescription
order_source_idstring
order_source_nicknamestringNickname you assign to the order source when connecting, e.g. "My Amazon Store".
order_source_codestringThe API code used to identify the type of order source, e.g. "amazon_ca"
order_source_friendly_namestringThe human-readable name for the order source, e.g. "Amazon CA" instead of "amazon_ca"
refresh_infoRefreshInfo
activeboolWhether or not your order source is currently activated or deactivated

Refresh Info

PropertyTypeDescription
statusenumerated stringidle, preparing_update, updating, error, unknown
last_refresh_attemptdate stringISO 8601 Standard
2019-07-25T15:24:46.657Z
refresh_datedate stringISO 8601 Standard
2019-07-25T15:24:46.657Z

Sales Order Item

PropertyTypeDescription
sales_order_item_idstringnot a GUID
line_item_detailsLineItemDetails
ship_toAddress
requested_shipping_optionsRequestedShippingOptions
price_summaryPriceSummary
quantityint
is_giftbool

Sales Order Status

PropertyTypeDescription
payment_statusenumerated stringunknown, paid, unpaid, partially_paid
fulfillment_statusenumerated stringunknown, fulfilled, unfulfilled, partially_fulfilled, on_hold.
is_cancelledbool

Line Item Details

PropertyTypeDescription
namestring
skustring
weightWeight

Requested Shipping Options

PropertyTypeDescription
shipping_servicestring
ship_datedate stringISO 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.

PropertyTypeDescription
unit_price Currency Individual price of the item.
estimated_tax Currency Taxes quoted or collected for the item.
estimated_shippingCurrency Shipping amount quoted or collected for the item.
total Currency Total collected for this line item, including taxes and shipping.

Payment Details

PropertyTypeDescription
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

PropertyType
namestring
phonestring
emailstring

Bill To

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

PropertyType
emailstring
addressAddress

Address

PropertyType
namestring
company_namestring
phonestring
address_line1string
address_line2string
address_line3string
city_localitystring
state_provincestring
postal_codestring
country_codestring

Weight

PropertyTypeDescription
unitenumerated stringounce, pound, gram
valuedecimalWeight in the unit specified.

Currency

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

PropertyTypeDescription
amountdecimal
currencyenumerated stringusd, cad, aud, gbp, eur.