{"_id":"5c097a0265263a0216070bb2","user":"5436a1afb7cf0e1c0020d9ca","editedParams":true,"editedParams2":true,"githubsync":"","project":"5436a1e1d0ffee0e00f18f8c","parentDoc":null,"version":{"_id":"5c097a0265263a0216070bd2","__v":0,"forked_from":"54cc2148380ecd0d00ca18aa","project":"5436a1e1d0ffee0e00f18f8c","createdAt":"2015-01-31T00:26:48.753Z","releaseDate":"2015-01-31T00:26:48.753Z","categories":["5c097a0265263a0216070b98","5c097a0265263a0216070b99","5c097a0265263a0216070b9a","5c097a0265263a0216070b9b","5c097a0265263a0216070b9c","5c097a0265263a0216070b9d","5c097a0265263a0216070b9e","5c097a0265263a0216070b9f","5c097a0265263a0216070ba0","5c097a0265263a0216070ba1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.2.0","version":"1.2"},"__v":11,"category":{"_id":"5c097a0265263a0216070b99","pages":["5c097a0265263a0216070bb2","5c097a0265263a0216070bb3","5c097a0265263a0216070bb4","5c097a0265263a0216070bb5","5c097a0265263a0216070bb6","5c097a0265263a0216070bb7","5c097a0265263a0216070bc4","5c097a0265263a0216070bc7","5c097a0265263a0216070bcd","5c097a0265263a0216070bce"],"project":"5436a1e1d0ffee0e00f18f8c","version":"5c097a0265263a0216070bd2","__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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-09T16:01:25.106Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"text","name":"","code":""}]},"method":"get","results":{"codes":[{"name":"Success","code":"    {\n    \"orders\": [\n        {\n            \"id\": 50779590,\n            \"external_order_identifier\": \"464259637\",\n            \"ext_order_reference_id\": \"464259637\",\n            \"owner_id\": null,\n            \"ordered_at\": \"2016-05-05T15:35:36Z\",\n            \"order_status\": \"shipped\",\n            \"parent_order_id\": null,\n            \"source_order_ids\": null,\n            \"total_including_tax\": \"30.33\",\n            \"total_excluding_tax\": \"0.00\",\n            \"discount_amount\": \"0.00\",\n            \"coupon_discount\": \"0.00\",\n            \"subtotal_including_tax\": \"27.31\",\n            \"subtotal_excluding_tax\": \"25.00\",\n            \"subtotal_tax\": \"0.00\",\n            \"total_tax\": \"2.31\",\n            \"base_shipping_cost\": \"3.02\",\n            \"shipping_cost_including_tax\": \"3.02\",\n            \"shipping_cost_excluding_tax\": \"3.02\",\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\": null,\n            \"billing_first_name\": \"Tessa's\",\n            \"billing_last_name\": \"Store\",\n            \"billing_address\": \"609 Castle Ridge Rd\",\n            \"billing_address2\": \"Suite 445\",\n            \"billing_city\": \"Austin\",\n            \"billing_state\": \"TX\",\n            \"billing_country\": \"US\",\n            \"billing_postal_code\": \"78746\",\n            \"billing_phone_number\": null,\n            \"billing_email\": \"jack:::at:::shippingeasy.com\",\n            \"recipients\": [\n                {\n                    \"company\": \"\",\n                    \"first_name\": \"Tessa's\",\n                    \"last_name\": \"Store\",\n                    \"address\": \"609 Castle Ridge Rd\",\n                    \"address2\": \"Suite 445\",\n                    \"address3\": null,\n                    \"city\": \"Austin\",\n                    \"residential\": false,\n                    \"state\": \"TX\",\n                    \"province\": null,\n                    \"country\": \"United States\",\n                    \"postal_code\": \"78746\",\n                    \"postal_code_plus_4\": \"5162\",\n                    \"phone_number\": \"5122012155\",\n                    \"email\": null,\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\": \"Standard\",\n                    \"items_shipped\": 0,\n                    \"ext_shipping_detail_id\": null,\n                    \"line_items\": [\n                        {\n                            \"item_name\": \"Unknown\",\n                            \"sku\": \"\",\n                            \"bin_picking_number\": \"NOT SET\",\n                            \"bundled_product\": null,\n                            \"weight_in_ounces\": \"0.0\",\n                            \"quantity\": 1,\n                            \"total_excluding_tax\": \"25.00\",\n                            \"price_excluding_tax\": \"0.00\",\n                            \"unit_price\": \"25.00\",\n                            \"ext_line_item_id\": null,\n                            \"ext_product_id\": null,\n                            \"product_options\": null,\n                            \"uuid\": \"ab929596-20ec-4da0-8f85-3abb50175478\",\n                            \"order_source_id\": 39116082,\n                            \"gift_message\": null\n                        }\n                    ],\n                    \"original_order\": {\n                        \"id\": 50779590,\n                        \"customer_id\": 3633,\n                        \"store_id\": 12765,\n                        \"order_detail_id\": 50848733,\n                        \"workflow_state\": \"ready_for_shipment\",\n                        \"shipment_id\": null,\n                        \"destination_id\": null,\n                        \"split_from_order_id\": null,\n                        \"total_weight_in_ounces\": \"0.0\",\n                        \"total_quantity\": 1,\n                        \"is_international\": false,\n                        \"usps_shipping_zone\": 1,\n                        \"created_at\": \"2016-05-05T22:21:41Z\",\n                        \"updated_at\": \"2016-05-05T22:21:42Z\",\n                        \"ext_shipment_confirmation_id\": null,\n                        \"store_order_status\": \"awaiting_shipment\",\n                        \"drop_ship_tracking_number\": null,\n                        \"category_id\": null,\n                        \"internal_notes\": \"\",\n                        \"line_item_name\": \"unknown\",\n                        \"line_item_sku\": \"\",\n                        \"address_kind\": \"C\",\n                        \"recipient_last_name\": \"store\",\n                        \"recipient_requested_service\": \"standard\",\n                        \"gift\": false,\n                        \"prime_order_id\": 50779590,\n                        \"state\": \"TX\",\n                        \"owner_id\": null,\n                        \"denormalized_ordered_at\": \"2016-05-05T15:35:36Z\",\n                        \"grab_bag\": {},\n                        \"line_item_bin_picking_number\": \"not set\",\n                        \"denormalized_ext_order_id\": \"464259637\",\n                        \"packing_slip_generated\": null,\n                        \"denormalized_ext_order_reference_id\": \"464259637\",\n                        \"denormalized_alternate_order_id\": \"#SE2857\",\n                        \"denormalized_sales_channel\": \"markys-store.myshopify.com\",\n                        \"custom_1\": \"\",\n                        \"custom_2\": \"\",\n                        \"custom_3\": \"\"\n                    }\n                }\n            ],\n            \"store_api_key\": \"838c8b85eb34302ede43be350467cb30\",\n            \"shipments\": [],\n            \"updated_at\": \"2016-05-05T22:21:42Z\",\n            \"internal_notes\": \"\",\n            \"meta_data\": null,\n            \"prime_order_id\": 50779590,\n            \"is_prime\": null,\n            \"split_from_order_id\": null\n        },\n        {\n            \"id\": 49440369,\n            \"external_order_identifier\": \"2806\",\n            \"ext_order_reference_id\": \"3140622980\",\n            \"owner_id\": null,\n            \"ordered_at\": \"2016-04-27T13:57:17Z\",\n            \"order_status\": \"cleared\",\n            \"parent_order_id\": null,\n            \"source_order_ids\": null,\n            \"total_including_tax\": \"8.61\",\n            \"total_excluding_tax\": \"0.00\",\n            \"discount_amount\": \"0.00\",\n            \"coupon_discount\": \"0.00\",\n            \"subtotal_including_tax\": \"8.61\",\n            \"subtotal_excluding_tax\": \"0.00\",\n            \"subtotal_tax\": \"0.00\",\n            \"total_tax\": \"0.66\",\n            \"base_shipping_cost\": \"7.95\",\n            \"shipping_cost_including_tax\": \"7.95\",\n            \"shipping_cost_excluding_tax\": \"7.95\",\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\": null,\n            \"billing_first_name\": \"Justin\",\n            \"billing_last_name\": \"Forte\",\n            \"billing_address\": \"609 Castle Ridge Rd\",\n            \"billing_address2\": \"\",\n            \"billing_city\": \"Austin\",\n            \"billing_state\": \"TX\",\n            \"billing_country\": \"United States\",\n            \"billing_postal_code\": \"78746\",\n            \"billing_phone_number\": \"\",\n            \"billing_email\": \"jack@shippingeasy.com\",\n            \"recipients\": [\n                {\n                    \"company\": \"ShippingEasy\",\n                    \"first_name\": \"Justin\",\n                    \"last_name\": \"Forte\",\n                    \"address\": \"609 Castle Ridge Rd\",\n                    \"address2\": \"\",\n                    \"address3\": null,\n                    \"city\": \"Austin\",\n                    \"residential\": false,\n                    \"state\": \"Texas\",\n                    \"province\": null,\n                    \"country\": \"United States\",\n                    \"postal_code\": \"78746\",\n                    \"postal_code_plus_4\": \"5147\",\n                    \"phone_number\": \"\",\n                    \"email\": \"jack@shippingeasy.com\",\n                    \"base_cost\": \"7.95\",\n                    \"cost_excluding_tax\": \"7.95\",\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\": \"USPS Priority\",\n                    \"items_shipped\": 0,\n                    \"ext_shipping_detail_id\": null,\n                    \"line_items\": [\n                        {\n                            \"item_name\": \"Adapter\",\n                            \"sku\": \"a_127\",\n                            \"bin_picking_number\": null,\n                            \"bundled_product\": null,\n                            \"weight_in_ounces\": \"0.0\",\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\": \"5982866052\",\n                            \"ext_product_id\": \"3680296836\",\n                            \"product_options\": {\n                                \"variant_id\": 11063640260,\n                                \"variant_title\": \"Large / Grey / tree\",\n                                \"variant_vendor\": \"Marky's Store\",\n                                \"variant_inventory_management\": null,\n                                \"Custom B Field\": \"\"\n                            },\n                            \"uuid\": \"32e821f9-a607-4ee8-ae11-75bcfd71c059\",\n                            \"order_source_id\": 37793960,\n                            \"gift_message\": null\n                        }\n                    ],\n                    \"original_order\": {\n                        \"id\": 49440369,\n                        \"customer_id\": 3633,\n                        \"store_id\": 7971,\n                        \"order_detail_id\": 49507738,\n                        \"workflow_state\": \"cleared\",\n                        \"shipment_id\": null,\n                        \"destination_id\": null,\n                        \"split_from_order_id\": null,\n                        \"total_weight_in_ounces\": \"0.0\",\n                        \"total_quantity\": 1,\n                        \"is_international\": false,\n                        \"usps_shipping_zone\": 1,\n                        \"created_at\": \"2016-04-27T14:06:55Z\",\n                        \"updated_at\": \"2016-05-07T00:05:55Z\",\n                        \"ext_shipment_confirmation_id\": null,\n                        \"store_order_status\": \"awaiting_payment\",\n                        \"drop_ship_tracking_number\": null,\n                        \"category_id\": null,\n                        \"internal_notes\": \"\",\n                        \"line_item_name\": \"adapter\",\n                        \"line_item_sku\": \"a_127\",\n                        \"address_kind\": \"C\",\n                        \"recipient_last_name\": \"forte\",\n                        \"recipient_requested_service\": \"usps priority\",\n                        \"gift\": false,\n                        \"prime_order_id\": 49440369,\n                        \"state\": \"TEXAS\",\n                        \"owner_id\": null,\n                        \"denormalized_ordered_at\": \"2016-04-27T13:57:17Z\",\n                        \"grab_bag\": {},\n                        \"line_item_bin_picking_number\": null,\n                        \"denormalized_ext_order_id\": \"2806\",\n                        \"packing_slip_generated\": null,\n                        \"denormalized_ext_order_reference_id\": \"3140622980\",\n                        \"denormalized_alternate_order_id\": \"#SE2806\",\n                        \"denormalized_sales_channel\": null,\n                        \"custom_1\": \"\",\n                        \"custom_2\": \"\",\n                        \"custom_3\": \"\"\n                    }\n                }\n            ],\n            \"store_api_key\": \"3c437503ee56407014de348bc3447862\",\n\t\t\t\t    \"shipments\": [\n        \t\t\t{\n          \t\t\t\"id\": 717447073,\n          \t\t\t\"tracking_number\": \"8888888888888888888888\",\n          \t\t\t\"carrier_key\": \"USPS\",\n          \t\t\t\"carrier_service_key\": \"Priority\",\n          \t\t\t\"shipment_cost\": 655,\n          \t\t\t\"ship_date\": \"2016-05-07\",\n          \t\t\t\"workflow_state\": \"label_printed\",\n          \t\t\t\"cloned_from_shipment_id\": null,\n          \t\t\t\"weight_in_ounces\": \"16.0\",\n          \t\t\t\"length_in_inches\": null,\n          \t\t\t\"width_in_inches\": null,\n          \t\t\t\"height_in_inches\": null,\n          \t\t\t\"additional_packages\": []\n        \t\t\t}\n      \t\t\t],\n            \"updated_at\": \"2016-05-07T00:05:55Z\",\n            \"internal_notes\": \"\",\n            \"meta_data\": null,\n            \"prime_order_id\": 49440369,\n            \"is_prime\": null,\n            \"split_from_order_id\": null\n        },\n        {\n            \"id\": 51224602,\n            \"external_order_identifier\": \"2864\",\n            \"ext_order_reference_id\": \"3231034948\",\n            \"owner_id\": null,\n            \"ordered_at\": \"2016-05-09T21:39:24Z\",\n            \"order_status\": \"shipped\",\n            \"parent_order_id\": null,\n            \"source_order_ids\": null,\n            \"total_including_tax\": \"30.33\",\n            \"total_excluding_tax\": \"25.00\",\n            \"discount_amount\": \"0.00\",\n            \"coupon_discount\": \"0.00\",\n            \"subtotal_including_tax\": \"30.33\",\n            \"subtotal_excluding_tax\": \"25.00\",\n            \"subtotal_tax\": \"0.00\",\n            \"total_tax\": \"2.31\",\n            \"base_shipping_cost\": \"3.02\",\n            \"shipping_cost_including_tax\": \"3.02\",\n            \"shipping_cost_excluding_tax\": \"3.02\",\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\": null,\n            \"billing_first_name\": \"Jack\",\n            \"billing_last_name\": \"Ship\",\n            \"billing_address\": \"609 Castle Ridge Rd\",\n            \"billing_address2\": \"\",\n            \"billing_city\": \"Austin\",\n            \"billing_state\": \"TX\",\n            \"billing_country\": \"United States\",\n            \"billing_postal_code\": \"78746\",\n            \"billing_phone_number\": \"\",\n            \"billing_email\": \"jack@shippingeasy.com\",\n            \"recipients\": [\n                {\n                    \"company\": \"\",\n                    \"first_name\": \"Jack\",\n                    \"last_name\": \"Ship\",\n                    \"address\": \"609 Castle Ridge Rd\",\n                    \"address2\": null,\n                    \"address3\": null,\n                    \"city\": \"Austin\",\n                    \"residential\": false,\n                    \"state\": \"TX\",\n                    \"province\": null,\n                    \"country\": \"United States\",\n                    \"postal_code\": \"78746\",\n                    \"postal_code_plus_4\": \"5147\",\n                    \"phone_number\": \"\",\n                    \"email\": \"gregg@shippingeasy.com\",\n                    \"base_cost\": \"3.02\",\n                    \"cost_excluding_tax\": \"3.02\",\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\": \"USPS First-Class Mail Parcel\",\n                    \"items_shipped\": 0,\n                    \"ext_shipping_detail_id\": null,\n                    \"line_items\": [\n                        {\n                            \"item_name\": \"Computer Mouse\",\n                            \"sku\": \"mouse_6x5_new\",\n                            \"bin_picking_number\": null,\n                            \"bundled_product\": null,\n                            \"weight_in_ounces\": \"5.89\",\n                            \"quantity\": 1,\n                            \"total_excluding_tax\": \"0.00\",\n                            \"price_excluding_tax\": \"25.00\",\n                            \"unit_price\": \"25.00\",\n                            \"ext_line_item_id\": \"6153200388\",\n                            \"ext_product_id\": \"78129802\",\n                            \"product_options\": {\n                                \"variant_id\": 184925132,\n                                \"variant_title\": \"Computer Mouse / 6\\\" x 5\\\"\",\n                                \"variant_vendor\": \"Microsoft\",\n                                \"variant_inventory_management\": null,\n                                \"Custom B Field\": \"\"\n                            },\n                            \"uuid\": \"c7162b35-848a-4bdf-a764-9adc3f03addc\",\n                            \"order_source_id\": 39555061,\n                            \"gift_message\": null\n                        }\n                    ],\n                    \"original_order\": {\n                        \"id\": 51224602,\n                        \"customer_id\": 3633,\n                        \"store_id\": 7971,\n                        \"order_detail_id\": 51294401,\n                        \"workflow_state\": \"shipped\",\n                        \"shipment_id\": null,\n                        \"destination_id\": null,\n                        \"split_from_order_id\": null,\n                        \"total_weight_in_ounces\": \"5.89\",\n                        \"total_quantity\": 1,\n                        \"is_international\": false,\n                        \"usps_shipping_zone\": 1,\n                        \"created_at\": \"2016-05-09T21:43:38Z\",\n                        \"updated_at\": \"2016-05-10T14:51:20Z\",\n                        \"ext_shipment_confirmation_id\": 1,\n                        \"store_order_status\": \"awaiting_payment\",\n                        \"drop_ship_tracking_number\": null,\n                        \"category_id\": null,\n                        \"internal_notes\": \"\",\n                        \"line_item_name\": \"computer mouse\",\n                        \"line_item_sku\": \"mouse_6x5_new\",\n                        \"address_kind\": \"C\",\n                        \"recipient_last_name\": \"sporar\",\n                        \"recipient_requested_service\": \"usps first-class mail parcel\",\n                        \"gift\": false,\n                        \"prime_order_id\": 51224602,\n                        \"state\": \"TX\",\n                        \"owner_id\": null,\n                        \"denormalized_ordered_at\": \"2016-05-09T21:39:24Z\",\n                        \"grab_bag\": {},\n                        \"line_item_bin_picking_number\": null,\n                        \"denormalized_ext_order_id\": \"2864\",\n                        \"packing_slip_generated\": true,\n                        \"denormalized_ext_order_reference_id\": \"3231034948\",\n                        \"denormalized_alternate_order_id\": \"#SE2864\",\n                        \"denormalized_sales_channel\": null,\n                        \"custom_1\": \"\",\n                        \"custom_2\": \"\",\n                        \"custom_3\": \"\"\n                    }\n                }\n            ],\n            \"store_api_key\": \"3c437503ee56407014de348bc3447862\",\n            \"shipments\": [\n                {\n                    \"id\": 50209872,\n                    \"tracking_number\": \"9499907123456123456781\",\n                    \"carrier_key\": \"USPS\",\n                    \"carrier_service_key\": \"Priority\",\n                    \"shipment_cost\": 601,\n                    \"ship_date\": \"2016-05-10\",\n                    \"workflow_state\": \"label_ready\",\n                    \"cloned_from_shipment_id\": null,\n                    \"weight_in_ounces\": \"4.0\",\n                    \"length_in_inches\": \"3.0\",\n                    \"width_in_inches\": \"2.0\",\n                    \"height_in_inches\": \"1.0\",\n                    \"additional_packages\": [],\n                }\n            ],\n            \"updated_at\": \"2016-05-10T14:51:20Z\",\n            \"internal_notes\": \"\",\n            \"meta_data\": null,\n            \"prime_order_id\": 51224602,\n            \"is_prime\": null,\n            \"split_from_order_id\": null,\n            \"notes\": \"Please use extra packaging\"\n        },\n    ],\n    \"meta\": {\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"prev_page\": null,\n        \"total_pages\": 1,\n        \"total_count\": 3,\n        \"last_updated_at\": \"2016-05-05T19:51:05Z\",\n        \"status\": [\n            \"ready_for_shipment\",\n            \"shipped\",\n            \"cleared\"\n        ]\n    }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5436b155b7cf0e1c0020dab2","ref":"","in":"query","required":false,"desc":"The page to return in the paginated result set","default":"1","type":"int","name":"page"},{"_id":"5436b155b7cf0e1c0020dab1","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":"5436b155b7cf0e1c0020dab0","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=2017-05-24T19:38:25.000-00:00","default":"1 week ago","type":"datetime","name":"last_updated_at"},{"_id":"5436b155b7cf0e1c0020daaf","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_string","name":"status"},{"_id":"57e1d9b59e590717008c9195","ref":"","in":"query","required":false,"desc":"Adds information to the response. Specifying includes=products will deliver additional information (if available) about each product in the order.","default":"","type":"string","name":"includes"},{"_id":"59b95397f387380010ccf1d1","ref":"","in":"query","required":false,"desc":"The external_order_identifier to search for","default":"","type":"string","name":"order_number"},{"_id":"5c76a5c551aaf700135c9037","ref":"","in":"query","required":false,"desc":"Filters the results by tags that have been applied to the order. Specifying one or more tags limits the results to only orders that have at least one of the specified tags.","default":"","type":"array_string","name":"tags"}],"url":"/api/orders"},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Product Information\"\n}\n[/block]\nEach order contains one or more line items and each line item specifies a product. If additional information about the product has been specified in the ShippingEasy product catalog, then that additional information will be included if the optional _includes=products_ parameter is specified.\n\nThe additional information is in the product node within the line_items node. Here is an example of a line_items node when the _includes=products_ parameter was specified.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"          \\\"line_items\\\": [\\n            {\\n              \\\"item_name\\\": \\\"Alias Name\\\",\\n              \\\"sku\\\": \\\"alias-1-sku\\\",\\n              \\\"bin_picking_number\\\": \\\"bin-111\\\",\\n              \\\"bundled_product\\\": null,\\n              \\\"weight_in_ounces\\\": \\\"16.0\\\",\\n              \\\"quantity\\\": 1,\\n              \\\"total_excluding_tax\\\": \\\"33.00\\\",\\n              \\\"price_excluding_tax\\\": \\\"0.00\\\",\\n              \\\"unit_price\\\": \\\"33.00\\\",\\n              \\\"ext_line_item_id\\\": null,\\n              \\\"ext_product_id\\\": null,\\n              \\\"product_options\\\": null,\\n              \\\"uuid\\\": \\\"a5c9a0f5-76f8-44c2-83f9-33e575036431\\\",\\n              \\\"order_source_id\\\": 403009,\\n              \\\"gift_message\\\": null,\\n              \\\"product\\\": {\\n                \\\"id\\\": 19409,\\n                \\\"description\\\": \\\"The master SKU\\\",\\n                \\\"sku\\\": \\\"master-sku-1\\\",\\n                \\\"weight_in_ounces\\\": \\\"16.0\\\",\\n                \\\"bin_picking_number\\\": \\\"bin-111\\\",\\n                \\\"upc\\\": \\\"UPC-0929\\\",\\n                \\\"asin\\\": \\\"ASIN-3292\\\",\\n                \\\"isbn\\\": \\\"ISBN-2929\\\",\\n                \\\"length_as_inches\\\": \\\"4.0\\\",\\n                \\\"width_as_inches\\\": \\\"3.0\\\",\\n                \\\"height_as_inches\\\": \\\"3.0\\\",\\n                \\\"country_of_manufacture\\\": \\\"United States of America\\\",\\n                \\\"harmonized_code\\\": \\\"008080\\\",\\n                \\\"declared_value\\\": \\\"99.00\\\",\\n                \\\"active\\\": true,\\n                \\\"sku_aliases\\\": [\\n                  \\\"alias-1-sku\\\"\\n                ],\\n                \\\"properties\\\": [\\n                  \\n                ],\\n                \\\"product_category_name\\\": \\\"Mens T-Shirts\\\"\\n                \\\"image\\\":{\\n\\\"thumb\\\":\\\"https://se-files-production.s3.amazonaws.com//products/images/000/053/329/thumb/wireless_1_20070813new__42329.1256533712.120.1.png\\\",\\n\\\"medium\\\":\\\"https://se-files-production.s3.amazonaws.com//products/images/000/053/329/medium/wireless_1_20070813new__42329.1256533712.120.1.png\\\",\\n\\\"original\\\":\\\"https://se-files-production.s3.amazonaws.com//products/images/000/053/329/original/wireless_1_20070813new__42329.1256533712.120.1.jpg\\\"\\n\\t\\t\\t\\t\\t\\t\\t\\t}\\n              }\\n            }\\n          ],\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","excerpt":"Search and filter orders account-wide","slug":"orders","type":"endpoint","title":"/orders"}

get/orders

Search and filter orders account-wide

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 stringsshipped
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
tags:
array of strings
Filters the results by tags that have been applied to the order. Specifying one or more tags limits the results to only orders that have at least one of the specified tags.

Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Product Information" } [/block] Each order contains one or more line items and each line item specifies a product. If additional information about the product has been specified in the ShippingEasy product catalog, then that additional information will be included if the optional _includes=products_ parameter is specified. The additional information is in the product node within the line_items node. Here is an example of a line_items node when the _includes=products_ parameter was specified. [block:code] { "codes": [ { "code": " \"line_items\": [\n {\n \"item_name\": \"Alias Name\",\n \"sku\": \"alias-1-sku\",\n \"bin_picking_number\": \"bin-111\",\n \"bundled_product\": null,\n \"weight_in_ounces\": \"16.0\",\n \"quantity\": 1,\n \"total_excluding_tax\": \"33.00\",\n \"price_excluding_tax\": \"0.00\",\n \"unit_price\": \"33.00\",\n \"ext_line_item_id\": null,\n \"ext_product_id\": null,\n \"product_options\": null,\n \"uuid\": \"a5c9a0f5-76f8-44c2-83f9-33e575036431\",\n \"order_source_id\": 403009,\n \"gift_message\": null,\n \"product\": {\n \"id\": 19409,\n \"description\": \"The master SKU\",\n \"sku\": \"master-sku-1\",\n \"weight_in_ounces\": \"16.0\",\n \"bin_picking_number\": \"bin-111\",\n \"upc\": \"UPC-0929\",\n \"asin\": \"ASIN-3292\",\n \"isbn\": \"ISBN-2929\",\n \"length_as_inches\": \"4.0\",\n \"width_as_inches\": \"3.0\",\n \"height_as_inches\": \"3.0\",\n \"country_of_manufacture\": \"United States of America\",\n \"harmonized_code\": \"008080\",\n \"declared_value\": \"99.00\",\n \"active\": true,\n \"sku_aliases\": [\n \"alias-1-sku\"\n ],\n \"properties\": [\n \n ],\n \"product_category_name\": \"Mens T-Shirts\"\n \"image\":{\n\"thumb\":\"https://se-files-production.s3.amazonaws.com//products/images/000/053/329/thumb/wireless_1_20070813new__42329.1256533712.120.1.png\",\n\"medium\":\"https://se-files-production.s3.amazonaws.com//products/images/000/053/329/medium/wireless_1_20070813new__42329.1256533712.120.1.png\",\n\"original\":\"https://se-files-production.s3.amazonaws.com//products/images/000/053/329/original/wireless_1_20070813new__42329.1256533712.120.1.jpg\"\n\t\t\t\t\t\t\t\t}\n }\n }\n ],", "language": "javascript" } ] } [/block]