{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/api/stores/:store_api_key/orders/:external_order_identifier/status","auth":"required","examples":{"codes":[{"language":"json","code":"{\"order\":{\"order_status\":\"awaiting_payment\"}}","name":"Example payload"}]},"method":"put","params":[{"name":"store_api_key","type":"string","default":"","desc":"Found in the user interface of ShippingEasy, as described on the [API Credentials](doc:api-credentials) page.","required":false,"in":"path","ref":"","_id":"561e61faefcf8217003adfcb"},{"name":"external_order_identifier","type":"string","default":"","desc":"The same value you used when creating the order. It is typically the ID used in your e-commerce system.","required":false,"in":"path","ref":"","_id":"561e61faefcf8217003adfca"}],"results":{"codes":[{"code":"{\n    \"order\": {\n        \"id\": 217055,\n        \"external_order_identifier\": \"ABC-1633\",\n        \"ext_order_reference_id\": \"ABC-1633\",\n        \"owner_id\": null,\n        \"ordered_at\": \"2016-02-11T20:37:56Z\",\n        \"order_status\": \"ready_for_shipment\",\n        \"parent_order_id\": null,\n        \"source_order_ids\": null,\n        \"total_including_tax\": \"10.00\",\n        \"total_excluding_tax\": \"10.00\",\n        \"discount_amount\": \"0.00\",\n        \"coupon_discount\": \"0.00\",\n        \"subtotal_including_tax\": \"10.00\",\n        \"subtotal_excluding_tax\": \"0.00\",\n        \"subtotal_tax\": \"0.00\",\n        \"total_tax\": \"0.00\",\n        \"base_shipping_cost\": \"0.00\",\n        \"shipping_cost_including_tax\": \"0.00\",\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\": \"Compnay Billing name test 1\",\n        \"billing_first_name\": \"Jack\",\n        \"billing_last_name\": \"Rico\",\n        \"billing_address\": \"1560 Ave Comerio\",\n        \"billing_address2\": \"\",\n        \"billing_city\": \"Bayamon\",\n        \"billing_state\": \"\",\n        \"billing_country\": \"PR\",\n        \"billing_postal_code\": \"00961\",\n        \"billing_phone_number\": \"3235735009\",\n        \"billing_email\": \"jack:::at:::shippingeasy.com\",\n        \"recipients\": [\n            {\n                \"company\": \"\",\n                \"first_name\": \"Jack\",\n                \"last_name\": \"Shipping\",\n                \"address\": \"1560 Ave Comerio\",\n                \"address2\": \"\",\n                \"address3\": null,\n                \"city\": \"Bayamon\",\n                \"residential\": false,\n                \"state\": null,\n                \"province\": null,\n                \"country\": \"United States\",\n                \"postal_code\": \"00961\",\n                \"postal_code_plus_4\": \"3962\",\n                \"phone_number\": \"3235735009\",\n                \"email\": \"[email protected]\",\n                \"base_cost\": \"10.00\",\n                \"cost_excluding_tax\": \"10.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\": 123,\n                \"shipping_zone_name\": \"XYZ\",\n                \"items_total\": 1,\n                \"shipping_method\": \"Ground\",\n                \"items_shipped\": 0,\n                \"ext_shipping_detail_id\": null,\n                \"line_items\": [\n                    {\n                        \"item_name\": \"Innokin MVP 3 PRO KIT\",\n                        \"sku\": \"I_MVP_4\",\n                        \"bin_picking_number\": null,\n                        \"bundled_product\": null,\n                        \"weight_in_ounces\": \"1.0\",\n                        \"quantity\": 1,\n                        \"total_excluding_tax\": \"10.00\",\n                        \"price_excluding_tax\": \"0.00\",\n                        \"unit_price\": \"10.00\",\n                        \"ext_line_item_id\": null,\n                        \"ext_product_id\": null,\n                        \"product_options\": null,\n                        \"uuid\": \"32b600b3-0381-43b2-9527-04ab2d2291b5\",\n                        \"order_source_id\": 87168,\n                        \"gift_message\": null\n                    }\n                ],\n                \"original_order\": {\n                    \"id\": 217055,\n                    \"customer_id\": 371,\n                    \"store_id\": 1672,\n                    \"order_detail_id\": 217095,\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\": \"1.0\",\n                    \"total_quantity\": 1,\n                    \"is_international\": false,\n                    \"usps_shipping_zone\": 8,\n                    \"created_at\": \"2016-02-12T17:14:40Z\",\n                    \"updated_at\": \"2016-05-20T13:45:25Z\",\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\": \"innokin mvp 3 pro kit\",\n                    \"line_item_sku\": \"i_mvp_4\",\n                    \"address_kind\": \"C\",\n                    \"recipient_last_name\": \"shipping\",\n                    \"recipient_requested_service\": \"ground\",\n                    \"gift\": false,\n                    \"prime_order_id\": 217055,\n                    \"state\": null,\n                    \"owner_id\": null,\n                    \"denormalized_ordered_at\": \"2016-02-11T20:37:56Z\",\n                    \"grab_bag\": {},\n                    \"line_item_bin_picking_number\": null,\n                    \"denormalized_ext_order_id\": \"ABC-1633\",\n                    \"packing_slip_generated\": null,\n                    \"denormalized_ext_order_reference_id\": \"ABC-1633\",\n                    \"denormalized_alternate_order_id\": null,\n                    \"denormalized_sales_channel\": null\n                }\n            }\n        ],\n        \"store_api_key\": \"c29928ea5f96c34c05241682d23a9f37\",\n        \"shipments\": [],\n        \"updated_at\": \"2016-05-20T13:45:25Z\",\n        \"internal_notes\": \"\",\n        \"meta_data\": null,\n        \"prime_order_id\": 217055,\n        \"is_prime\": null,\n        \"split_from_order_id\": null\n    }\n}","name":"","status":200,"language":"json"}]},"settings":""},"next":{"description":"","pages":[]},"title":"/stores/:store_api_key/orders/:external_order_identifier/status","type":"endpoint","slug":"storesstore_api_keyordersexternal_order_identifier","excerpt":"Update the status of an order","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parameter values\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**Field**\",\n    \"0-1\": \"**Description**\",\n    \"1-0\": \"order_status\",\n    \"1-1\": \"Store order status for the order. Must be one of:\\n\\nawaiting_payment\\n\\nawaiting_fulfillment\\n\\nawaiting_shipment\\n\\npartially_shipped\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nNote that the value that is being changed is the store_order_status in the original_order node. This value is displayed in the Status column on the Orders page in the ShippingEasy user interface.  The Orders page in ShippingEasy has a filter setting for Status.","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c097a0265263a0216070bc7","editedParams2":true,"__v":4,"parentDoc":null,"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"},"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},"githubsync":"","editedParams":true,"project":"5436a1e1d0ffee0e00f18f8c","createdAt":"2015-03-13T22:08:02.388Z"}

put/stores/:store_api_key/orders/:external_order_identifier/status

Update the status of an order

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

store_api_key:
string
Found in the user interface of ShippingEasy, as described on the [API Credentials](doc:api-credentials) page.
external_order_identifier:
string
The same value you used when creating the order. It is typically the ID used in your e-commerce system.

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Parameter values" } [/block] [block:parameters] { "data": { "0-0": "**Field**", "0-1": "**Description**", "1-0": "order_status", "1-1": "Store order status for the order. Must be one of:\n\nawaiting_payment\n\nawaiting_fulfillment\n\nawaiting_shipment\n\npartially_shipped" }, "cols": 2, "rows": 2 } [/block] Note that the value that is being changed is the store_order_status in the original_order node. This value is displayed in the Status column on the Orders page in the ShippingEasy user interface. The Orders page in ShippingEasy has a filter setting for Status.