/stores/:store_api_key/orders/:external_order

Parameter values


Field	Description
order_status	Store order status for the order. Must be one of: awaiting_payment awaiting_fulfillment awaiting_shipment partially_shipped

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.

Example Payload:

{"order":{"order_status":"awaiting_payment"}}

200

Response body

object

order

object

integer

Defaults to 0

external_order_identifier

string

ext_order_reference_id

string

owner_id

string

ordered_at

string

order_status

string

parent_order_id

string

source_order_ids

string

total_including_tax

string

total_excluding_tax

string

discount_amount

string

coupon_discount

string

subtotal_including_tax

string

subtotal_excluding_tax

string

subtotal_tax

string

total_tax

string

base_shipping_cost

string

shipping_cost_including_tax

string

shipping_cost_excluding_tax

string

shipping_cost_tax

string

base_handling_cost

string

handling_cost_excluding_tax

string

handling_cost_including_tax

string

handling_cost_tax

string

base_wrapping_cost

string

wrapping_cost_excluding_tax

string

wrapping_cost_including_tax

string

wrapping_cost_tax

string

billing_company

string

billing_first_name

string

billing_last_name

string

billing_address

string

billing_address2

string

billing_city

string

billing_state

string

billing_country

string

billing_postal_code

string

billing_phone_number

string

billing_email

string

recipients

array of objects

recipients

object

company

string

first_name

string

last_name

string

address

string

address2

string

address3

string

city

string

residential

boolean

Defaults to true

state

string

province

string

country

string

postal_code

string

postal_code_plus_4

string

phone_number

string

base_cost

string

cost_excluding_tax

string

cost_including_tax

string

cost_tax

string

base_handling_cost

string

handling_cost_excluding_tax

string

handling_cost_including_tax

string

handling_cost_tax

string

shipping_zone_id

integer

Defaults to 0

shipping_zone_name

string

items_total

integer

Defaults to 0

shipping_method

string

items_shipped

integer

Defaults to 0

ext_shipping_detail_id

string

line_items

array of objects

line_items

object

item_name

string

sku

string

bin_picking_number

string

bundled_product

string

weight_in_ounces

string

quantity

integer

Defaults to 0

total_excluding_tax

string

price_excluding_tax

string

unit_price

string

ext_line_item_id

string

ext_product_id

string

product_options

string

uuid

string

order_source_id

integer

Defaults to 0

gift_message

string

original_order

object

store_api_key

string

shipments

array

shipments

updated_at

string

internal_notes

string

meta_data

string

prime_order_id

integer

Defaults to 0

is_prime

string

split_from_order_id

string

Parameter values

200200

400400