Sales Order Object

Sales Order

Property	Description
sales_order_id	string
external_order_id	string This is the Order ID we received from the order source.
external_order_number	string This is the Order ID we received from the order source.
order_source	Order Source The order source associated with the sales order.
sales_order_status	Sales Order Status The reported status from the order source, via the last refresh.
order_date	date 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_at	date 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_at	date string, (ISO 8601 Standard) `2019-07-25T15:24:46.657Z` When the SalesOrder was modified last in our system.
payment_details	Payment Details Summary of the totals for the SalesOrder as a whole.
customer	Customer The customer for the sales order.
bill_to	Bill To The billing information for the sales order.
ship_to	Address The shipping address for the sales order.
sales_order_items	Array of Sales Order Item The line items associated with the order.

Property	Description
order_source_id	string
order_source_nickname	string Nickname you assign to the order source when connecting, e.g. "My Amazon Store".
order_source_code	string The API code used to identify the type of order source, e.g. "amazon_ca"
order_source_friendly_name	string The human-readable name for the order source, e.g. "Amazon CA" instead of "amazon_ca"
refresh_info	RefreshInfo
active	bool Whether or not your order source is currently activated or deactivated

Property	Description
status	enumerated string, `idle`, `preparing_update`, `updating`, `error`, `unknown`
last_refresh_attempt	date string, (ISO 8601 Standard) `2019-07-25T15:24:46.657Z`
refresh_date	date string, (ISO 8601 Standard) `2019-07-25T15:24:46.657Z`

Property	Description
payment_status	enumerated string, `unknown`, `paid`, `unpaid`, `partially_paid`
fulfillment_status	enumerated string, `unknown`, `fulfilled`, `unfulfilled`, `partially_fulfilled`, `on_hold`.
is_cancelled	bool

Property	Description
shipping_service	string
ship_date	date string, (ISO 8601 Standard) `2019-07-25T15:24:46.657Z`

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

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

Property	Description
subtotal	Currency The amount of the order without taxes or shipping costs.
estimated_shipping	Currency Shipping amount quoted or collected for the item.
estimated_tax	Currency Taxes quoted or collected for the item.
grand_total	Currency Amount charged for the entire sales order.

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

Property	Description
email	string
address	Address

Property	Description
unit	enumerated string, `ounce`, `pound`, `gram`
value	decimal Weight in the `unit` specified.

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

Property	Description
amount	decimal
currency	enumerated string, `usd`, `cad`, `aud`, `gbp`, `eur`.