Itineraries

An itinerary is a structured representation of all activities, meals, transports, starting and finishing locations for a tour. At the root of the itinerary, you can find information about the start and end of the trip, included meals and budget, packing lists, and images (for display purposes within your application).

Further into the itinerary, it is segmented into each day. For each day, you can find optional activities, meals, a summary, and components. Each component on a day will include a dossier of a specific type. That dossier can describe an activity that passengers will do on that day, or a transport, like an overnight train.

Note

The accommodation listed on some itinerary days aren’t necessarily the accommodation that is used on every trip with that itinerary. The accommodation components are meant to describe a representative accommodation for that day. In order to know exactly which accommodation is used on a specific trip, you need to look at the accommodation components on the specific departure or departure service that you are interested in.

Because our products change over time, you’ll find each itinerary has a list of variations. The first variation in the list is the currently valid incarnation of the itinerary and the others are past or future variations. Each variation will have at least one range of dates in which it is valid. This date range may be open-ended.

Itinerary Days

Some days in itineraries have identical content and will therefore have the same ID. The day number will be different between these days, but we recommend rolling up the identical days for display purposes, using a combined label such as “Days 2-4”. For example, take the following (simplified) days list:

"days": [
    {
        "id": "123",
        "day": "1",
        "summary": "Arrive at any time",
    },
    {
        "id": "456",
        "day": "2",
        "summary": "Do some vacation things",
    },
    {
        "id": "456",
        "day": "3",
        "summary": "Do some vacation things",
    },
    {
        "id": "789",
        "day": "4",
        "summary": "Depart at any time",
    },
]

An itinerary with a days list that looks like that should display in something like the following format:

Day 1: Arrive at any time
Days 2-3: Do some vacation things
Day 4: Depart at any time

Handling Multiple Itineraries

Each tour_dossier references one or more Itineraries. A tour dossier will reference multiple itineraries for a variety of reasons, but generally they are to handle seasonality changes for the tour. The itinerary for a tour can adjust per season, or due to a special event (e.g. Carnival in Brazil). From every tour_dossier, you are provided the valid_during_ranges parameter which advices the dates that referenced Itinerary is valid for. These should be used and applied when calculating the appropriate Itinerary to show to the customer.

Another benefit of using the data within an Itinerary are identified by its structured nature, allowing your application to easily parse all data, by day, and by component.

XML Schema:

Fields

Get an Itinerary

GET /itineraries/(string: itinerary_id)/

Get an Itinerary Variation

GET /itineraries/(string: itinerary_id)/(string: variation_id)/