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.

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", "cost"=>40}

HEADERS

RESPONSES

status: Created

{"status":201,"success":true,"data":{"id":2098764685,"reference_id":40436266,"urls":{"customer":"https://salla.sa/dev-wofftr4xsra5xtlv/order/AB3exRyLdXv5Wp8LEb7WrGg4p7Ej8ZKl","admin":"https://s.salla.sa/orders/order/AB3exRyLdXv5Wp8LEb7WrGg4p7Ej8ZKl"},"date":{"date":"2022-06-15 10:42:53.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"source":"dashboard","source_device":"desktop","source_details":{"type":"dashboard","value":null,"device":"desktop","user-agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36","ip":null},"first_complete_at":{"date":"2022-06-19 20:18:12.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"status":{"id":1298199463,"name":"تم التنفيذ","slug":"completed","customized":{"id":1295990863,"name":"تم التنفيذ"}},"payment_method":"bank","currency":"SAR","amounts":{"sub_total":{"amount":224,"currency":"SAR"},"shipping_cost":{"amount":35,"currency":"SAR"},"cash_on_delivery":{"amount":0,"currency":"SAR"},"tax":{"percent":"0.00","amount":{"amount":0,"currency":"SAR"}},"discounts":[],"total":{"amount":259,"currency":"SAR"}},"shipping":{"id":1935030040,"app_id":"2032004508","company":"Shipping App","logo":"https://salla-dev-portal.s3.eu-central-1.amazonaws.com/uploads/T3GFoIZXP7BsIKMEfdL3XoT9rxSXZN9WpKoFifa8.png","receiver":{"name":"Del Don","email":"xdel1010@gmail.com","phone":"971555555555"},"shipper":{"name":"Demo","company_name":"dev-wofftr4xsra5xtlv","email":"wofftr4xsra5xtlv@email.partners","phone":"966500000000"},"pickup_address":{"country":"السعودية","country_code":"SA","city":"مكة","shipping_address":"شارع عبدالله,السلام,23233, سنابل السلام, مكة,السعودية","street_number":"شارع عبدالله","block":"السلام","postal_code":"23233","geo_coordinates":{"lat":21.3825905096851,"lng":39.77319103068542}},"address":{"country":"SA","country_code":"SA","city":"جدة","shipping_address":" شارع Abu tamimah، الحي azzahraaa 23233،, 5,, جدة, السعودية","street_number":"Abu tamimah","block":"azzahraaa","postal_code":"23233","geo_coordinates":{"lat":0,"lng":0}},"shipment":{"id":"846984645","pickup_id":null,"tracking_link":"https://api.shipengine.com/v1/labels/498498496/track","label":{"format":"pdf","url":"https://api.shipengine.com/v1/downloads/10/F91fByOB-0aJJadf7JLeww/label-63563751.pdf"}},"policy_options":[]},"can_cancel":false,"can_reorder":true,"is_pending_payment":false,"pending_payment_ends_at":0,"rating_link":"https://store-test.com/rating-link","shipment_branch":[],"customer":{"id":1550968832,"first_name":"Del","last_name":"Don","mobile":555555555,"mobile_code":"+971","email":"xdel1010@gmail.com","urls":{"customer":"https://salla.sa/dev-wofftr4xsra5xtlv/profile","admin":"https://s.salla.sa/customers/rEwgmvek0zQVGMvOovm18RX9qY7LPNoZ"},"avatar":"https://store-test.com/cp/assets/images/avatar_male.png","gender":"male","birthday":{"date":"1998-07-01 00:00:00.000000","timezone_type":3,"timezone":"Asia/Riyadh"},"city":"","country":"الامارات","country_code":null,"currency":"SAR","location":"","updated_at":{"date":"2022-06-19 20:19:22.000000","timezone_type":3,"timezone":"Asia/Riyadh"}},"items":[{"id":971483747,"name":"خاص","sku":"","quantity":1,"currency":"SAR","weight":0.1,"amounts":{"price_without_tax":{"amount":50,"currency":"SAR"},"total_discount":{"amount":0,"currency":"SAR"},"tax":{"percent":"0.00","amount":{"amount":0,"currency":"SAR"}},"total":{"amount":50,"currency":"SAR"}},"notes":"","product":{"id":1326792934,"type":"product","promotion":{"title":null,"sub_title":null},"status":"hidden","is_available":false,"sku":"","name":"خاص","price":{"amount":50,"currency":"SAR"},"sale_price":{"amount":0,"currency":"SAR"},"currency":"SAR","url":"https://salla.sa/dev-wofftr4xsra5xtlv/خاص/p1326792934","thumbnail":null,"has_special_price":false,"regular_price":{"amount":50,"currency":"SAR"},"calories":null,"mpn":null,"gtin":null,"favorite":null},"options":[],"images":[],"codes":[],"files":[]},{"id":1770008272,"name":"فستان","sku":"15504447-30000023080-","quantity":1,"currency":"SAR","weight":0.25,"amounts":{"price_without_tax":{"amount":174,"currency":"SAR"},"total_discount":{"amount":0,"currency":"SAR"},"tax":{"percent":"0.00","amount":{"amount":0,"currency":"SAR"}},"total":{"amount":174,"currency":"SAR"}},"notes":"","product":{"id":901887406,"type":"product","promotion":{"title":null,"sub_title":null},"status":"sale","is_available":true,"sku":"15504447-30000023080-","name":"فستان","price":{"amount":174,"currency":"SAR"},"sale_price":{"amount":174,"currency":"SAR"},"currency":"SAR","url":"https://salla.sa/dev-wofftr4xsra5xtlv/فستان/p901887406","thumbnail":"https://salla-dev.s3.eu-central-1.amazonaws.com/nWzD/bL3FLXsYnlcjdn2TbeSdXh1y6nhiXWkzg7bMV9Lf.jpg","has_special_price":true,"regular_price":{"amount":200,"currency":"SAR"},"calories":null,"mpn":null,"gtin":null,"favorite":null},"options":[{"id":1864177671,"product_option_id":449678114,"name":"المقاس","type":"radio","value":{"id":777450097,"name":"42 - L","price":{"amount":0,"currency":"SAR"}}}],"images":[],"codes":[],"files":[]}],"bank":{"id":326553500,"bank_name":"البنك الأهلي التجاري","bank_id":1473353380,"account_name":"Demo Account","account_number":"000000608010167519","iban_number":"SA2380000382608010130308","status":"active"},"tags":[{"id":1651861126,"name":"توصيل سريع"}]}}