Update Order Shipment

PUT {{baseUrl}}/orders/:order.id/update-shipment

You can update specific Order Shipment Details (tracking link, shipment number, pdf label and shipment type) by providing the ID of the order you want to update its details in the order.id path parameter.

OAuth Scopes

---

orders.read orders.read_write

Request Body

{"tracking_link"=>"https://api.shipengine.com/v1/labels/498498496/track", "shipment_number"=>"846984645", "pdf_label"=>"https://api.shipengine.com/v1/downloads/10/F91fByOB-0aJJadf7JLeww/label-63563751.pdf", "shipment_type"=>"return"}

HEADERS

RESPONSES

status: Created

{"status":201,"success":true,"data":{"id":1952263404,"reference_id":16396873,"urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profile"},"date":{"date":"2021-05-27 22:40:39.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"status":{"id":566146469,"name":"بإنتظار المراجعة","customized":{"id":936686497,"name":"بإنتظار المراجعة"}},"payment_method":"bank","currency":"SAR","amounts":{"sub_total":{"amount":10,"currency":"SAR"},"shipping_cost":{"amount":24,"currency":"SAR"},"cash_on_delivery":{"amount":0,"currency":"SAR"},"tax":{"percent":"10.00","amount":{"amount":3.4,"currency":"SAR"}},"discounts":[],"total":{"amount":37.4,"currency":"SAR"}},"shipping":{"id":-7,"company":"ارامكس","receiver":{"name":"Mohammed Ali","email":"alimohammed@test.test","phone":"1237234782348"},"shipper":{"name":"Ali Mohammed","company_name":"تين و زيتون ","email":"mohammedali@test.test","phone":"96123453563464356575686"},"pickup_address":{"country":"السعودية","city":"مكة","shipping_address":"عبدالله,7777, 7777 عبدالله ,  مكة 12342343 1242423 السعودية, مكة,السعودية","street_number":"عبدالله","block":"Test","postal_code":"77777","geo_coordinates":{"lat":21.391231230898985,"lng":39.885490022353466}},"address":{"country":"SA","city":"مكة","shipping_address":" شارع بعيد، الحي 1242342342448،, فندق ,, مكة, السعودية","street_number":"بعيد","block":"test","postal_code":"113213412344","geo_coordinates":{"lat":0,"lng":0}},"shipment":{"id":"se-test","pickup_id":null,"tracking_link":"https://www.tracking-link.com"}},"can_cancel":false,"shipment_branch":[],"customer":{"id":1818965688,"first_name":"Mohammed","last_name":"Ali","mobile":509580868,"mobile_code":"+966","email":"test@test.test","urls":{"customer":"https://shtara.com/profile","admin":"https://shtara.com/profile"},"avatar":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","gender":"male","city":"جدة","country":"السعودية","currency":"SAR","location":"Riyadh","updated_at":{"date":"2021-05-31 14:12:48.000000","timezone_type":3,"timezone":"Asia/Riyadh"}},"bank":{"id":5884,"bank_name":"بنك تجريبي","account_name":"متجر تجريبي","account_number":"11111111111","iban_number":"11111","status":"active"},"items":[{"id":125579301,"name":"بصل ذهبي","sku":"","quantity":1,"currency":"SAR","weight":0.1,"amounts":{"price_without_tax":{"amount":10,"currency":"SAR"},"total_discount":{"amount":0,"currency":"SAR"},"tax":{"percent":"10.00","amount":{"amount":0,"currency":"SAR"}},"total":{"amount":10,"currency":"SAR"}},"notes":"","product":{"id":119829002,"type":"product","promotion":{"title":null,"sub_title":"twitter.com"},"status":"sale","is_available":true,"sku":"","name":"بصل ذهبي","price":{"amount":11,"currency":"SAR"},"sale_price":{"amount":0,"currency":"SAR"},"currency":"SAR","url":"https://shtara.com/lGRGrQ","thumbnail":"https://i.ibb.co/jyqRQfQ/avatar-male.webp","has_special_price":false,"regular_price":{"amount":11,"currency":"SAR"},"favorite":null},"options":[],"images":[],"codes":[],"files":[]}],"tags":[]}}