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 OrderSource
The order source associated with the sales order.
sales_order_status SalesOrderStatus
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 PaymentDetails
Summary of the totals for the SalesOrder as a whole.
customer Customer
The customer for the sales order.
bill_to BillTo
The billing information for the sales order.
ship_to Address\n\nThe shipping address for the sales order.
sales_order_items Array of SalesOrderItem
The line items associated with the order.

Order Source

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

RefreshInfo

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

SalesOrderItem

Property Description
sales_order_item_id string (not a GUID)
line_item_details LineItemDetails
ship_to Address
requested_shipping_options RequestedShippingOptions
price_summary PriceSummary
quantity int
is_gift bool

LineItemDetails

Property Description
name string
sku string
weight Weight

RequestedShippingOptions

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

PriceSummary

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.

PaymentDetails

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.

Customer

Property Description
name string
phone string
email string

BillTo

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

Property Description
email string
address Address

Address

Property Description
name string
company_name string
phone string
address_line1 string
address_line2 string
address_line3 string
city_locality string
state_province string
postal_code string
country_code string

Weight

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

Currency

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

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