Key Concepts
The terms used in the All Aboard API and in these docs.
Core concepts
Journeys and segments
A journey is a route from an origin to a destination on a given day. It is what you search for and book. A journey can include several trains, with changes and stopovers between them.
A segment is a single ride on one train, bus or ferry between two stations. A journey from London to Rome might have three segments: London to Paris, Paris to Milan and Milan to Rome.
A segment collection (SegmentCollection) is a group of segments that are ticketed together. These docs also call it a leg. A journey's itinerary is a list of legs with stopovers between them: London to Paris, a stopover in Paris, then Paris to Zürich via Strasbourg.
Offers and tickets
An offer is a priced way to travel one leg of a journey. It has a price, ticket conditions, a class and any seat reservation. A leg usually has several offers to choose from.
A ticket is the document the passenger travels on. Tickets are issued after the order is finalized. Most are PDFs, but some are check-in links or collection references.
You select offers in a booking, and a ticket is issued for each one when the order is finalized.
Bookings and orders
A booking holds the selected offers and the passenger details. It expires if you don't create an order from it in time.
An order is the purchase. Creating an order pre-books the tickets with the train operators. Finalizing it completes the purchase, and the tickets are then issued.
Admission and reservation
An offer is made up of parts. An admission is the right to travel, with a flexibility, a service class and a comfort class. A reservation is a reserved seat, couchette or sleeper berth.
Most offers have both. Some trains don't need a reservation, and the passenger sits anywhere in their class.
Distance and CO2e
Every segment has a distance and a co2 figure for one passenger. Multiply by the number of passengers, and add up the segments to get a journey's total. See Distance and CO2e for how the figures are calculated.
Passenger profiles
A traveler's stored details in a profile directory: names, contact details, date of birth, nationality and travel cards. Name a profile as passengerProfile: { directory, id } when you search and book, and the API fills in the passenger from it. See Passenger Profiles.
Journey types
SMART journey
The default type. It balances travel time and comfort, and long routes can include an overnight stopover in a city on the way.
NON_STOP journey
The fastest route, without planned overnight stops. This can mean long travel days or tight connections.
BLUEPRINT journey
An itinerary created in the Dashboard, with planned stopovers and set departure times. See Blueprints.
Offer properties
Prices
Every price is a Money: a currency and an integer amount in that currency's smallest unit. 13400 in EUR is €134.00, and 1000 in JPY is ¥1000, since the yen has no smaller unit.
Flexibility
How freely a ticket can be changed or refunded, from fully flexible to non-flexible. Non-flexible fares are usually the cheapest. See the Flexibility enum for the values.
Service class
The level of service, from standard to premium. Lower values are typically 2nd class and higher values 1st class. See the ServiceClass enum for the values.
Comfort classes
The operator's own name for the class. Some operators say 1st class and 2nd class. Others use product names such as Business Premier or 2nd class calm.
Travel cards
Discount cards, loyalty cards, railcards and rail passes that a passenger holds. You attach them to the passenger when you price and book, and the operator prices the passenger accordingly. See Travel Cards.
Rail pass concepts
Pass bundle
The cheapest combination of passes that covers all your passengers. The API works it out for you.
Travel days
The number of days the passenger can travel on within the validity period. A pass with 5 travel days and a validity period of 1 month can be used on any 5 days in that month.
Validity period
How long the pass is valid, usually a number of months. The passenger picks their travel days within it.
Location concepts
Locations
A place you can search from, to or via. A location is either a station, such as Paris Nord, or a city, such as Paris. Get all of them from the locations query. See Locations.
Meta locations
A location with isMeta: true stands for a place, such as Paris, and not for one station, such as Paris Gare de Lyon. A search from or to a meta location uses whichever station suits the route best, so it finds more good connections. Prefer meta locations in autocomplete and in searches.
Location UID
The stable identifier of a location. Store the uids in your own system and search with them, so you don't have to look locations up by name each time.
Payment concepts
Wallet credits
Prepaid credits. The order total is deducted from them when you finalize an order. Most API integrations pay this way.
Payment gateway
For orders that your customer pays for. You send the customer to All Aboard's hosted payment page (Stripe), and the order is finalized when they have paid.
Invoice billing
Orders are collected on a monthly invoice. Available to approved commercial clients.
Cost centers
A named billing setup on your sales agent. It sets the commercial terms and the payment method of a booking. Cost centers are set per passenger, and a passenger without one uses the agent's default. See Cost Centers.
Booking for another sales agent
A sales agent can be given access to another one, for example a travel agency to the companies it books for. It then books on the other agent's cost centers. The order belongs to the agent whose cost center it is on, and records the agent that placed it. See Booking for Another Sales Agent.
Ticket types
PDF tickets
The most common format. The passenger shows the PDF on their phone or prints it.
Check-in links
Some operators require online check-in before departure. The passenger opens the link, checks in and gets their ticket.
Ticket collection references
Used in the UK. The passenger enters the reference at a ticket machine in the station and collects paper tickets.