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.

We recommend reading Using Itineraries For A Tour in addition to this document to help you migrate using itineraries instead of tour details.

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