Update an order

PATCH {{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 only specified fields of any order.

Request Body

{"id"=>"<string>", "order_id"=>"<string>", "order_number"=>"<string>", "created_at"=>"<dateTime>", "modified_at"=>"<dateTime>", "order_details"=>{"integration"=>{"id"=>"<integer>"}, "status"=>{"code"=>"<string>", "message"=>"<string>"}, "order_created_at"=>"<dateTime>", "order_updated_at"=>"<dateTime>", "order_items"=>[{"item_id"=>"<string>", "product_id"=>"<string>", "name"=>"<string>", "description"=>"<string>", "quantity"=>"<integer>", "sku"=>"<string>", "hs_code"=>"<string>", "country_of_origin"=>"<string>", "properties"=>{"commodo_4"=>"aute officia ut", "nisi81d"=>-36779175.60598929}, "unit_price"=>{"value"=>"<number>", "currency"=>"GBP"}, "total_price"=>{"value"=>"<number>", "currency"=>"GBP"}, "measurement"=>{"dimension"=>{"length"=>"<number>", "width"=>"<number>", "height"=>"<number>", "unit"=>"mm"}, "weight"=>{"value"=>"<number>", "unit"=>"oz"}, "volume"=>{"value"=>"<integer>", "unit"=>"cm3"}}, "mid_code"=>"<string,null>", "material_content"=>"<string,null>", "intended_use"=>"<string,null>", "delivery_dates"=>nil}, {"item_id"=>"<string>", "product_id"=>"<string>", "name"=>"<string>", "description"=>"<string>", "quantity"=>"<integer>", "sku"=>"<string>", "hs_code"=>"<string>", "country_of_origin"=>"<string>", "properties"=>{"dolore8e"=>true, "officiaa75"=>26156012.724141896}, "unit_price"=>{"value"=>"<number>", "currency"=>"GBP"}, "total_price"=>{"value"=>"<number>", "currency"=>"EUR"}, "measurement"=>{"dimension"=>{"length"=>"<number>", "width"=>"<number>", "height"=>"<number>", "unit"=>"in"}, "weight"=>{"value"=>"<number>", "unit"=>"oz"}, "volume"=>{"value"=>"<integer>", "unit"=>"ml"}}, "mid_code"=>"<string,null>", "material_content"=>"<string,null>", "intended_use"=>"<string,null>", "delivery_dates"=>nil}]}, "payment_details"=>{"total_price"=>{"value"=>"<number>", "currency"=>"GBP"}, "subtotal_price"=>{"value"=>"<number>", "currency"=>"EUR"}, "estimated_shipping_price"=>{"value"=>"<number>", "currency"=>"EUR"}, "estimated_tax_price"=>{"value"=>"<number>", "currency"=>"EUR"}, "status"=>{"code"=>"<string>", "message"=>"<string>"}, "invoice_date"=>"<string,null>", "discount_granted"=>{"value"=>"6646520040.3323787", "currency"=>"<string,null>"}, "insurance_costs"=>{"value"=>"46718984.5260", "currency"=>"<string,null>"}, "freight_costs"=>{"value"=>"1713", "currency"=>"<string,null>"}, "other_costs"=>{"value"=>"6140", "currency"=>"<string,null>"}}, "customs_details"=>{"commercial_invoice_number"=>"<string>", "shipment_type"=>"commercial_goods"}, "tax_numbers"=>nil, "customer_details"=>{"name"=>"<string>", "phone"=>"<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"=>{"measurement"=>{"dimension"=>{"length"=>"<number>", "width"=>"<number>", "height"=>"<number>", "unit"=>"mm"}, "weight"=>{"value"=>"<number>", "unit"=>"g"}, "volume"=>{"value"=>"<integer>", "unit"=>"gal"}}}, "service_point_details"=>{"id"=>"<string>", "post_number"=>"<string>", "latitude"=>"<string>", "longitude"=>"<string>", "type"=>"<string>"}}

HEADERS

RESPONSES

status: OK

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