Skip to content

The Shipment object

Every Shipment route returns this object. Each webhook carries it as data.shipment, and each stream frame as payload.

Timestamps are ISO 8601 in UTC, for example 2026-11-03T08:39:48.000Z. Amounts are RWF strings with two decimals, for example "2518.00". Tujyane can add fields later, so ignore fields you do not know.

Field Type Notes
id UUID
reference string Your reference
mode TEST | LIVE
status string See Shipment lifecycle
sizeClass string
fee string Billed on DELIVERED
returnFee string Added to fee only on RETURNED
distanceMeters integer Straight-line distance from the pickup to the drop-off
Field Type Notes
pickup object { name, phone, addressText, notes, lat, lng }. notes can be null.
recipient object Same shape as pickup
alternateReceiver object | null { name, phone }. phone comes back as 250788123456.
parcelCount integer 1 to 20
partner object | null { firstName, phone, vehicle: { type, plate, model, color } } from ASSIGNED on. null before that, and after a cancellation. vehicle.type is MOTORCYCLE or CAR. color can be null. You can give these details to your customer.
Field Type Notes
createdAt timestamp
confirmBy timestamp The latest time you can confirm
confirmedAt timestamp | null
assignedAt timestamp | null When the current partner accepted
partnerArrivedPickupAt timestamp | null The partner reached the pickup
pickedUpAt timestamp | null
partnerArrivingAt timestamp | null The partner is near the Recipient, after pickup
Field Type Notes
deliveryProof NONE | CODE Your account’s setting when the Shipment was created
deliveryCode string | null The 4-digit code for your customer. null when deliveryProof is NONE.
deliveredAt timestamp | null Set when DELIVERED
deliveredLocation object | null { lat, lng } where the partner was at delivery, or null when unknown
deliveryConfirmedBy CODE | PARTNER | STAFF | null Set when DELIVERED. See Delivery Codes.
Field Type Notes
failedAt timestamp | null The partner reported the delivery failed
failureReason string | null See Failed deliveries
failureNote string | null The partner’s note on the failure, if any
endedAt timestamp | null
endedBy CLIENT | PARTNER | STAFF | SYSTEM | null
endReason string | null See below
noPartnerDeadlineAt timestamp | null The latest time you can retry a NO_PARTNER_FOUND Shipment
problemReportDeadlineAt timestamp | null The latest time you can report a DELIVERED Shipment not received

endReason depends on how the Shipment ended:

Final state endReason
RETURNED The failureReason
EXPIRED NOT_CONFIRMED
NO_PARTNER_FOUND, retry window closed NO_PARTNER_FOUND
CANCELLED Your cancel reason, or Cancelled by the client
DELIVERED, marked by Tujyane staff The staff note