Glossary
The terms used across the Transferz APIs and this portal, from booking to meeting point.
The terms below appear in field names, endpoints and guides. They mean the same thing everywhere in this portal.
Add-on
An extra that a traveller adds to a journey, such as a child seat or meet and greet. Add-ons are priced per quote. See add-ons.
Booking
What a partner creates from a quote. A booking holds the traveller details and the partner's own reference, and contains one or more journeys. A return trip is one booking with two journeys. A partner pays for a booking.
Fleet
The vehicles and drivers of a transfer company. Transferz assigns a journey to a transfer company's fleet; the company then assigns a driver and a vehicle to it.
Hub
A transport hub such as an airport. Every quote request needs a hub as its origin or its destination; a request with no hub
fails with NO_HUB_SELECTED.
Journey
One ride from a pickup location to a drop-off location at a given time. A journey has a status that
moves from booked to completed (see journey statuses),
a vehicle category, traveller details and, once planned, a driver and a vehicle. Both partners and
transfer companies identify a journey by its journeyId.
Meeting point
Where the driver meets the traveller, for example a desk in the arrivals hall. A meeting point is
either the hub's (HUB) or the transfer company's own (TRANSFER_COMPANY). A transfer company may
have to give a meeting point when it accepts an offer.
Offer
A proposal to a transfer company to drive a journey. The company accepts or declines it. When it accepts, the journey is assigned to its fleet. Offers are used only in the offer flow; with direct assignment, journeys are assigned without an offer.
Partner
A company that sells transfers to travellers: a travel agency, airline, booking site or similar. Partners use the Partners API to request quotes, book, pay, change and cancel.
Pickup time
The local date and time at which the driver picks up the traveller, with the time zone of the pickup location. See dates and time zones.
Quote
A price for one vehicle category on one route at one time, returned by a quote request. A quote expires; a partner books before it does.
Staging
The Transferz test environment. Everything in this portal works on staging. See Environments and base URLs.
Transfer company
A company that drives the journeys: it receives journeys, assigns drivers and vehicles, and reports progress. Transfer companies use the Transfer Companies API. Some places call them suppliers.
Traveller
The person who rides. Traveller details (name, phone number, flight number, passengers and luggage) are part of a booking and are passed to the transfer company.
Vehicle category
The class of vehicle a quote and a journey are for, such as SEDAN or MINIVAN. See
vehicle categories.