| Field | Type | Required | Description | Example |
|---|---|---|---|---|
placed_at |
str | ✔️ | Date and time when the order was placed. This datetime can be different from the datetime of the order object creation on Shippo. | 2016-09-23T01:28:12Z |
to_address |
components.Address | ✔️ | Address object of the recipient / buyer. Will be returned expanded by default. | |
currency |
Optional[str] | ➖ | Required if total_price is provided Currency of the total_price and total_tax amounts. |
USD |
notes |
Optional[str] | ➖ | Custom buyer- or seller-provided notes about the order. | This customer is a VIP |
order_number |
Optional[str] | ➖ | An alphanumeric identifier for the order used by the seller/buyer. This identifier doesn't need to be unique. | #1068 |
order_status |
Optional[components.OrderStatusEnum] | ➖ | Current state of the order. See the orders tutorial for the logic of how the status is handled. |
PAID |
shipping_cost |
Optional[str] | ➖ | Amount paid by the buyer for shipping. This amount can be different from the price the seller will actually pay for shipping. | 12.83 |
shipping_cost_currency |
Optional[str] | ➖ | Required if shipping_cost is provided Currency of the shipping_cost amount. |
USD |
shipping_method |
Optional[str] | ➖ | Shipping method (carrier + service or other free text description) chosen by the buyer. This value can be different from the shipping method the seller will actually choose. |
USPS First Class Package |
subtotal_price |
Optional[str] | ➖ | N/A | 12.1 |
total_price |
Optional[str] | ➖ | Total amount paid by the buyer for this order. | 24.93 |
total_tax |
Optional[str] | ➖ | Total tax amount paid by the buyer for this order. | 0.0 |
weight |
Optional[str] | ➖ | Total weight of the order. | 0.4 |
weight_unit |
Optional[components.WeightUnitEnum] | ➖ | The unit used for weight. | lb |
from_address |
Optional[components.Address] | ➖ | Address object of the sender / seller. Will be returned expanded by default. | |
line_items |
List[components.LineItem] | ➖ | Array of line item objects representing the items in this order. All objects will be returned expanded by default. |
|
object_id |
Optional[str] | ➖ | Unique identifier of the order object. | adcfdddf8ec64b84ad22772bce3ea37a |
object_owner |
Optional[str] | ➖ | Username of the user who created the object. | [email protected] |
shop_app |
Optional[components.OrderShopAppEnum] | ➖ | Platform the order was created on and, if applicable, imported from. Orders created via the Shippo API or dashboard will have the value "Shippo". |
Shippo |
transactions |
List[components.Transactions] | ➖ | Array of transaction objects representing all shipping labels purchased for this order. All objects are returned expanded with a limited number of fields by default. |