Push API Documentation

With the Push AXUS API, registered partners can push a complete itinerary into AXUS for a registered travel advisor. The following documentation will detail how to register for an API key and submit a successful request.

Client ID

To register for a Client ID, contact us at support@axustravelapp.com. You will be given a Client ID that should be sent in a header when making the API request.

ClientId:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Basic Authentication

Currently, all API requests are authorized using basic authentication. The username and password must match a current travel advisor's account in AXUS. The itinerary that is created will be added to that advisor's account.

Request URL

Send a PUT request with the appropriate headers to our push endpoint:

https://axustravelapp.com/api/v1/push/itinerary

JSON Format

Our JSON format is modeled off of the work done by schema.org and Google Schemas. While they don't currently support every booking type that AXUS does, we have done our best to use their conventions.

Set Time Fields to Blank

Time fields are populated in Axus from the date time value being passed in through the push. If you do not want a time to show at all when pushing one of these fields set the time to 00:33:33 and it will be blank instead of showing midnight.

Download Sample Itinerary

Itinerary

The itinerary is the top level data structure that will be sent to AXUS. All reservations should go in the 'bookings' array. All travelers should go in the 'travelers' array.

The default behavior for the push after an initial itinerary push is to insert new bookings or update existing that were previously pushed. To delete previously pushed bookings you can set deleteMissingBookings to true, this will remove any bookings that were pushed previously that are not in the current push. Bookings created within Axus outside of the push will always remain.

{
  "title": "Excellent Adventure",
  "subtitle": "subtitle for the itinerary",
  "startDate": "2017-02-14",
  "endDate": "2017-02-20",
  "id": "11231",
  "image": "http://example.com/image/123.jpg",
  "status" : "In Progress",
  "deleteMissingBookings": false,
  "misc" : "misc",
  "itineraryFor": "John Doe",
  "itineraryPrice": "$100",
  "internalTitle": "Internal Title",
  "internalNotes": "Notes...",
  "destinationCountry":"United States",
  "destinationCityRegion":"Chicago",
  "collaboratorNotes": "Notes for Collaborators...",
  "travelers": [],
  "collaborators": [],
  "bookings": []
}
Download Sample Travelers

Travelers

[
  {
    "travelerCrm" : "unique1",
    "firstName": "Tanya",
    "lastName": "Traveler",
    "primaryEmail": "tanya@example.com",
    "phoneNumber" : "333-333-3333",
    "secondaryEmail" : "tanya2@example.com"
  },
  {
    "travelerCrm" : "unique2",
    "firstName": "Tim",
    "lastName": "Traveler",
    "primaryEmail": "tim@example.com",
    "phoneNumber" : "444-333-3333",
    "secondaryEmail" : "tim2@example.com"
  },
  {
    "firstName": "Jarvis",
    "lastName": "Traveler",
    "primaryEmail": "jarvis@example.com",
    "phoneNumber" : "555-333-3333",
    "secondaryEmail" : "jarvis2@example.com"
  }
]
Download Sample Collaborators

Collaborators

[
  {
    "name": "Suzy Agent",
    "email": "suzy@example.com",
    "consultantCrm" : "123xyz"
  },
  {
    "name": "Tommy Operator",
    "email": "username@example.com",
    "consultantCrm" : "123abc"
  }
]
Download Sample Concierge

Concierge Reservation

{
  "@context": "http://schema.org",
  "@type": "ConciergeReservation",
  "reservationId": "442321",
  "reservationNumber": "abc456",
  "serviceType": "4 of 5 day Lift Ticket",
  "image": "http://example.com/image.png",
  "daySortSlot": 0,
  "underName": {
    "@type": "Person",
    "name": "John Smith"
  },
  "confirmedBy": {
    "@type": "Person",
    "name": "Nancy Drew"
  },
  "reservationFor": {
    "@type": "LocalBusiness",
    "name": "Aspen Snowmass",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "45 Village Run Cir",
      "addressLocality": "Snowmass Village",
      "addressRegion": "CO",
      "postalCode": "81615",
      "addressCountry": "US"
    },
    "telephone": "415-771-1400",
    "url": "http://www.example.com"
  },
  "cancellationPolicy": "24 Hours for 80% refund",
  "endDate": "2017-04-13T11:00:00-08:00",
  "startDate": "2017-04-10T16:00:00-08:00",
  "conciergeDescription": "Describe concierge service ...",
  "additionalText": "Pick up tickets at ...",
  "paymentDescription": "Paid in Full",
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-05-01T08:00:00-08:00",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Cruise

Cruise Reservation

{
  "@context": "http://schema.org",
  "@type": "CruiseReservation",
  "reservationId": "442321",
  "reservationNumber": "abc456",
  "image": "http://example.com/image.png",
  "daySortSlot": 0,
  "name": "Inside Passage Cruise",
  "cabinCategory": "Balcony",
  "cabinNumber": "1253",
  "internalReference": "Internal Reference",
  "beddingDescription": "Double Queen",
  "underName": {
    "@type": "Person",
    "name": "John Smith"
  },
  "numAdults": 2,
  "reservationFor": {
    "@type": "CruiseBusiness",
    "name": "Princess Cruises",
    "telephone": "415-771-1400"
  },
  "portsOfCall": [
    {
      "@type": "SeaPort",
      "name": "Vancouver",
      "image": "http://example.com/vancouver.png",
      "daySortSlot" : 0,
      "arrivalDate": "2017-04-10T10:00:00-08:00",
      "departureDate": "2017-04-10T16:00:00-08:00",
      "additionalText": "Notes..."
    },
    {
      "@type": "SeaPort",
      "name": "Akron",
      "image": "http://example.com/scenic_ohio.png",
      "daySortSlot" : 1,
      "arrivalDate": "2017-04-11T10:00:00-08:00",
      "departureDate": "2017-04-11T16:00:00-08:00",
      "additionalText": "Notes..."
    },
    {
      "@type": "SeaPort",
      "name": "Anchorage",
      "image": "http://example.com/anchorage.png",
      "daySortSlot" : 2,
      "arrivalDate": "2017-04-12T10:00:00-08:00",
      "additionalText": "Disembarkation Notes..."
    }
  ],
  "cancellationPolicy": "24 Hours for 80% refund",
  "ship": {
    "@type": "CruiseShip",
    "name": "Concordia"
  },
  "paymentDescription": "Paid in Full",
  "additionalText": "Notes for the traveler ...",
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-05-01T08:00:00-08:00",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Flight

Flight Reservation

{"@context": "http://schema.org",
  "@type": "FlightReservation",
  "reservationNumber": "RXJ34P",
  "reservationId": "55231",
  "daySortSlot": 0,
  "image": "http://example.com/image.png",
  "passengers": [{
    "@type": "Person",
    "name": "Eva Green",
    "ticketNumber": "123XYZ",
    "airplaneSeat": "9A",
    "airplaneSeatClass": {
      "@type": "AirplaneSeatClass",
      "name": "Business"
    },
    "programMembership": {
      "@type": "ProgramMembership",
      "memberNumber": "4BY123111"
    }
  }],
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-03-14T13:05:00-05:00",
  "checkinUrl": "http://united.com/onlinecheckin.html",
  "reservationFor": {
    "@type": "Flight",
    "flightNumber": "110",
    "airline": {
      "@type": "Airline",
      "name": "United",
      "iataCode": "UA",
      "telephone": "(800) 555-5555"
    },
    "operatedBy": {
      "@type": "Airline",
      "name": "Continental Airlines",
      "iataCode": "CO"
    },
    "departureAirport": {
      "@type": "Airport",
      "name": "San Francisco Airport",
      "iataCode": "SFO",
      "address": {
        "@type": "PostalAddress",
        "addressLocality": "San Francisco"
      }
    },
    "departureTime": "2017-03-04T20:15:00-08:00",
    "departureTerminal": "B",
    "arrivalAirport": {
      "@type": "Airport",
      "name": "John F. Kennedy International Airport",
      "iataCode": "JFK",
      "address": {
        "@type": "PostalAddress",
        "addressLocality": "New York"
      }
    },
    "arrivalTime": "2017-03-05T06:03:00-05:00",
    "duration": "8 hr,20 mins",
    "arrivalTerminal": "A"
  },
  "additionalTicketText": "Some ticket details, terms and conditions...",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Insurance

Insurance Reservation

{
  "@context": "http://schema.org",
  "@type": "InsuranceReservation",
  "reservationId": "442321",
  "reservationNumber": "abc456",
  "image": "http://example.com/image.png",
  "daySortSlot": 0,
  "reservationFor": {
    "@type": "TravelInsurance",
    "name": "Gold Travel Plan",
    "policyType": "Standard",
    "company": {
      "@type": "LocalBusiness",
      "name": "Travelex",
      "telephone": "415-555-5555",
      "tollFreeTelephone": "1-800-555-5555",
      "url": "http://www.example.com"
    }
  },
  "effectiveDate": "2017-04-10T16:00:00-08:00",
  "additionalText": "Notes go here",
  "paymentDescription": "Paid in Full",
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-05-01T08:00:00-08:00",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Lodging

Lodging Reservation

Now supports multiple rooms

{
  "@context": "http://schema.org",
  "@type": "LodgingReservation",
  "reservationId": "442321",
  "reservationNumber": "abc456",
  "image": "http://example.com/image.png",
  "daySortSlot": 0,
  "underName": {
    "@type": "Person",
    "name": "John Smith"
  },
  "numAdults": 2,
  "reservationFor": {
    "@type": "LodgingBusiness",
    "name": "Hilton San Francisco Union Square",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "333 O'Farrell St",
      "addressLocality": "San Francisco",
      "addressRegion": "CA",
      "postalCode": "94102",
      "addressCountry": "US"
    },
    "telephone": "415-771-1400",
    "url": "http://www.example.com"
  },
  "rooms" : [
    {
      "reservationNumber": "abc456",
      "numGuests": 2,
      "underName": {
        "@type": "Person",
        "name": "John Smith"
      },
      "roomCategory" : "Deluxe",
      "lodgingUnitDescription": "Bay View with balcony ...",
      "beddingDescription": "Double Queen",
      "additionalText": "Notes about room ...",
      "internalReference": "Internal Reference",
      "priceCurrency" : "USD",
      "totalPrice" : 100
    },
    {
      "reservationNumber": "abc457",
      "numGuests": 2,
      "underName": {
        "@type": "Person",
        "name": "John Smith"
      },
      "roomCategory" : "Deluxe",
      "lodgingUnitDescription": "Bay View with balcony ...",
      "beddingDescription": "King",
      "additionalText": "Notes about room ...",
      "internalReference": "Internal Reference",
      "priceCurrency" : "USD",
      "totalPrice" : 200
    }],
  "amenities": "Complementary Breakfast\nFree Wifi",
  "cancellationPolicy": "24 Hours for 80% refund",
  "checkoutDate": "2017-04-13T11:00:00-08:00",
  "checkinDate": "2017-04-10T16:00:00-08:00",
  "lodgingUnitDescription": "Bay View",
  "beddingDescription": "Double Queen",
  "url": "http://example.com/ExpandedHotelProfile.html",
  "paymentDescription": "Paid in Full",
  "lodgingDescription": "Description of lodging ...",
  "additionalText": "Notes for the traveler ...",
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-05-01T08:00:00-08:00",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Other

Other Reservation

{
  "@context": "http://schema.org",
  "@type": "Reservation",
  "reservationId": "442321",
  "image": "http://example.com/image.png",
  "daySortSlot": 0,
  "priorityLevel": "high",
  "reservationFor": {
    "@type": "LodgingBusiness",
    "name": "Generic Reservation Title",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "333 O'Farrell St",
      "addressLocality": "San Francisco",
      "addressRegion": "CA",
      "postalCode": "94102",
      "addressCountry": "US"
    },
    "telephone": "415-771-1400",
    "url": "http://www.example.com"
  },
  "startDate": "2017-04-13T11:00:00-08:00",
  "additionalText": "Notes for the traveler ...",
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-05-01T08:00:00-08:00",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Rental Car

Rental Car Reservation

{
  "@context": "http://schema.org",
  "@type": "RentalCarReservation",
  "reservationNumber": "546323",
  "reservationId": "442211",
  "image": "http://example.com/image.png",
  "daySortSlot": 0,
  "underName": {
    "@type": "Person",
    "name": "John Smith"
  },
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-03-14T13:05:00-05:00",
  "reservationFor": {
    "@type": "RentalCar",
    "name": "Economy Class Car",
    "rentalCompany": {
      "@type": "Organization",
      "name": "Hertz"
    }
  },
  "pickupLocation": {
    "@type": "Place",
    "name": "Hertz San Diego Airport",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "1500 Orange Avenue",
      "addressLocality": "San Diego",
      "addressRegion": "CA",
      "postalCode": "94043",
      "addressCountry": "US"
    },
    "telephone": "+1-800-123-4567"
  },
  "pickupTime": "2017-08-05T16:00:00-07:00",
  "dropoffLocation": {
    "@type": "Place",
    "name": "Hertz LAX",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "1234 First Street",
      "addressLocality": "Los Angeles",
      "addressRegion": "CA",
      "postalCode": "94043",
      "addressCountry": "US"
    },
    "telephone": "+1-800-123-4567"
  },
  "dropoffTime": "2017-08-06T20:00:00-07:00",
  "cancellationPolicy": "24 Hours for 80% refund",
  "additionalText": "Notes for the traveler ...",
  "paymentDescription": "Paid in Full",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Ferry

Ferry Reservation

{
  "@context": "http://schema.org",
  "@type": "FerryReservation",
  "reservationNumber": "546324",
  "reservationId": "442425",
  "modifiedTime": "2017-03-14T13:05:00-05:00",
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Lu",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "image": "http://example.com/image.png",
  "daySortSlot":0,
  "reservationFor": {
    "@type": "LocalBusiness",
    "name": "Washington Island Ferry",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "215 WI-42",
      "addressLocality": "Ellison Bay",
      "addressRegion": "WI",
      "postalCode": "54210",
      "addressCountry": "US"
    },
    "telephone": "415-555-1212",
    "url": "http://www.example.com"
  },
  "departureLocation": {
    "@type": "Place",
    "name": "Ferry Terminal Ellison Bay"
  },
  "pickupTime": "2017-08-05T16:00:00-07:00",
  "arrivalLocation": {
    "@type": "Place",
    "name": "Washington Island"
  },
  "dropoffTime": "2017-08-05T19:00:00-07:00",
  "serviceClass": "Business",
  "seatAssignments": "1A,2B",
  "cancellationPolicy": "24 Hours for 80% refund",
  "additionalText": "Notes for the traveler ...",
  "paymentDescription": "Paid in Full",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Tour

Tour Reservation

{
  "@context": "http://schema.org",
  "@type": "TourReservation",
  "reservationId": "442321",
  "reservationNumber": "abc456",
  "image": "http://example.com/image.png",
  "daySortSlot": 0,
  "name": "Aspen Snow Tour",
  "underName": {
    "@type": "Person",
    "name": "John Smith"
  },
  "confirmedBy": {
    "@type": "Person",
    "name": "Nancy Drew"
  },
  "reservationFor": {
    "@type": "LocalBusiness",
    "name": "Joe's Tours",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "45 Village Run Cir",
      "addressLocality": "Snowmass Village",
      "addressRegion": "CO",
      "postalCode": "81615",
      "addressCountry": "US"
    },
    "telephone": "415-555-5555",
    "url": "http://www.example.com"
  },
  "cancellationPolicy": "24 Hours",
  "endDate": "2017-04-13T11:00:00-08:00",
  "startDate": "2017-04-10T16:00:00-08:00",
  "tourDescription": "A 3 hour walking tour ...",
  "meetingPoint": "Town Square",
  "additionalText": "Notes go here",
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-05-01T08:00:00-08:00",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Train

Train Reservation

{
  "@context": "http://schema.org",
  "@type": "TrainReservation",
  "reservationNumber": "AB3XY2",
  "reservationId": "556677",
  "image": "http://example.com/image.png",
  "daySortSlot": 0,
  "bookingTime": "2013-01-14T13:05:00-05:00",
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-03-14T13:05:00-05:00",
  "reservationFor": {
    "@type": "TrainTrip",
    "trainNumber": "9203",
    "trainName": "Orient Express",
    "trainCode": "iGTV",
    "trainCompany": {
      "@type": "Organization"
    },
    "departureStation": {
      "@type": "TrainStation",
      "name": "Munich Central"
    },
    "departureTime": "2017-01-04T10:30:00+01:00",
    "arrivalStation": {
      "@type": "TrainStation",
      "name": "Paris Gare De Lyon"
    },
    "arrivalTime": "2017-01-05T03:10:00+01:00"
  },
  "reservedTicket": {
    "@type": "Ticket",
    "ticketNumber": "123XYZ",
    "additionalTicketText": "?",
    "underName": {
      "@type": "Person",
      "name": "Mary Smith"
    },
    "ticketedSeat": {
      "@type": "Seat",
      "seatingType": "1st Class",
      "seatNumber": "27",
      "seatRow": "A"
    }
  },
  "duration": "4 Hrs, 40 mins",
  "cancellationPolicy": "24 Hours",
  "paymentDescription": "Paid in Full",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Transfer

Transfer Reservation

{
  "@context": "http://schema.org",
  "@type": "TransferReservation",
  "reservationNumber": "546324",
  "reservationId": "442425",
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-03-14T13:05:00-05:00",
  "daySortSlot": 0,
  "image": "http://example.com/image.png",
  "reservationFor": {
    "@type": "LocalBusiness",
    "name": "Bills Limo",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "45 Village Run Cir",
      "addressLocality": "Snowmass Village",
      "addressRegion": "CO",
      "postalCode": "81615",
      "addressCountry": "US"
    },
    "telephone": "415-771-1400",
    "url": "http://www.example.com"
  },
  "vehicle": "Black Towncar",
  "pickupLocation": {
    "@type": "Place",
    "name": "Hertz San Diego Airport"
  },
  "pickupTime": "2017-08-05T16:00:00-07:00",
  "dropoffLocation": {
    "@type": "Place",
    "name": "Hertz LAX"
  },
  "dropoffTime": "2017-08-05T19:30:00-07:00",
  "cancellationPolicy": "24 Hours for 80% refund",
  "additionalText": "Notes for the traveler ...",
  "numAdults": 2,
  "paymentDescription": "Paid in Full",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Sample Other transportation

Other transportation Reservation

{
  "@context": "http://schema.org",
  "@type": "OtherTransportation",
  "reservationNumber": "546324",
  "reservationId": "442425",
  "supplierConfirmationStatus" : "confirmed",
  "salability" : "level 1",
  "lastReviewedBy" : "Sandy Smith",
  "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
  "modifiedTime": "2013-03-14T13:05:00-05:00",
  "daySortSlot": 0,
  "image": "http://example.com/image.png",
  "reservationFor": {
    "@type": "LocalBusiness",
    "name": "Bills Limo",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "45 Village Run Cir",
      "addressLocality": "Snowmass Village",
      "addressRegion": "CO",
      "postalCode": "81615",
      "addressCountry": "US"
    },
    "telephone": "415-771-1400",
    "url": "http://www.example.com"
  },
  "vehicle": "Black Towncar",
  "pickupLocation": {
    "@type": "Place",
    "name": "Hertz San Diego Airport"
  },
  "pickupTime": "2017-08-05T16:00:00-07:00",
  "dropoffLocation": {
    "@type": "Place",
    "name": "Hertz LAX"
  },
  "dropoffTime": "2017-08-05T19:30:00-07:00",
  "cancellationPolicy": "24 Hours for 80% refund",
  "additionalText": "Notes for the traveler ...",
  "numAdults": 2,
  "paymentDescription": "Paid in Full",
  "bookingPrice": "$10",
  "internalNotes": "Notes...",
  "collaboratorNotes": "Notes for Collaborators...",
  "unlocked":false
}
Download Complete Itinerary

Complete Itinerary

{
   "title":"Excellent Adventure",
   "startDate":"2022-01-01",
   "endDate":"2022-01-12",
   "id":"11231",
   "status":"In Progress",
   "deleteMissingBookings":false,
   "misc":"misc",
   "itineraryFor":"John Doe",
   "image":"http://example.com/image.png",
   "itineraryPrice":"$100",
   "internalNotes":"Notes...",
   "destinationCountry":"United States",
   "destinationCityRegion":"Chicago",
   "collaboratorNotes":"Notes for Collaborators...",
   "collaborators":[
      {
         "name":"Suzy Agent",
         "email":"suzy@example.com",
         "consultantCrm":"123xyz"
      },
      {
         "name":"Tommy Operator",
         "email":"username@example.com",
         "consultantCrm":"123abc"
      }
   ],
   "travelers":[
      {
         "firstName":"Tanya",
         "lastName":"Traveler",
         "primaryEmail":"tanya@example.com",
         "secondaryEmail":"tanya2@example.com",
         "phoneNumber":"333-333-3333",
         "thirdPartyId":"abc",
         "travelerCrm":"123"
      },
      {
         "firstName":"Tim",
         "lastName":"Traveler",
         "primaryEmail":"tim@example.com",
         "secondaryEmail":"tim2@example.com",
         "phoneNumber":"444-333-3333",
         "thirdPartyId":"xyz",
         "travelerCrm":"456"
      }
   ],
   "bookings":[
      {
         "@context":"http://schema.org",
         "@type":"ConciergeReservation",
         "reservationId":"442321",
         "reservationNumber":"abc456",
         "serviceType":"4 of 5 day Lift Ticket",
         "image":"http://example.com/image.png",
         "daySortSlot":0,
         "underName":{
            "@type":"Person",
            "name":"John Smith"
         },
         "confirmedBy":{
            "@type":"Person",
            "name":"Nancy Drew"
         },
         "reservationFor":{
            "@type":"LocalBusiness",
            "name":"Aspen Snowmass",
            "address":{
               "@type":"PostalAddress",
               "streetAddress":"45 Village Run Cir",
               "addressLocality":"Snowmass Village",
               "addressRegion":"CO",
               "postalCode":"81615",
               "addressCountry":"US"
            },
            "telephone":"415-771-1400",
            "url":"http://www.example.com"
         },
         "cancellationPolicy":"24 Hours for 80% refund",
         "endDate":"2022-01-01T11:00:00-08:00",
         "startDate":"2022-01-01T16:00:00-08:00",
         "conciergeDescription":"Describe concierge service ...",
         "additionalText":"Pick up tickets at ...",
         "paymentDescription":"Paid in Full",
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Smith",
         "lastReviewedByDate":"2013-05-01T08:00:00-08:00",
         "modifiedTime":"2013-05-01T08:00:00-08:00",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
      {
         "@context":"http://schema.org",
         "@type":"CruiseReservation",
         "reservationId":"442321",
         "reservationNumber":"abc456",
         "image":"http://example.com/image.png",
         "daySortSlot":0,
         "name":"Inside Passage Cruise",
         "cabinCategory":"Balcony",
         "cabinNumber":"1253",
         "internalReference": "Internal Reference",
         "beddingDescription":"Double Queen",
         "underName":{
            "@type":"Person",
            "name":"John Smith"
         },
         "numAdults":2,
         "reservationFor":{
            "@type":"CruiseBusiness",
            "name":"Princess Cruises",
            "telephone":"415-771-1400"
         },
         "portsOfCall":[
            {
               "@type":"SeaPort",
               "name":"Vancouver",
               "image":"http://example.com/image.png",
               "daySortSlot":0,
               "arrivalDate":"2022-01-10T10:00:00-08:00",
               "departureDate":"2022-01-10T16:00:00-08:00",
               "additionalText":"Notes..."
            },
            {
               "@type":"SeaPort",
               "name":"Akron",
               "image":"http://example.com/image.png",
               "daySortSlot":1,
               "arrivalDate":"2022-01-11T10:00:00-08:00",
               "departureDate":"2022-01-11T16:00:00-08:00",
               "additionalText":"Notes..."
            },
            {
               "@type":"SeaPort",
               "name":"Anchorage",
               "image":"http://example.com/image.png",
               "daySortSlot":2,
               "arrivalDate":"2022-01-12T10:00:00-08:00",
               "additionalText":"Disembarkation Notes..."
            }
         ],
         "cancellationPolicy":"24 Hours for 80% refund",
         "ship":{
            "@type":"CruiseShip",
            "name":"Concordia"
         },
         "paymentDescription":"Paid in Full",
         "additionalText":"Notes for the traveler ...",
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Smith",
         "lastReviewedByDate":"2013-05-01T08:00:00-08:00",
         "modifiedTime":"2013-05-01T08:00:00-08:00",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
      {
         "@context":"http://schema.org",
         "@type":"FlightReservation",
         "reservationNumber":"RXJ34P",
         "reservationId":"55231",
         "daySortSlot":0,
         "image":"http://example.com/image.png",
         "passengers":[
            {
               "@type":"Person",
               "name":"Eva Green",
               "ticketNumber":"123XYZ",
               "airplaneSeat":"9A",
               "airplaneSeatClass":{
                  "@type":"AirplaneSeatClass",
                  "name":"Business"
               },
               "programMembership":{
                  "@type":"ProgramMembership",
                  "memberNumber":"4BY123111"
               }
            }
         ],
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Smith",
         "lastReviewedByDate":"2021-05-01T08:00:00-08:00",
         "modifiedTime":"2021-03-14T13:05:00-05:00",
         "checkinUrl":"http://united.com/onlinecheckin.html",
         "reservationFor":{
            "@type":"Flight",
            "flightNumber":"110",
            "airline":{
               "@type":"Airline",
               "name":"United",
               "iataCode":"UA",
               "telephone":"(800) 555-5555"
            },
            "operatedBy":{
               "@type":"Airline",
               "name":"Continental Airlines",
               "iataCode":"CO"
            },
            "departureAirport":{
               "@type":"Airport",
               "name":"San Francisco Airport",
               "iataCode":"SFO",
               "address":{
                  "@type":"PostalAddress",
                  "addressLocality":"San Francisco"
               }
            },
            "departureTime":"2022-01-03T20:15:00-08:00",
            "departureTerminal":"B",
            "arrivalAirport":{
               "@type":"Airport",
               "name":"John F. Kennedy International Airport",
               "iataCode":"JFK",
               "address":{
                  "@type":"PostalAddress",
                  "addressLocality":"New York"
               }
            },
            "arrivalTime":"2022-01-03T06:03:00-05:00",
            "duration":"8 hr,20 mins",
            "arrivalTerminal":"A"
         },
         "additionalTicketText":"Some ticket details, terms and conditions...",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
      {
         "@context":"http://schema.org",
         "@type":"InsuranceReservation",
         "reservationId":"442321",
         "reservationNumber":"abc456",
         "image":"http://example.com/image.png",
         "daySortSlot":0,
         "reservationFor":{
            "@type":"TravelInsurance",
            "name":"Gold Travel Plan",
            "policyType":"Standard",
            "company":{
               "@type":"LocalBusiness",
               "name":"Travelex",
               "telephone":"415-555-5555",
               "tollFreeTelephone":"1-800-555-5555",
               "url":"http://www.example.com"
            }
         },
         "effectiveDate":"2017-04-10T16:00:00-08:00",
         "additionalText":"Notes go here",
         "paymentDescription":"Paid in Full",
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Smith",
         "lastReviewedByDate":"2021-05-01T08:00:00-08:00",
         "modifiedTime":"2021-05-01T08:00:00-08:00",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
      {
         "@context":"http://schema.org",
         "@type":"LodgingReservation",
         "reservationId":"442321",
         "reservationNumber":"abc456",
         "image":"http://example.com/image.png",
         "daySortSlot":0,
         "underName":{
            "@type":"Person",
            "name":"John Smith"
         },
         "numAdults":2,
         "reservationFor":{
            "@type":"LodgingBusiness",
            "name":"Hilton San Francisco Union Square",
            "address":{
               "@type":"PostalAddress",
               "streetAddress":"333 O'Farrell St",
               "addressLocality":"San Francisco",
               "addressRegion":"CA",
               "postalCode":"94102",
               "addressCountry":"US"
            },
            "telephone":"415-771-1400",
            "url":"http://www.example.com"
         },
         "rooms":[
            {
               "reservationNumber":"abc456",
               "numGuests":2,
               "underName":{
                  "@type":"Person",
                  "name":"John Smith"
               },
               "roomCategory":"Deluxe",
               "lodgingUnitDescription":"Bay View with balcony ...",
               "beddingDescription":"Double Queen",
               "additionalText":"Notes about room ...",
               "internalReference": "Internal Reference",
               "priceCurrency":"USD",
               "totalPrice":100
            },
            {
               "reservationNumber":"abc457",
               "numGuests":2,
               "underName":{
                  "@type":"Person",
                  "name":"John Smith"
               },
               "roomCategory":"Deluxe",
               "lodgingUnitDescription":"Bay View with balcony ...",
               "beddingDescription":"King",
               "additionalText":"Notes about room ...",
               "internalReference": "Internal Reference",
               "priceCurrency":"USD",
               "totalPrice":200
            }
         ],
         "amenities":"Complementary Breakfast\nFree Wifi",
         "cancellationPolicy":"24 Hours for 80% refund",
         "checkoutDate":"2022-01-06T11:00:00-08:00",
         "checkinDate":"2022-01-04T16:00:00-08:00",
         "lodgingUnitDescription":"Bay View",
         "beddingDescription":"Double Queen",
         "url":"http://example.com/ExpandedHotelProfile.html",
         "paymentDescription":"Paid in Full",
         "lodgingDescription":"Description of lodging ...",
         "additionalText":"Notes for the traveler ...",
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Smith",
         "lastReviewedByDate":"2021-05-01T08:00:00-08:00",
         "modifiedTime":"2021-05-01T08:00:00-08:00",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
      {
         "@context":"http://schema.org",
         "@type":"Reservation",
         "reservationId":"442321",
         "image":"http://example.com/image.png",
         "daySortSlot":0,
         "priorityLevel":"high",
         "reservationFor":{
            "@type":"LodgingBusiness",
            "name":"Generic Reservation Title",
            "address":{
               "@type":"PostalAddress",
               "streetAddress":"333 O'Farrell St",
               "addressLocality":"San Francisco",
               "addressRegion":"CA",
               "postalCode":"94102",
               "addressCountry":"US"
            },
            "telephone":"415-771-1400",
            "url":"http://www.example.com"
         },
         "startDate":"2022-01-05T11:00:00-08:00",
         "additionalText":"Notes for the traveler ...",
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Smith",
         "lastReviewedByDate":"2022-01-01T08:00:00-08:00",
         "modifiedTime":"2022-01-01T08:00:00-08:00",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
      {
         "@context":"http://schema.org",
         "@type":"RentalCarReservation",
         "reservationNumber":"546323",
         "reservationId":"442211",
         "image":"http://example.com/image.png",
         "daySortSlot":0,
         "underName":{
            "@type":"Person",
            "name":"John Smith"
         },
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Smith",
         "lastReviewedByDate":"2021-05-01T08:00:00-08:00",
         "modifiedTime":"2021-03-14T13:05:00-05:00",
         "reservationFor":{
            "@type":"RentalCar",
            "name":"Economy Class Car",
            "rentalCompany":{
               "@type":"Organization",
               "name":"Hertz"
            }
         },
         "pickupLocation":{
            "@type":"Place",
            "name":"Hertz San Diego Airport",
            "address":{
               "@type":"PostalAddress",
               "streetAddress":"1500 Orange Avenue",
               "addressLocality":"San Diego",
               "addressRegion":"CA",
               "postalCode":"94043",
               "addressCountry":"US"
            },
            "telephone":"+1-800-123-4567"
         },
         "pickupTime":"2022-01-02T16:00:00-07:00",
         "dropoffLocation":{
            "@type":"Place",
            "name":"Hertz LAX",
            "address":{
               "@type":"PostalAddress",
               "streetAddress":"1234 First Street",
               "addressLocality":"Los Angeles",
               "addressRegion":"CA",
               "postalCode":"94043",
               "addressCountry":"US"
            },
            "telephone":"+1-800-123-4567"
         },
         "dropoffTime":"2022-01-03T20:00:00-07:00",
         "cancellationPolicy":"24 Hours for 80% refund",
         "additionalText":"Notes for the traveler ...",
         "paymentDescription":"Paid in Full",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
      {
         "@context":"http://schema.org",
         "@type":"FerryReservation",
         "reservationNumber":"546324",
         "reservationId":"442425",
         "modifiedTime":"2021-03-14T13:05:00-05:00",
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Lu",
         "lastReviewedByDate":"2021-05-01T08:00:00-08:00",
         "image":"http://example.com/image.png",
         "daySortSlot":0,
         "reservationFor":{
            "@type":"LocalBusiness",
            "name":"Washington Island Ferry",
            "address":{
               "@type":"PostalAddress",
               "streetAddress":"215 WI-42",
               "addressLocality":"Ellison Bay",
               "addressRegion":"WI",
               "postalCode":"54210",
               "addressCountry":"US"
            },
            "telephone":"415-555-1212",
            "url":"http://www.example.com"
         },
         "departureLocation":{
            "@type":"Place",
            "name":"Ferry Terminal Ellison Bay"
         },
         "pickupTime":"2022-01-06T16:00:00-07:00",
         "arrivalLocation":{
            "@type":"Place",
            "name":"Washington Island"
         },
         "dropoffTime":"2022-01-06T19:00:00-07:00",
         "serviceClass":"Business",
         "seatAssignments":"1A,2B",
         "cancellationPolicy":"24 Hours for 80% refund",
         "additionalText":"Notes for the traveler ...",
         "paymentDescription":"Paid in Full",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
      {
         "@context":"http://schema.org",
         "@type":"TourReservation",
         "reservationId":"442321",
         "reservationNumber":"abc456",
         "image":"http://example.com/image.png",
         "daySortSlot":0,
         "name":"Aspen Snow Tour",
         "underName":{
            "@type":"Person",
            "name":"John Smith"
         },
         "confirmedBy":{
            "@type":"Person",
            "name":"Nancy Drew"
         },
         "reservationFor":{
            "@type":"LocalBusiness",
            "name":"Joe's Tours",
            "address":{
               "@type":"PostalAddress",
               "streetAddress":"45 Village Run Cir",
               "addressLocality":"Snowmass Village",
               "addressRegion":"CO",
               "postalCode":"81615",
               "addressCountry":"US"
            },
            "telephone":"415-555-5555",
            "url":"http://www.example.com"
         },
         "cancellationPolicy":"24 Hours",
         "endDate":"2022-01-07T11:00:00-08:00",
         "startDate":"2022-01-07T16:00:00-08:00",
         "tourDescription":"A 3 hour walking tour ...",
         "meetingPoint":"Town Square",
         "additionalText":"Notes go here",
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Smith",
         "lastReviewedByDate":"2021-05-01T08:00:00-08:00",
         "modifiedTime":"2021-05-01T08:00:00-08:00",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
      {
         "@context":"http://schema.org",
         "@type":"TrainReservation",
         "reservationNumber":"AB3XY2",
         "reservationId":"556677",
         "image":"http://example.com/image.png",
         "daySortSlot":0,
         "bookingTime":"2022-01-08T13:05:00-05:00",
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Smith",
         "lastReviewedByDate":"2021-05-01T08:00:00-08:00",
         "modifiedTime":"2021-03-14T13:05:00-05:00",
         "reservationFor":{
            "@type":"TrainTrip",
            "trainNumber":"9203",
            "trainName":"Orient Express",
            "trainCode":"iGTV",
            "trainCompany":{
               "@type":"Organization"
            },
            "departureStation":{
               "@type":"TrainStation",
               "name":"Munich Central"
            },
            "departureTime":"2022-01-08T10:30:00+01:00",
            "arrivalStation":{
               "@type":"TrainStation",
               "name":"Paris Gare De Lyon"
            },
            "arrivalTime":"2022-01-08T16:10:00+01:00"
         },
         "reservedTicket":{
            "@type":"Ticket",
            "ticketNumber":"123XYZ",
            "additionalTicketText":"?",
            "underName":{
               "@type":"Person",
               "name":"Mary Smith"
            },
            "ticketedSeat":{
               "@type":"Seat",
               "seatingType":"1st Class",
               "seatNumber":"27",
               "seatRow":"A"
            }
         },
         "duration":"4 Hrs, 40 mins",
         "cancellationPolicy":"24 Hours",
         "paymentDescription":"Paid in Full",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
      {
         "@context":"http://schema.org",
         "@type":"TransferReservation",
         "reservationNumber":"546324",
         "reservationId":"44242567",
         "supplierConfirmationStatus":"confirmed",
         "salability":"level 1",
         "lastReviewedBy":"Sandy Smith",
         "lastReviewedByDate":"2021-05-01T08:00:00-08:00",
         "modifiedTime":"2021-03-14T13:05:00-05:00",
         "daySortSlot":0,
         "image":"http://example.com/image.png",
         "reservationFor":{
            "@type":"LocalBusiness",
            "name":"Bills Limo",
            "address":{
               "@type":"PostalAddress",
               "streetAddress":"45 Village Run Cir",
               "addressLocality":"Snowmass Village",
               "addressRegion":"CO",
               "postalCode":"81615",
               "addressCountry":"US"
            },
            "telephone":"415-771-1400",
            "url":"http://www.example.com"
         },
         "vehicle":"Black Towncar",
         "pickupLocation":{
            "@type":"Place",
            "name":"Hertz San Diego Airport"
         },
         "pickupTime":"2022-01-09T16:00:00-07:00",
         "dropoffLocation":{
            "@type":"Place",
            "name":"Hertz LAX"
         },
         "dropoffTime":"2022-01-09T19:30:00-07:00",
         "cancellationPolicy":"24 Hours for 80% refund",
         "additionalText":"Notes for the traveler ...",
         "numAdults":2,
         "paymentDescription":"Paid in Full",
         "bookingPrice":"$10",
         "internalNotes":"Notes...",
         "collaboratorNotes":"Notes for Collaborators...",
         "unlocked":false
      },
	  {
        "@context": "http://schema.org",
        "@type": "OtherTransportation",
        "reservationNumber": "735324",
        "reservationId": "448725",
        "supplierConfirmationStatus" : "confirmed",
        "salability" : "level 1",
        "lastReviewedBy" : "Sandy Smith",
        "lastReviewedByDate" : "2013-05-01T08:00:00-08:00",
        "modifiedTime": "2013-03-14T13:05:00-05:00",
        "daySortSlot": 0,
        "image": "http://example.com/image.png",
        "reservationFor": {
            "@type": "LocalBusiness",
            "name": "Bills Delivery Service",
            "address": {
            "@type": "PostalAddress",
            "streetAddress": "476 Village Run Cir",
            "addressLocality": "Snowmass Village",
            "addressRegion": "CO",
            "postalCode": "81615",
            "addressCountry": "US"
            },
            "telephone": "415-771-1400",
            "url": "http://www.example.com"
        },
        "vehicle": "Box Van",
        "pickupLocation": {
            "@type": "Place",
            "name": "Hertz San Diego Airport"
        },
        "pickupTime": "2017-08-05T16:00:00-07:00",
        "dropoffLocation": {
            "@type": "Place",
            "name": "Hertz LAX"
            },
            "dropoffTime": "2017-08-05T19:30:00-07:00",
            "duration":"4 Hrs, 40 mins",
            "cancellationPolicy": "24 Hours for 80% refund",
            "additionalText": "Notes for the traveler ...",
            "numAdults": 2,
            "paymentDescription": "Paid in Full",
            "bookingPrice": "$10",
            "internalNotes": "Notes...",
            "collaboratorNotes": "Notes for Collaborators...",
            "unlocked":false
    }
   ]
}