Update Shipment Details

PUT {{baseUrl}}/shipments/:shipment_id

You can update specific Shipment Details by providing the ID of the shipment you want to update its details.

Request Body

{"shipment_number"=>"<string>", "tracking_link"=>"<string>", "tracking_number"=>"<string>", "status"=>"in_progress", "pdf_label"=>"<string>", "cost"=>"<integer>"}

HEADERS

RESPONSES

status: OK

{"status":"\u003cstring\u003e","success":"\u003cstring\u003e","data":{"order_id":"\u003cinteger\u003e","id":"\u003cinteger\u003e","created_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"},"type":"return","courier_id":"\u003cinteger\u003e","courier_name":"\u003cstring\u003e","courier_logo":"\u003cstring\u003e","shipping_number":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","pickup_id":{"description":"Shipment Pickup ID","nullable":true,"example":"10954392"},"trackable":"\u003cboolean\u003e","tracking_link":"\u003cstring\u003e","label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"payment_method":"cod","source":"\u003cstring\u003e","status":"in_progress","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"is_international":"\u003cboolean\u003e","total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":[{"name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cinteger\u003e","weight":{"value":"\u003cinteger\u003e","unit":"lb"}},{"name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cinteger\u003e","weight":{"value":"\u003cinteger\u003e","unit":"lb"}}],"ship_from":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":{"description":"Shipment Ship From Street Number","nullable":true,"example":"120B"},"block":{"description":"Shipment Ship From Block","nullable":true,"example":"Block AB"},"postal_code":{"description":"Shipment Ship From Postal Code","nullable":true,"example":"1000"},"latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e","branch_id":"\u003cinteger\u003e"},"ship_to":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e"},"meta":{"app_id":"\u003cinteger\u003e","policy_options":{"boxes":"\u003cinteger\u003e"}}}}