{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/api/stores/:store_api_key/orders","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"page","type":"int","default":"1","desc":"The page to return in the paginated result set","required":false,"in":"query","ref":"","_id":"544ea0ebcf9f860800800c83"},{"name":"per_page","type":"int","default":"50","desc":"The number of result to include per pagein the paginated result set. The maximum number of results returned per page is 200.","required":false,"in":"query","ref":"","_id":"544ea0ebcf9f860800800c82"},{"name":"last_updated_at","type":"datetime","default":"1 week ago","desc":"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","required":false,"in":"query","ref":"","_id":"544ea0ebcf9f860800800c81"},{"name":"status","type":"array_mixed","default":"shipped","desc":"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\"]","required":false,"in":"query","ref":"","_id":"544ea0ebcf9f860800800c80"},{"name":"includes","type":"string","default":"","desc":"Adds information to the response. Specifying includes=products will deliver additional information (if available) about each product in the order.","required":false,"in":"query","ref":"","_id":"5be998602ef1dd002d7680c7"},{"name":"order_number","type":"string","default":"","desc":"The external_order_identifier to search for","required":false,"in":"query","ref":"","_id":"5be998602ef1dd002d7680c6"}],"results":{"codes":[{"status":200,"language":"json","code":"{\"order\": {\n    \"id\": 73150,\n    \"external_order_identifier\": \"45640\",\n    \"ordered_at\": \"2014-03-05T08:00:00Z\",\n    \"order_status\": \"ready_for_shipment\",\n    \"total_including_tax\": \"94.90\",\n    \"total_excluding_tax\": \"0.00\",\n    \"discount_amount\": \"0.00\",\n    \"coupon_discount\": \"0.00\",\n    \"subtotal_including_tax\": \"89.95\",\n    \"subtotal_excluding_tax\": \"0.00\",\n    \"subtotal_tax\": \"0.00\",\n    \"total_tax\": \"0.00\",\n    \"base_shipping_cost\": \"4.95\",\n    \"shipping_cost_including_tax\": \"4.95\",\n    \"shipping_cost_excluding_tax\": \"0.00\",\n    \"shipping_cost_tax\": \"0.00\",\n    \"base_handling_cost\": \"0.00\",\n    \"handling_cost_excluding_tax\": \"0.00\",\n    \"handling_cost_including_tax\": \"0.00\",\n    \"handling_cost_tax\": \"0.00\",\n    \"base_wrapping_cost\": \"0.00\",\n    \"wrapping_cost_excluding_tax\": \"0.00\",\n    \"wrapping_cost_including_tax\": \"0.00\",\n    \"wrapping_cost_tax\": \"0.00\",\n    \"billing_company\": \"\",\n    \"billing_first_name\": \"Tom\",\n    \"billing_last_name\": \"Smith\",\n    \"billing_address\": \"600 California St\",\n    \"billing_address2\": \"\",\n    \"billing_city\": \"San Francisco\",\n    \"billing_state\": \"California\",\n    \"billing_country\": \"United States\",\n    \"billing_postal_code\": \"94108\",\n    \"billing_phone_number\": null,\n    \"billing_email\": \"melissa:::at:::shippingeasy.com\",\n    \"recipients\": [\n        {\n            \"company\": \"\",\n            \"first_name\": \"Tom\",\n            \"last_name\": \"Smith\",\n            \"address\": \"600 California St\",\n            \"address2\": \"\",\n            \"address3\": null,\n            \"city\": \"San Francisco\",\n            \"residential\": false,\n            \"state\": \"CA\",\n            \"province\": null,\n            \"country\": \"United States\",\n            \"postal_code\": \"94108\",\n            \"postal_code_plus_4\": \"2704\",\n            \"phone_number\": \"3453332222\",\n            \"email\": \"[email protected]\",\n            \"base_cost\": \"0.00\",\n            \"cost_excluding_tax\": \"0.00\",\n            \"cost_including_tax\": \"0.00\",\n            \"cost_tax\": \"0.00\",\n            \"base_handling_cost\": \"0.00\",\n            \"handling_cost_excluding_tax\": \"0.00\",\n            \"handling_cost_including_tax\": \"0.00\",\n            \"handling_cost_tax\": \"0.00\",\n            \"shipping_zone_id\": null,\n            \"shipping_zone_name\": null,\n            \"items_total\": 0,\n            \"shipping_method\": null,\n            \"items_shipped\": 0,\n            \"ext_shipping_detail_id\": 44370,\n            \"line_items\": [\n                {\n                    \"item_name\": \"Crumpler Bag\",\n                    \"sku\": \"90907\",\n                    \"bin_picking_number\": null,\n                    \"weight_in_ounces\": \"46.08\",\n                    \"quantity\": 1,\n                    \"total_excluding_tax\": \"0.00\",\n                    \"price_excluding_tax\": \"89.95\",\n                    \"unit_price\": \"89.95\",\n                    \"ext_line_item_id\": \"90908\",\n                    \"ext_product_id\": \"1018\",\n                    \"product_options\": null\n                },\n                {\n                    \"item_name\": \"Downloadable - Office for PC\",\n                    \"sku\": \"90909\",\n                    \"bin_picking_number\": null,\n                    \"weight_in_ounces\": \"36.8\",\n                    \"quantity\": 1,\n                    \"total_excluding_tax\": \"0.00\",\n                    \"price_excluding_tax\": \"0.00\",\n                    \"unit_price\": \"0.00\",\n                    \"ext_line_item_id\": \"90910\",\n                    \"ext_product_id\": \"1037\",\n                    \"product_options\": null\n                }\n            ]\n        }\n    ],\n    \"store_api_key\": null\n}}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"/stores/:store_api_key/orders","type":"endpoint","slug":"storesstore_api_keyorders","excerpt":"Search and filter orders for a specific store on an account","body":"_","updates":["57ab93e5b5e8742000e17eae"],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c097a0265263a0216070bb3","user":"5436a1afb7cf0e1c0020d9ca","version":{"version":"1.2","version_clean":"1.2.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5c097a0265263a0216070b98","5c097a0265263a0216070b99","5c097a0265263a0216070b9a","5c097a0265263a0216070b9b","5c097a0265263a0216070b9c","5c097a0265263a0216070b9d","5c097a0265263a0216070b9e","5c097a0265263a0216070b9f","5c097a0265263a0216070ba0","5c097a0265263a0216070ba1"],"_id":"5c097a0265263a0216070bd2","__v":0,"forked_from":"54cc2148380ecd0d00ca18aa","project":"5436a1e1d0ffee0e00f18f8c","createdAt":"2015-01-31T00:26:48.753Z","releaseDate":"2015-01-31T00:26:48.753Z"},"createdAt":"2014-10-27T19:38:49.989Z","editedParams2":true,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["5c097a0265263a0216070bb2","5c097a0265263a0216070bb3","5c097a0265263a0216070bb4","5c097a0265263a0216070bb5","5c097a0265263a0216070bb6","5c097a0265263a0216070bb7","5c097a0265263a0216070bc4","5c097a0265263a0216070bc7","5c097a0265263a0216070bcd","5c097a0265263a0216070bce"],"title":"Customer API","slug":"customer-api","order":1,"from_sync":false,"reference":false,"_id":"5c097a0265263a0216070b99","createdAt":"2014-10-09T15:31:21.989Z","project":"5436a1e1d0ffee0e00f18f8c","version":"5c097a0265263a0216070bd2","__v":5},"editedParams":true,"parentDoc":null,"__v":4,"project":"5436a1e1d0ffee0e00f18f8c"}

get/stores/:store_api_key/orders

Search and filter orders for a specific store on an account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

page:
integer1
The page to return in the paginated result set
per_page:
integer50
The number of result to include per pagein the paginated result set. The maximum number of results returned per page is 200.
last_updated_at:
datetime1 week ago
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
status:
array of mixedshipped
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"]
includes:
string
Adds information to the response. Specifying includes=products will deliver additional information (if available) about each product in the order.
order_number:
string
The external_order_identifier to search for

Result Format


Documentation

_