Update an order

PUT {{baseUrl}}/orders/:id

Note that this section describes a beta version of the Orders API. Currently only Sendcloud API integrations are supported. This method allows to update a single specific order.

Request Body

{"order_id"=>"<string>", "order_number"=>"<string>", "order_details"=>{"integration"=>{"id"=>"<integer>"}, "status"=>{"code"=>"<string>", "message"=>"<string>"}, "order_created_at"=>"<dateTime>", "order_items"=>[{"name"=>"<string>", "quantity"=>"<integer>", "total_price"=>{"value"=>"<number>", "currency"=>"USD"}, "item_id"=>"<string>", "product_id"=>"<string>", "variant_id"=>"<string>", "image_url"=>"<string>", "description"=>"<string>", "sku"=>"<string>", "hs_code"=>"<string>", "country_of_origin"=>"<string>", "properties"=>{"deserunt__9"=>false}, "unit_price"=>{"value"=>"<number>", "currency"=>"GBP"}, "measurement"=>{"dimension"=>{"length"=>"<number>", "width"=>"<number>", "height"=>"<number>", "unit"=>"m"}, "weight"=>{"value"=>"<number>", "unit"=>"kg"}, "volume"=>{"value"=>"<integer>", "unit"=>"ml"}}, "ean"=>"<string>", "delivery_dates"=>{"handover_at"=>"<dateTime>"}, "mid_code"=>"<string,null>", "material_content"=>"<string,null>", "intended_use"=>"<string,null>"}, {"name"=>"<string>", "quantity"=>"<integer>", "total_price"=>{"value"=>"<number>", "currency"=>"GBP"}, "item_id"=>"<string>", "product_id"=>"<string>", "variant_id"=>"<string>", "image_url"=>"<string>", "description"=>"<string>", "sku"=>"<string>", "hs_code"=>"<string>", "country_of_origin"=>"<string>", "properties"=>{"dolore3f0"=>26976356, "irure_e"=>true}, "unit_price"=>{"value"=>"<number>", "currency"=>"GBP"}, "measurement"=>{"dimension"=>{"length"=>"<number>", "width"=>"<number>", "height"=>"<number>", "unit"=>"yd"}, "weight"=>{"value"=>"<number>", "unit"=>"oz"}, "volume"=>{"value"=>"<integer>", "unit"=>"gal"}}, "ean"=>"<string>", "delivery_dates"=>nil, "mid_code"=>"<string,null>", "material_content"=>"<string,null>", "intended_use"=>"<string,null>"}], "order_updated_at"=>"<dateTime>", "notes"=>"<string>"}, "payment_details"=>{"total_price"=>{"value"=>"<number>", "currency"=>"USD"}, "status"=>{"code"=>"<string>", "message"=>"<string>"}, "is_cash_on_delivery"=>"<boolean,null>", "subtotal_price"=>{"value"=>"<number>", "currency"=>"EUR"}, "estimated_shipping_price"=>{"value"=>"<number>", "currency"=>"EUR"}, "estimated_tax_price"=>{"value"=>"<number>", "currency"=>"EUR"}, "invoice_date"=>"<string,null>", "discount_granted"=>{"value"=>"74708826.22327570", "currency"=>"<string,null>"}, "insurance_costs"=>{"value"=>"666978", "currency"=>"<string,null>"}, "freight_costs"=>{"value"=>"4.7", "currency"=>"<string,null>"}, "other_costs"=>{"value"=>"55", "currency"=>"<string,null>"}}, "id"=>"<string>", "created_at"=>"<dateTime>", "modified_at"=>"<dateTime>", "customs_details"=>nil, "customer_details"=>{"name"=>"<string>", "phone_number"=>"<string>", "email"=>"<string>"}, "billing_address"=>{"name"=>"<string>", "company_name"=>"<string>", "address_line_1"=>"<string>", "house_number"=>"<string>", "address_line_2"=>"<string>", "postal_code"=>"<string>", "city"=>"<string>", "po_box"=>"<string,null>", "state_province_code"=>"<string>", "country_code"=>"<string>", "email"=>"<email>", "phone_number"=>"<string>"}, "shipping_address"=>{"name"=>"<string>", "company_name"=>"<string>", "address_line_1"=>"<string>", "house_number"=>"<string>", "address_line_2"=>"<string>", "postal_code"=>"<string>", "city"=>"<string>", "po_box"=>"<string,null>", "state_province_code"=>"<string>", "country_code"=>"<string>", "email"=>"<email>", "phone_number"=>"<string>"}, "shipping_details"=>{"is_local_pickup"=>"<boolean,null>", "delivery_indicator"=>"<string>", "measurement"=>{"dimension"=>{"length"=>"<number>", "width"=>"<number>", "height"=>"<number>", "unit"=>"yd"}, "weight"=>{"value"=>"<number>", "unit"=>"g"}, "volume"=>{"value"=>"<integer>", "unit"=>"l"}}}, "service_point_details"=>{"id"=>"<string>", "post_number"=>"<string>", "latitude"=>"<string>", "longitude"=>"<string>", "type"=>"<string>", "extra_data"=>{"minimfd8"=>"est ex dolor", "consequat_238"=>"consequat veniam proident"}}}

HEADERS

RESPONSES

status: OK

{"data":{"id":"\u003cinteger\u003e","order_id":"\u003cstring\u003e","order_number":"\u003cstring\u003e"}}