Skip to content

Constants

Every journey status, vehicle category, add-on, cancellation reason and decline reason, with what each value means.

Updated · 6 min read

The APIs use fixed values for statuses, categories and reasons. This page lists each value and what it means. The values are the same in the Partners and the Transfer Companies API. New values can be added; handle a value you do not know without failing, for example by treating it as "other".

Journey status

A journey moves through these statuses. The usual path is:

NOT_PAID → PENDING → CONFIRMED → PLANNED → DRIVER_UNDERWAY → DRIVER_ARRIVED → JOURNEY_IN_PROGRESS → COMPLETED

StatusMeaning
NOT_PAIDThe journey was booked but not paid yet.
AWAITING_APPROVALPaid, but held for a check by Transferz before it continues. Transfer companies do not see these journeys in a search by default.
PENDINGPaid and approved; waiting for a transfer company.
CONFIRMEDA transfer company has the journey. It still needs a driver (and, for some journeys, a meeting point).
PLANNEDA driver is assigned and, where needed, a meeting point is set. Set automatically from CONFIRMED.
DRIVER_UNDERWAYThe driver is on the way to the pickup. Transferz sends the traveller the driver's details.
DRIVER_ARRIVEDThe driver is at the pickup location.
JOURNEY_IN_PROGRESSThe traveller is on board.
COMPLETEDThe journey is finished.
CANCELLED_FREECancelled without charge to the partner.
CANCELLED_WITH_COSTSCancelled with a charge to the partner.
BOOKER_CANCELLEDDeprecated. No journey has this status any more; existing ones became CANCELLED_FREE.
SUPPLIER_CANCELLEDDeprecated. No journey has this status any more; existing ones became CANCELLED_FREE.

Rules worth knowing:

  • COMPLETED and the cancelled statuses are final. A journey in a final status does not change again.
  • A journey can skip statuses, and a driver or vehicle being removed moves PLANNED back to CONFIRMED. Do not assume each status is reached, or reached once.
  • A journey can be cancelled up to DRIVER_ARRIVED, not once it is JOURNEY_IN_PROGRESS.
  • Transfer companies set DRIVER_UNDERWAY, DRIVER_ARRIVED and JOURNEY_IN_PROGRESS with the status endpoints, which need a pickup within the next 48 hours, and COMPLETED with the complete endpoint, which works from the pickup time on. The status endpoints also accept a journey without a driver; assign the driver first anyway, so the traveller knows who to look for.

Free and paid cancellation

A cancellation is free when the journey is NOT_PAID, AWAITING_APPROVAL or PENDING, or when it happens before the free-cancellation deadline. Quotes and journeys show that deadline as freeCancellationUntil. After the deadline a partner must set acceptCharges to true to cancel, and the journey becomes CANCELLED_WITH_COSTS.

Vehicle category

Quotes and journeys have a vehicleCategory. Shared categories carry several parties in one vehicle; their quotes are priced per passenger (pricePerPassenger is true).

CategoryKind
ECONOMY_SEDANPrivate
SEDANPrivate
BUSINESS_SEDANPrivate
LUXURY_SEDANPrivate
STATIONWAGONPrivate
SUVPrivate
MPVPrivate
MINIVANPrivate
EXCLUSIVE_MINIVANPrivate
VANPrivate
MINIBUSPrivate
BUSPrivate
COACHPrivate
STANDARD_ELECTRIC_CARPrivate
HIGH_END_ELECTRIC_CARPrivate
STRETCH_LIMOUSINEPrivate
HELICOPTERPrivate
SHUTTLEShared
SPEEDY_SHUTTLEShared
EVENT_SHUTTLEShared
DIRECT_SHUTTLEShared
BUSINESS_LIMOUSINEDeprecated; not quoted any more
TOURING_CARDeprecated; not quoted any more

Each quote states its own passengerCapacity and luggageCapacity; use those rather than assumptions about a category.

Travel add-ons

Add-ons are extras on a journey. Each quote lists the add-ons available for it in availableTravelAddons, with a price and the maximum quantity (maxAllowed).

Add-onMeaning
MEET_GREETA host meets the traveller at the pickup. Offered on some journeys only.
BABY_SEATA baby seat, per seat.
CHILD_SEATA child seat, per seat.
BOOSTER_SEATA booster seat, per seat.
PETSThe traveller brings pets.
EXTRA_STOPAn extra stop on the way.
SPECIAL_LUGGAGELuggage that needs extra room, per item.
CARBON_EMISSION_COMPENSATIONCompensation for the journey's carbon emissions. It cannot be added in a journey change.

Cancellation reasons

Partners give one of these as reason when they cancel a journey or a booking.

ReasonUse when
NOT_NEEDED_ANYMOREThe traveller no longer needs the transfer.
DRIVER_NO_SHOWThe driver did not turn up.
TRAVELLER_NO_SHOWThe traveller did not turn up.
NO_AVAILABILITYNo vehicle was available.
ADDRESS_INVALIDThe address is wrong.
INSUFFICIENT_TRAVELLER_DETAILSTraveller details are missing.
NO_FLIGHT_NUMBERThe flight number is missing.
PAX_BAGS_CONFIGURATIONThe passengers or luggage do not fit the booking.
ADD_ON_ISSUEA problem with an add-on.
CANT_FULFILL_CUSTOMER_REQUESTA request of the traveller cannot be met.
PRICE_CALCULATION_ERRORThe price was wrong.
TECHNICAL_ISSUEA technical problem.
STRIKE_OR_ROAD_CLOSUREA strike or a closed road.
FORCE_MAJEURECircumstances beyond anyone's control.
OTHERNone of the above.

Offer decline reasons

Transfer companies give one of these as reason when they decline an offer. With OTHER, a description is required.

ReasonUse when
FARE_TOO_LOWThe fare is too low.
NO_VEHICLE_AVAILABILITYNo suitable vehicle is free.
NO_DRIVER_AVAILABILITYNo driver is free.
ADDONS_NOT_AVAILABLEYou cannot provide a requested add-on.
INCORRECT_JOURNEY_DETAILSThe journey details are wrong.
DISTANCE_TOO_SHORT_OR_LONGThe distance is outside what you drive.
HOLIDAYYou do not operate on that day.
STRIKEA strike prevents the ride.
OTHERNone of the above; explain in description.

The meanings in the two reason tables follow the value names; Transferz has not documented them further.

Offer status

StatusMeaning
PENDINGCreated; you have not been notified yet. You can accept it.
NOTIFIEDYou were notified. You can accept it.
SKIPPED_NOTIFICATIONNo notification was sent, but you can accept it.
ACCEPTEDYou accepted it. Final.
DECLINEDYou declined it. Final.
EXPIREDNobody accepted it in time. Final.
MISSEDAnother transfer company accepted it, or the journey was cancelled. Final.

When you accept, give the meeting point type HUB or TRANSFER_COMPANY where a meeting point is needed.

Action types

Transfer companies report incidents as actions. The API accepts two types; the other two are listed in the specification but set by other Transferz systems.

TypeMeaning
TRAVELLER_NO_SHOWThe traveller did not show up. Add photo evidence. Accepted by the API.
DRIVER_LEFT_PICKUPThe driver left the pickup location. Accepted by the API.
DRIVER_DELAYEDThe driver is late; the traveller gets a message. Not accepted by the API.
ADDITIONAL_PROOF_TRAVELLER_NO_SHOWExtra evidence for a no-show. Not accepted by the API.

Journey assignment status

Transfer Companies API journeys have an assignmentStatus:

StatusMeaning
NOT_ASSIGNEDNo transfer company has the journey.
ASSIGNEDThe journey is assigned to your company.
REASSIGNEDThe journey now belongs to another transfer company.

Other values

FieldValuesMeaning
Journey typeHUB, POINT_TO_POINTA ride to or from a hub, or between two other places.
distanceUnitMETER, KILOMETER, FEET, MILEThe unit of a distance.
travelIntentBUSINESS, LEISURE, UNKNOWNWhy the traveller travels, if known.
pickupTimeAdjustmentMethodPENDING, NONE, FLIGHT_TRACKING, MANUALHow the pickup time follows the flight: not decided yet, not adjusted, by flight tracking, or by hand.
usedResolutionMethodIATA_CODE, ICAO_CODE, ADDRESS_PHRASE, COORDINATES, TRANSFERZ_LOCATION_ID, GOOGLE_PLACE_ID, HERE_ID, TOMTOM_ID, GIATA_ID, TTI_CODEWhich part of your location input Transferz used.
Meeting point file fileTypeMAP, DESK, PICKUP, OTHERWhat a meeting point image shows.

Was this helpful?

Back to your build path →