v1
latestOpenAPI 3.1.02026-07-14110151.9 KB/stores/:store_api_key/orders
Search and filter orders for a specific store on an account
Query parameters
The page to return in the paginated result set
The number of result to include per pagein the paginated result set. The maximum number of results returned per page is 200.
Filters the results by the orders' last updated at timestamp and only returns results with a timestamp newer than or equal to the specified value. The maximum time this value can be set to is 3 months ago. Note that "1 week ago" is the default, but cannot be used literally - you must specify a timestamp, for example: last_updated_at=2017-05-24T19:38:25.000-00:00
Filters the results by the orders' ShippingEasy order status. Possible values are "shipped", "cleared", "pending_shipment", and "ready_for_shipment". It is possible to pass an array of statuses, e.g. ["shipped", "ready_for_shipment"]
Adds information to the response. Specifying includes=products will deliver additional information (if available) about each product in the order.
The external_order_identifier to search for
Response
200
Example response
{
"order": {
"id": 73150,
"external_order_identifier": "45640",
"ordered_at": "2014-03-05T08:00:00Z",
"order_status": "ready_for_shipment",
"total_including_tax": "94.90",
"total_excluding_tax": "0.00",
"discount_amount": "0.00",
"coupon_discount": "0.00",
"subtotal_including_tax": "89.95",
"subtotal_excluding_tax": "0.00",
"subtotal_tax": "0.00",
"total_tax": "0.00",
"base_shipping_cost": "4.95",
"shipping_cost_including_tax": "4.95",
"shipping_cost_excluding_tax": "0.00",
"shipping_cost_tax": "0.00",
"base_handling_cost": "0.00",
"handling_cost_excluding_tax": "0.00",
"handling_cost_including_tax": "0.00",
"handling_cost_tax": "0.00",
"base_wrapping_cost": "0.00",
"wrapping_cost_excluding_tax": "0.00",
"wrapping_cost_including_tax": "0.00",
"wrapping_cost_tax": "0.00",
"billing_first_name": "Tom",
"billing_last_name": "Smith",
"billing_address": "600 California St",
"billing_city": "San Francisco",
"billing_state": "California",
"billing_country": "United States",
"billing_postal_code": "94108",
"billing_email": "melissa@shippingeasy.com",
"recipients": [
{
"first_name": "Tom",
"last_name": "Smith",
"address": "600 California St",
"city": "San Francisco",
"state": "CA",
"country": "United States",
"postal_code": "94108",
"postal_code_plus_4": "2704",
"phone_number": "3453332222",
"email": "melissa@shippingeasy.com",
"base_cost": "0.00",
"cost_excluding_tax": "0.00",
"cost_including_tax": "0.00",
"cost_tax": "0.00",
"base_handling_cost": "0.00",
"handling_cost_excluding_tax": "0.00",
"handling_cost_including_tax": "0.00",
"handling_cost_tax": "0.00",
"ext_shipping_detail_id": 44370,
"line_items": [
{
"item_name": "Crumpler Bag",
"sku": "90907",
"weight_in_ounces": "46.08",
"quantity": 1,
"total_excluding_tax": "0.00",
"price_excluding_tax": "89.95",
"unit_price": "89.95",
"ext_line_item_id": "90908",
"ext_product_id": "1018"
}
]
}
]
}
}