Update a Shipment
This article explains how to update a shipment by using the shipment_id
found in the create shipment response.
After you create a shipment, you might need to update its information prior to shipment. For example, the package's size and weight have changed since you created the original shipment, or you may realize you didn't add necessary customs details for an international shipment.
Requirements
- The request URL must include the
shipment_id
(available from the create a shipment response, or you can get a shipment by key to find yourshipment_id
). - The
ship_to
and either theship_from
orwarehouse_id
property. - Any of the other properties you wish to update.
- For international shipments, you must also include the
product_id
property in the products array.
See Update Shipment By ID in our API reference for the full body schema.
Examples
In this example, we'll update the size and weight of a shipment. You can add in the same parameters used in Size & Weight to update the shipment.
Example Shipment Update Request
PUT /v1/shipments/:shipment_id