List incidents
Newest first, cursor paginated. Open incidents unless status says otherwise. Allowed to carrier admins and dispatchers.
query Parameters
limitMaximum number of items in the page.
cursorThe next_cursor of the previous page, passed back as is. Omit it to get the first page.
statusOpen incidents (the default), resolved ones, or all.
kindComma-separated incident kinds to keep.
opened_fromOpened at or after this instant, or from the start of this Noumea day.
opened_toOpened before this instant, or up to the end of this Noumea day.
shipper_account_id^([0-9a-fA-F]{8}-[0-…Keep the incidents of this shipper account.
qHeld anywhere in the tracking number or the description, ignoring case.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
List incidents › Responses
One page of incidents.
next_cursorPass it as cursor to get the next page. null on the last page.
Open an incident
Moves the shipment to incident and opens an incident on it. A driver opens one by recording the incident status with an incident report on the shipment instead. Allowed to carrier admins and dispatchers.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Open an incident › Request Body
shipment_idkinddescriptionOpen an incident › Responses
The opened incident.
idshipment_idtracking_numbershipper_account_idkinddescriptionstatusopened_at^(?:(?:\d\d[2468][04… · requiredtracking_event_idThe incident tracking event that opened it. Its photos are the proofs of that event.
previous_shipment_statusThe shipment status before the incident.
Count open incidents
The number shown next to the incident queue. Allowed to carrier admins and dispatchers.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Count open incidents › Responses
The counts.
openGet an incident
The incident with its activity, newest first. Allowed to carrier admins and dispatchers.
path Parameters
idThe incident id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get an incident › Responses
The incident.
idshipment_idtracking_numbershipper_account_idkinddescriptionstatusopened_at^(?:(?:\d\d[2468][04… · requiredtracking_event_idThe incident tracking event that opened it. Its photos are the proofs of that event.
previous_shipment_statusThe shipment status before the incident.
Newest first.
Add a note to an incident
Adds a line to the activity. Allowed to carrier admins and dispatchers.
path Parameters
idThe incident id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Add a note to an incident › Request Body
noteAdd a note to an incident › Responses
The incident with its activity.
idshipment_idtracking_numbershipper_account_idkinddescriptionstatusopened_at^(?:(?:\d\d[2468][04… · requiredtracking_event_idThe incident tracking event that opened it. Its photos are the proofs of that event.
previous_shipment_statusThe shipment status before the incident.
Newest first.
Assign an incident
Sets who handles an open incident, or clears it with null. Allowed to carrier admins and dispatchers.
path Parameters
idThe incident id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Assign an incident › Request Body
assignee_user_idThe member who handles the incident, or null to unassign.
Assign an incident › Responses
The incident with its activity.
idshipment_idtracking_numbershipper_account_idkinddescriptionstatusopened_at^(?:(?:\d\d[2468][04… · requiredtracking_event_idThe incident tracking event that opened it. Its photos are the proofs of that event.
previous_shipment_statusThe shipment status before the incident.
Newest first.
Resolve an incident
Moves the shipment out of incident to next_status and closes the incident. With notify_shipper, the shipper account gets an email. Allowed to carrier admins and dispatchers.
path Parameters
idThe incident id.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Resolve an incident › Request Body
next_statusThe status the shipment moves to.
notenotify_shipperEmail the shipper account about the resolution.
Resolve an incident › Responses
The resolved incident with its activity.
idshipment_idtracking_numbershipper_account_idkinddescriptionstatusopened_at^(?:(?:\d\d[2468][04… · requiredtracking_event_idThe incident tracking event that opened it. Its photos are the proofs of that event.
previous_shipment_statusThe shipment status before the incident.
Newest first.