| Field | Type | Required | Description | Example |
|---|---|---|---|---|
currency |
Optional<String> | ➖ | Required if total_price is provided Currency of the total_price and total_tax amounts. |
USD |
notes |
Optional<String> | ➖ | Custom buyer- or seller-provided notes about the order. | This customer is a VIP |
orderNumber |
Optional<String> | ➖ | An alphanumeric identifier for the order used by the seller/buyer. This identifier doesn't need to be unique. | #1068 |
orderStatus |
Optional<OrderStatusEnum> | ➖ | Current state of the order. See the orders tutorial for the logic of how the status is handled. |
PAID |
placedAt |
String | ✔️ | 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 |
shippingCost |
Optional<String> | ➖ | Amount paid by the buyer for shipping. This amount can be different from the price the seller will actually pay for shipping. | 12.83 |
shippingCostCurrency |
Optional<String> | ➖ | Required if shipping_cost is provided Currency of the shipping_cost amount. |
USD |
shippingMethod |
Optional<String> | ➖ | 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 |
subtotalPrice |
Optional<String> | ➖ | N/A | 12.1 |
totalPrice |
Optional<String> | ➖ | Total amount paid by the buyer for this order. | 24.93 |
totalTax |
Optional<String> | ➖ | Total tax amount paid by the buyer for this order. | 0.0 |
weight |
Optional<String> | ➖ | Total weight of the order. | 0.4 |
weightUnit |
Optional<WeightUnitEnum> | ➖ | The unit used for weight. | lb |
fromAddress |
Optional<Address> | ➖ | Address object of the sender / seller. Will be returned expanded by default. | |
toAddress |
Address | ✔️ | Address object of the recipient / buyer. Will be returned expanded by default. | |
lineItems |
List<LineItem> | ➖ | Array of line item objects representing the items in this order. All objects will be returned expanded by default. |
|
objectId |
Optional<String> | ➖ | Unique identifier of the order object. | adcfdddf8ec64b84ad22772bce3ea37a |
objectOwner |
Optional<String> | ➖ | Username of the user who created the object. | [email protected] |
shopApp |
Optional<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<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. |