Record what happens to a shipment. Safe to retry: each event carries a client event id.
Record a tracking event
Moves the shipment to a new status. Idempotent on client_event_id: sending an event again returns the recorded one with a 200, so a device can retry after a lost connection without duplicates. Allowed to carrier admins, dispatchers and drivers.
path Parameters
idThe shipment id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Record a tracking event › Request Body
client_event_id^([0-9a-fA-F]{8}-[0-… · requiredA UUID the device generates once per event. Sending the same event again returns the recorded one instead of a duplicate.
statusoccurred_at^(?:(?:\d\d[2468][04… · requiredWhen it happened on the device, with its offset.
A GPS position in decimal degrees (WGS 84).
noteplaceA coarse place name shown to the recipient, never an address.
When the recipient can expect the parcel. Only with the out_for_delivery status.
Evidence of a delivery, or of a pickup at the sender (signature_key is then the shipper signature).
Why the delivery failed. Only with delivery_failed.
What the driver reports. Only with incident; it opens an incident for dispatch.
Record a tracking event › Responses
The event was already recorded; it is returned unchanged.
idclient_event_idstatusoccurred_at^(?:(?:\d\d[2468][04… · requiredrecorded_at^(?:(?:\d\d[2468][04… · requiredactor_user_idactor_kindWho recorded the event: the system or a role.
actor_nameFull name of the person who recorded it, when known.
correlation_idCorrelation ID of the request that recorded it.
A GPS position in decimal degrees (WGS 84).
noteThe failure reason of a delivery_failed event, or the incident kind of an incident event.
place