Docs

Types ​

Below are all the available GraphQL types and fields. Please refer to the getting started guide for detailed information and examples on how to use the API.

Try it out

Explore the GraphQL Schema and start making requests with the interactive API console. Visit the console

Query ​

getLocations ​

Get location matching given query string

getAllLocations ​

Get all available locations

getJourneys ​

Get journeys between origin and destination on given date

  • Returns: [Journey!]!
  • Arguments:
    • origin: ID!

      Origin location uid

    • destination: ID!

      Destination location uid

    • date: Date!

      Date of departure

    • filter: JourneyFilterInput

      Optional filter for journey search

    • via: [ViaInput!]

      Optional via stopovers

    • passengers: [PassengerPlaceholderInput!]

      Passenger details required for availability

    • currency: String (default: "EUR")

      Currency to display availability prices in

getJourneyOffer ​

Get fares for given journey, prefer socket

  • Returns: JourneyOffer!
  • Arguments:
    • journey: ID!

      Id of Journey to get fares for

    • passengers: [PassengerPlaceholderInput!]!

      Passenger details

    • currency: String (default: "EUR")

      Currency to display prices in

    • isPassholder: Boolean (default: false)

      Whether the passenger is a passholder

getJourneyForBlueprint ​

Get journey for given blueprint

  • Returns: Journey
  • Arguments:
    • blueprint: ID!

      Blueprint id to get journey for

    • date: Date!

      Date of departure

    • passengers: [PassengerPlaceholderInput!]

      Passenger details required for availability

    • currency: String (default: "EUR")

      Currency to display availability prices in

getPassBundles ​

Get applicable pass bundles for given passengers

getPassBundlesForJourneyOffer ​

Get applicable pass bundles for given journey offer

getJourneyRatings ​

Get comparative rating for journeys

  • Returns: [Float!]!
  • Arguments:
    • journeys: [ID!]!

      List of journey ids

getTicketingFee ​

Get fee for issuing tickets

  • Returns: Money
  • Arguments:
    • fares: [ID!]

      List of fares to get ticketing fee for

    • passBundle: ID

      Id of pass bundle to get ticketing fee for

    • currency: String (default: "EUR")

      Currency to display prices in

node ​

Get anything with an ID

  • Returns: Node
  • Arguments:
    • id: ID!

      Id of node

    • currency: String (default: "EUR")

      Currency to display prices in

getSalesAgent ​

Get sales agent details

Mutation ​

createBooking ​

Create a booking

  • Returns: Booking!
  • Arguments:
    • journeyOffer: ID

      Id of journey to add to booking

    • passBundle: ID

      Id of pass bundle to att to booking

    • currency: String (default: "EUR")

      Currency to display prices in

updateBooking ​

Update an existing booking

updatePart ​

Update an offer part of a booking

createPayment ​

Create a payment which, once fulfilled, will create and finalize the order

  • Returns: Payment!
  • Arguments:
    • booking: ID!

      Id of booking to pay for

    • cancelUrl: String!

      URL to redirect to in the case of payment cancellation

    • successUrl: String!

      URI Template (RFC 6570) compliant string with {order} placeholder

    • metadata: JSONObject

      JSON encoded string of metadata to attach to order

createOrder ​

Confirm booking selections and prebook fares

  • Returns: Order!
  • Arguments:
    • booking: ID!

      Id of booking to confirm

    • metadata: JSONObject

      JSON encoded string of metadata to attach to order

finalizeOrder ​

Finalize order and fetch tickets

  • Returns: Order!
  • Arguments:
    • order: ID!

      Id of order to finalize

Subscription ​

getJourneys ​

Get journeys between origin and destination on given date

  • Returns: [Journey!]!
  • Arguments:
    • origin: ID!

      Origin location uid

    • destination: ID!

      Destination location uid

    • date: Date!

      Date of departure

    • filter: JourneyFilterInput

      Optional filter for journey search

    • via: [ViaInput!]

      Optional via stopovers

    • passengers: [PassengerPlaceholderInput!]

      Passenger details required for availability

    • currency: String (default: "EUR")

      Currency to display availability prices in

getJourneyOffer ​

Get fares for given journey

  • Returns: JourneyOffer!
  • Arguments:
    • journey: ID!

      Id of Journey to get fares for

    • passengers: [PassengerPlaceholderInput!]!

      Passenger details

    • currency: String (default: "EUR")

      Currency to display prices in

    • isPassholder: Boolean (default: false)

      Whether the passenger is a passholder

getJourneyForBlueprint ​

Get journey for given blueprint

  • Returns: Journey
  • Arguments:
    • blueprint: ID!

      Blueprint id to get journey for

    • date: Date!

      Date of departure

    • passengers: [PassengerPlaceholderInput!]

      Passenger details required for availability

    • currency: String (default: "EUR")

      Currency to display availability prices in

Objects ​

AnonymousLocation ​

A station where stops may be made but journeys cannot be planned from/to

Fields

Availability ​

Ticket availablility

Fields

Accommodation ​

Accommodation

Fields

AdmissionPart ​

The part of an offer that covers admission, i.e. being allowed to board the train

Fields

Ancillary ​

An ancillary service that can be selected for a reservation

Fields

AncillarySelection ​

A selection of an ancillary service

Fields

  • id: ID!
  • passengerId: ID!

BlueprintJourney ​

The journey is planned according to a Itinerary Blueprint

Fields

BookingFare ​

A bookable fare offer for a journey

Fields

Booking ​

Non-finalized offer for collection order details

Fields

CompartmentType ​

A compartment type for a fare, e.g. Sleeper or Couchette

Fields

CheckInResource ​

Resource that can be accessed for check-in and ticket issuing

Fields

ExpertJourney ​

The journey is planned according to a predefined route

Fields

FullPassenger ​

All passenger details

Fields

FileResource ​

File resource

Fields

GeoJsonPoint ​

Coordinates of a given location

Fields

GenericOrderItem ​

An inspecified item in an order

Fields

JourneyOffer ​

Fare result produced by a given journey

Fields

JourneySelection ​

The journey selected for an offer

Fields

JourneyFare ​

A fare offer for a journey

Fields

JourneyOfferSelection ​

Selected journey offer that is part of a booking

Fields

JourneyOrderItem ​

Journey fare of placed order

Fields

Location ​

Known location from and to which journeys can be planned

Fields

Money ​

Monetary sum (in cent) of specified currency

Fields

NonStopJourney ​

The journey is the optimal route without any stopovers

Fields

NoChargeRedirect ​

No charge required

Fields

Operator ​

Operator details

Fields

Offer ​

An offer for a journey

Fields

Order ​

Finalized order

Fields

PlanningPeriod ​

Period for which a serivce is scheduled to run

Fields

  • startDate: Date!
  • endDate: Date!
  • bitfield: String!

    A bitfield string representation of the days of service. Each bit in the bitfield corresponds to a specific day, starting from the startDate and ending on the endDate. The bitfield is encoded as a hexadecimal string, where each hexadecimal character represents 4 days (bits).

PlaceProperty ​

Option relating to the seating arrangment and other aspects of the journey

Fields

PlacePropertyOption ​

An option for a place property

Fields

PiggybackJourney ​

The journey is partially based on a predefined route

Fields

PlacePreference ​

Possible place preferences

Fields

PassengerBundle ​

Passengers grouped by type

Fields

PassBundle ​

Bundle of Interrail passes

Fields

PassengerPlaceholder ​

The minium passenger details

Fields

PassengerRequirements ​

Details required for all passengers

Fields

PassBundleSelection ​

Selected Interrail bundle that is part of a booking

Fields

PdfTicket ​

Ticket issued in PDF format for download

Fields

PassBundleOrderItem ​

Interrail pass of placed order

Fields

ReservationPart ​

The part of an offer that covers reservations, i.e. a seat or bed

Fields

ReturnCondition ​

The conditions for returning

Fields

RateLimit ​

Rate limit imposed for an agent

Fields

ServiceBrand ​

The brand of the service

Fields

Segment ​

Individual train segment (physical train)

Fields

Stopover ​

Location for an overnight stopover

Fields

SegmentCollection ​

Set of segments that make up a journey leg

Fields

SmartJourney ​

The journey has been segmented into several travel days for comfort

Fields

SelectedFare ​

The selected fare of a journey offer

Fields

StripePayment ​

Payment using Stripe

Fields

SalesAgent ​

An authorized agent interacting with the API

Fields

TicketClass ​

The class of an available ticket

Fields

TicketOnDeparture ​

Ticket which can be retrieved on departure

Fields

  • reference: String!

    Ticket collection reference

  • description: String!

    Instructions on how to retrieve the ticket

Interfaces ​

Node ​

Any unique resource with an ID

Possible types

Fields

Stop ​

Generic train stop

Possible types

Fields

OfferPart ​

One part that makes up an offer

Possible types

Fields

Journey ​

Journey result produced by any given search algorithm

Possible types

Fields

Fare ​

Fare offer for given itinerary item

Possible types

Fields

Passenger ​

A passenger with minimal details

Possible types

Fields

Payment ​

Payment to be settled for an order

Possible types

Fields

Resource ​

Generic resource

Possible types

Fields

Enums ​

Transport ​

The mode of transport

Values

  • NIGHT_TRAIN
  • TRAIN
  • BUS
  • FERRY
  • NIGHT_BUS

JourneyStatus ​

The current status for a fare search result

Values

  • LOADING
  • SUCCESS
  • ERROR

SegmentCollectionStatus ​

The current status of a leg of a fare search result

Values

  • LOADING

    The request is loading

  • SUCCESS

    The request was successful

  • INDETERMINATE

    Status could not be determined due to an error with a prior connection

  • UNKNOWN

    An unexpected error occurred

  • ONE_DAY

    Allow at least one day from todays date

  • NO_FARES

    No fares available for the requested connection

  • NO_TIMETABLE

    No timetable available for the requested date

  • UNABLE_TO_SELL

    No availability

  • OUTSIDE_TIMETABLE

    The requested date falls outside current timetable planning period

  • PREBOOK_NOT_POSSIBLE

    Online prebook is not possible due to sales restrictions

PassengerType ​

The type of passenger

Values

  • ADULT

    Ages 28-59

  • YOUTH

    Ages 0-27

  • SENIOR

    Ages 60+

PassengerBundleType ​

The resulting product type definition for a passenger

Values

  • ADULT
  • SENIOR
  • YOUTH
  • CHILD

PassengerTitle ​

The perferred title of a passenger (required by carriers)

Values

  • MR
  • MS
  • MX

OrderStatus ​

Current status of an order

Values

  • CONFIRMED

    Order is confirmed

  • PENDING_CONFIRMATION

    Order is partially confirmed

  • PENDING_PRE_BOOK

    Order has not yet been pre booked or confirmed

  • PRE_BOOKED

    Order has been pre booked, but not yet confirmed

  • REFUNDED

    The order has been refunded

  • UNKNOWN

    Unknown state

JourneyType ​

Type of journey

Values

  • BLUEPRINT
  • NON_STOP
  • SMART

AvailabilityStatus ​

The current availability of a journey

Values

  • LOADING

    The request is loading

  • AVAILABLE

    The request was successful

  • UNKNOWN

    An unexpected error occurred

  • SOLD_OUT

    Fares are sold out

AccommodationType ​

The type of accommodation available

Values

  • SEAT

    Seat in a seated area

  • COUCHETTE

    Bed in a couchette cabin

  • BERTH

    Bed in a comfortable sleeper cabin

  • UNKNOWN

    Accommodation is unknown

Flexibility ​

Flexibility of a fare

Values

  • NON_FLEX

    No refunds or exchanges

  • SEMI_FLEX

    Partly refundable or exchangeable

  • FULL_FLEX

    Fully refundable or exchangeable

  • UNKNOWN

    Flexibility is unknown

ReturnType ​

Type of return covered by a return policy

Values

  • EXCHANGE
  • REFUND
  • UNKNOWN

ServiceClass ​

Normalized class of service

Values

  • BEST

    Best class available, premium comfort with top-tier amenities and exclusive services

  • HIGH

    Standard first class, high comfort with enhanced seating and additional perks

  • STANDARD

    Standard second class, balanced service with essential comfort and amenities

  • BASIC

    Most economical class available, minimal service focused on affordability and essential needs

  • UNKNOWN

    Service class is not known

PaymentMethod ​

Valid agent payment method

Values

  • INVOICE
  • WALLET
  • STRIPE

RateLimitUnit ​

The unit for a given rate limit

Values

  • HOUR
  • DAY

Unions ​

ItineraryItem ​

Items that can make up the itinerary of a Journey

Possible types

BookingSelection ​

Selections that can be part of a booking

Possible types

OrderItem ​

Items that can be part of an order

Possible types

OrderResource ​

A resource associated with an order

Possible types

Scalars ​

Date ​

Date string (ISO 8601 – YYYY-MM-DD)

DateTime ​

Naive date and time string, seconds omitted (ISO 8601 – YYYY-MM-DDThh:mm)

Duration ​

ISO 8601 formatted string, e.g. PT2H15M, P2D, P1M

JSONObject ​

The JSONObject scalar type represents JSON objects as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).

ID ​

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

String ​

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Float ​

The Float scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).

Int ​

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Boolean ​

The Boolean scalar type represents true or false.

Inputs ​

ViaInput ​

Via stopover for a journey

Fields

PassPassengerInput ​

Passenger details for passholder

Fields

PassengerPlaceholderInput ​

Placeholder for passenger details. Fields age and birthDate are mutually exclusive and one of them must be provided if type is YOUTH or SENIOR.

Fields

FullPassengerInput ​

Full passenger details

Fields

FareSelectionInput ​

Selection of fare for a journey

Fields

OfferSelectionInput ​

Selection of offer for a journey

Fields

BookingSelectionInput ​

Selection for a booking

Fields

JourneyFilterInput ​

Filter for journey search

Fields

PassBundleFilterInput ​

Filter for pass bundles

Fields

PlacePropertyInput ​

Place property to update

Fields

  • optionId:ID!
  • propertyId:ID!

AddAncillaryInput ​

Ancillary to add to a booking for a given passenger

Fields

  • ancillaryId:ID!
  • passengerId:ID!

RemoveAncillaryInput ​

Ancillary selection to remove from a booking

Fields