GuidesAPI Reference
API Reference

Updates a shipment details

Updates details of a shipment identified by the shipmentId. This is a partial update, meaning that only the provided fields will be updated, except when updating segments, the whole segments will be replaced fully.

Changing the status of the shipment affects the statuses of the segments. The following status changes are allowed:

  • pendingongoing
    • changes the status of the first segment to ongoing
  • pendingcancelled
    • changes the status of ongoing and all pending segments to cancelled
  • ongoingcancelled
    • cancels the current ongoing segment and all the succeeding segments
  • ongoingcompleted
    • completes the current ongoing segment and cancels all the succeeding segments

Note: segments and autoStart can be updated via this API call only if the shipment is in pending state.

The "Tracker only" variant of the request updates the given tracking device to all ongoing and pending state segments of the shipment, so it allows to make tracker association both for ongoing and pending state shipments.

Path Params
string
required

Shipment ID

Body Params
Responses
204

Successful (no content)

The shipment information was updated

Language
Credentials
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json