Update a Shipment
After you create a shipment, you might need to update it once you've packed a box, and know more information. You will need to use the shipment_id
that was provided before in the request URL.
Now that we know more about our shipment, we're going to add in the same parameters we used in Size & Weight to update our shipment.
Example
PUT /v1/shipments/:shipment_id
You need to provide the ship_to
, and either theship_from
or warehouse_id
property for updating the shipment along with the other properties that you would like to update.
Shipment Update Request
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
PUT /v1/shipments/se-202902255 HTTP/1.1Host: api.shipengine.comAPI-Key: __YOUR_API_KEY_HERE__Content-Type: application/json{"validate_address": "no_validation","carrier_id": "se-123890","service_code": "usps_priority_mail","external_shipment_id": "1daa0c22-0519-46d0-8653-9f3dc62e7d2c","ship_date": "2019-07-25T05:00:00.000Z","created_at": "2019-07-25T15:24:46.657Z","modified_at": "2019-07-25T15:24:46.657Z","shipment_status": "pending","ship_to": {"name": "Amanda Miller","phone": "555-555-5555","address_line1": "525 S Winchester Blvd","city_locality": "San Jose","state_province": "CA","postal_code": "95128","country_code": "US","address_residential_indicator": "yes"},"ship_from": {"company_name": "Example Corp.","name": "John Doe","phone": "111-111-1111","address_line1": "4009 Marathon Blvd","address_line2": "Suite 300","city_locality": "Austin","state_province": "TX","postal_code": "78756","country_code": "US","address_residential_indicator": "no"},"return_to": {"phone": "222-222-2222","company_name": "Example Corp. Returns","address_line1": "345 Chambers Street","address_line2": "Suite 100","city_locality": "New York City","state_province": "NY","postal_code": "10282","country_code": "US","address_residential_indicator": "no"},"confirmation": "none","advanced_options": {"bill_to_account": null,"bill_to_country_code": null,"bill_to_party": null,"bill_to_postal_code": null,"contains_alcohol": false,"custom_field1": null,"custom_field2": null,"custom_field3": null,"non_machinable": false,"saturday_delivery": false},"insurance_provider": "none","tags": [],"packages": [{"weight": {"value": 9.6,"unit": "ounce"},"dimensions": {"unit": "inch","length": 12.0,"width": 7.1,"height": 6.0},"insured_value": {"currency": "usd","amount": 0.0}}]}
Shipment Update Response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
{"errors": [],"address_validation": null,"shipment_id": "se-5332095","carrier_id": null,"service_code": null,"external_shipment_id": null,"ship_date": "2019-07-25T05:00:00.000Z","created_at": "2019-07-25T15:24:46.657Z","modified_at": "2019-07-25T15:24:46.657Z","shipment_status": "pending","ship_to": {"name": "Amanda Miller","phone": "555-555-5555","address_line1": "525 S Winchester Blvd","city_locality": "San Jose","state_province": "CA","postal_code": "95128","country_code": "US","address_residential_indicator": "yes"},"ship_from": {"company_name": "Example Corp.","name": "John Doe","phone": "111-111-1111","address_line1": "4009 Marathon Blvd","address_line2": "Suite 300","city_locality": "Austin","state_province": "TX","postal_code": "78756","country_code": "US","address_residential_indicator": "no"},"warehouse_id": "se-7429","return_to": {"phone": "222-222-2222","company_name": "Example Corp. Returns","address_line1": "345 Chambers Street","address_line2": "Suite 100","city_locality": "New York City","state_province": "NY","postal_code": "10282","country_code": "US","address_residential_indicator": "no"},"confirmation": "none","customs": null,"external_order_id": null,"order_source_code": null,"advanced_options": {"bill_to_account": null,"bill_to_country_code": null,"bill_to_party": null,"bill_to_postal_code": null,"contains_alcohol": false,"delivered_duty_paid": false,"non_machinable": false,"saturday_delivery": false,"dry_ice": false,"dry_ice_weight": null,"freight_class": null,"custom_field1": null,"custom_field2": null,"custom_field3": null,"collect_on_delivery": null},"insurance_provider": "none","tags": [],"packages": [{"package_code": "package","weight": {"value": 0.0,"unit": "ounce"},"dimensions": {"unit": "inch","length": 0.0,"width": 0.0,"height": 0.0},"insured_value": {"currency": "usd","amount": 0.0},"label_messages": {"reference1": null,"reference2": null,"reference3": null},"external_package_id": null}],"total_weight": {"value": 0.0,"unit": "ounce"},"items": []}