Skip to main content

Trip

recipient_reply object
availableboolean
notestring
preferred_atstring<date-time>
replied_atstring<date-time>
idstring<uuid>
external_idstring
statusstring

Possible values: [pending, started, approaching, arrived, completed, canceled, expired, failed, returning, returned]

modestring
destination object
latnumber<double>
lngnumber<double>
labelstring
approaching_threshold_sinteger
arrival_radius_minteger
scheduled_arrival_atstring<date-time>
eta objectnullable

From the courier's last position, with Ghana traffic. Null before the first ping and once the trip closes.

duration_sinteger
distance_minteger
arrival_atstring<date-time>
computed_atstring<date-time>
delay object
delayedboolean
minutesinteger

How late the ETA runs against scheduled_arrival_at.

last_location objectnullable
latnumber<double>
lngnumber<double>
atstring<date-time>
started_atstring<date-time>
approaching_atstring<date-time>
arrived_atstring<date-time>
completed_atstring<date-time>
canceled_atstring<date-time>
attempt_countinteger

Failed attempts so far.

last_failure_reasonstring
rescheduled_tostring<date-time>
failed_atstring<date-time>
return_started_atstring<date-time>
returned_atstring<date-time>
return_to object
latnumber<double>
lngnumber<double>
labelstring
rider_refstring
recipient_phonestring

Masked.

smsstring

Only in the create response, when recipient_phone was given.

Possible values: [queued, off]

collection object

The cash-on-delivery side of a trip. Absent when nothing is due.

amount_to_collectnumber
collectednumber
outstandingnumber
currencystring
Example: GHS
statusstring

Possible values: [due, partial, collected, over]

expires_atstring<date-time>
created_atstring<date-time>
updated_atstring<date-time>
metadataobject
tracking_urlstring

Only in the create response. The recipient's tracking page.

Trip
{
"recipient_reply": {
"available": true,
"note": "string",
"preferred_at": "2024-07-29T15:51:28.071Z",
"replied_at": "2024-07-29T15:51:28.071Z"
},
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_id": "string",
"status": "pending",
"mode": "string",
"destination": {
"lat": 0,
"lng": 0,
"label": "string"
},
"approaching_threshold_s": 0,
"arrival_radius_m": 0,
"scheduled_arrival_at": "2024-07-29T15:51:28.071Z",
"eta": {
"duration_s": 0,
"distance_m": 0,
"arrival_at": "2024-07-29T15:51:28.071Z",
"computed_at": "2024-07-29T15:51:28.071Z"
},
"delay": {
"delayed": true,
"minutes": 0
},
"last_location": {
"lat": 0,
"lng": 0,
"at": "2024-07-29T15:51:28.071Z"
},
"started_at": "2024-07-29T15:51:28.071Z",
"approaching_at": "2024-07-29T15:51:28.071Z",
"arrived_at": "2024-07-29T15:51:28.071Z",
"completed_at": "2024-07-29T15:51:28.071Z",
"canceled_at": "2024-07-29T15:51:28.071Z",
"attempt_count": 0,
"last_failure_reason": "string",
"rescheduled_to": "2024-07-29T15:51:28.071Z",
"failed_at": "2024-07-29T15:51:28.071Z",
"return_started_at": "2024-07-29T15:51:28.071Z",
"returned_at": "2024-07-29T15:51:28.071Z",
"return_to": {
"lat": 0,
"lng": 0,
"label": "string"
},
"rider_ref": "string",
"recipient_phone": "string",
"sms": "queued",
"collection": {
"amount_to_collect": 0,
"collected": 0,
"outstanding": 0,
"currency": "GHS",
"status": "due"
},
"expires_at": "2024-07-29T15:51:28.071Z",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z",
"metadata": {},
"tracking_url": "string"
}