{"_id":"54cc2149380ecd0d00ca18c5","user":"5436a1afb7cf0e1c0020d9ca","version":{"_id":"54cc2148380ecd0d00ca18aa","__v":2,"forked_from":"5436a1e1d0ffee0e00f18f8f","project":"5436a1e1d0ffee0e00f18f8c","createdAt":"2015-01-31T00:26:48.753Z","releaseDate":"2015-01-31T00:26:48.753Z","categories":["54cc2149380ecd0d00ca18ab","54cc2149380ecd0d00ca18ac","54cc2149380ecd0d00ca18ad","54cc2149380ecd0d00ca18ae","54cc2149380ecd0d00ca18af","54cc2149380ecd0d00ca18b0","54cc2149380ecd0d00ca18b1","54cc2149380ecd0d00ca18b2","54cc2149380ecd0d00ca18b3","552f29ca633a5b0d00e99d09"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"editedParams2":true,"category":{"_id":"54cc2149380ecd0d00ca18ac","pages":["54cc2149380ecd0d00ca18c4","54cc2149380ecd0d00ca18c5","54cc2149380ecd0d00ca18c6","54cc2149380ecd0d00ca18c7","54cc2149380ecd0d00ca18c8","54cc2149380ecd0d00ca18c9","54cc2601380ecd0d00ca18dc","55035fc26cb452370085b3ef","561dbc1defcf8217003adf22","561e6b043e744b2100d21191"],"project":"5436a1e1d0ffee0e00f18f8c","version":"54cc2148380ecd0d00ca18aa","__v":5,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-09T15:31:21.989Z","from_sync":false,"order":1,"slug":"customer-api","title":"Customer API"},"editedParams":true,"parentDoc":null,"__v":2,"project":"5436a1e1d0ffee0e00f18f8c","updates":["57ab93e5b5e8742000e17eae"],"next":{"pages":[],"description":""},"createdAt":"2014-10-27T19:38:49.989Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","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\": \"melissa@shippingeasy.com\",\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}}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"544ea0ebcf9f860800800c83","ref":"","in":"query","required":false,"desc":"The page to return in the paginated result set","default":"1","type":"int","name":"page"},{"_id":"544ea0ebcf9f860800800c82","ref":"","in":"query","required":false,"desc":"The number of result to include per pagein the paginated result set. The maximum number of results returned per page is 200.","default":"50","type":"int","name":"per_page"},{"_id":"544ea0ebcf9f860800800c81","ref":"","in":"query","required":false,"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=2016-05-24T19:38:25Z","default":"1 week ago","type":"datetime","name":"last_updated_at"},{"_id":"544ea0ebcf9f860800800c80","ref":"","in":"query","required":false,"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\"]","default":"shipped","type":"array_mixed","name":"status"}],"url":"/api/stores/:store_api_key/orders"},"isReference":false,"order":3,"body":"_","excerpt":"Search and filter orders for a specific store on an account","slug":"storesstore_api_keyorders","type":"endpoint","title":"/stores/:store_api_key/orders"}

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=2016-05-24T19:38:25Z
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"]

Result Format


Documentation

_