Shipments
Update Shipments
This endpoint enables you to update various aspects of an existing shipment, including tracking information, status updates, and associated metadata.
POST
`/v1/shipments/:shipment`
Request Parameters
Path Parameters
Request Body
The request body can include any combination of the following fields:
Request Examples
Basic Information Update
Status Update Example
Additional Information Update Example
Update Restrictions
Container-Related Restrictions
- Cannot update
status
orlocation
for shipments in containers. Either unlink the shipment or update the container directly.
- Cannot update
Purchased Shipment Restrictions
- Cannot modify
provider_id
- Cannot update
tracking_number
- Cannot change
service_level_id
- Cannot modify
dimensions
orweight
- Cannot modify
Status Update Restrictions
- Must provide valid status transitions
- Location and layout must be compatible
Error Handling
Common error scenarios include:
- Invalid Updates
- Validation Errors
- Permission Errors