The itinerary array contains travel objects that define a portion of the itinerary. The itinerary array should only be included within the metadata object."

Attributes

Attribute

Data type

Description

type

string

The type of itinerary object.
Allowed values:

  • flight
  • hotel
  • cruise
  • vacation_rental
  • rental_car

sku

string

The booking/itinerary number (if applicable).

display_name

string

Readable description of the itinerary item.

additional_value

array

Array of data objects that may help Affirm verify the validity of the order. This is a future proofing attribute that allows receiving additional info without having to change the JSON structure of the itinerary objects.

add-ons

hash

Set of key-value pairs that you can attach an amount in cents. This can be useful for storing additional information.

  • trip_insurance
  • seat_upgrade
  • service_package
  • mean_package_a
  • pool_cabana
  • late_checkout
  • cleaning_service
  • etc.

Flight attributes

Theflight type provides additional attributes that define each flight leg of the itinerary.

flight_number

string

The unique identifier for a flight including the airline IATA code. For example, if describing United flight 110, where the IATA code for United is 'UA', the flightNumber is 'UA110'.

origin

string

Airport code of flight origin.

destination

string

Airport code of flight destination.

date_start

datetime

Date and time of take-off for flight segment. ISO format, excluding milliseconds. Note: All times should be converted into UTC, for standardization.

date_end

datetime

Date and time of take-off for flight segment. ISO format, excluding milliseconds. Note: All times should be converted into UTC, for standardization.

date_start_local

datetime

Date and time of take-off for flight segment. ISO format, excluding milliseconds. Note: This specific time should be kept in local time with the timezone specified.

date_end_local

datetime

Date and time of take-off for flight segment. ISO format, excluding milliseconds. Note: This specific time should be kept in local time with the timezone specified.

num_travelers

integer

Number of travelers.

travelers

array

Array of traveler objects that contains the details of the individuals flying.

{
   "type":"flight",
   "sku":"a9dladiak",
   "display_name":"MIA-DCA-2019-12-11T12:07",
   "flight_number":"UA110",
   "origin":"MIA",
   "destination":"DCA",
   "date_start":"2019-12-11T12:07",
   "date_end":"2019-12-11T15:21",
   "fare_type":"economy",
   "num_travelers":2,
   "travelers":{
      "0":{
         "name":"John Smith",
         "dob":"1954-12-26",
         "frequent_flyer_number":"false",
         "tsa_pre_enrolled":"true",
         "passport_number_on_file":"true"
      },
      "1":{
         "name":"Jane Smith",
         "dob":"1955-11-22",
         "frequent_flyer_number":"true",
         "tsa_pre_enrolled":"true",
         "passport_number_on_file":"true"
      }
   },
   "add-ons":{
      "trip_insurance":5300
   }
}

Hotel attributes

The hotel type provides additional attributes that define each hotel stay of the itinerary.

management

string

The hotel corporation. For example, “Marriott”, “Hilton”, etc.

brand

string

The specific brand of the property.

location

object

The address object that can be parsed.

date_start

datetime

Date and time of check-in. ISO format, excluding milliseconds. Note: All times should be converted into UTC, for standardization.

date_end

datetime

Date and time of check-out. ISO format, excluding milliseconds. Note: All times should be converted into UTC, for standardization.

num_rooms

integer

The number of rooms that were included in the reservation.

rooms_details

object

The room details.

num_travelers

integer

Number of travelers.

discount_rates

boolean

Is the customer receiving a discounted rate or not.

loyalty_program

boolean

Is the customer enrolled in a loyalty program.

{
   "type":"hotel",
   "sku":"124blksn3",
   "display_name":"The Grand Hotel & Beach Club by ZZzz Hotels",
   "management":"ZZzz Hotels",
   "location":"3925 Collins Avenue, Miami Beach, FL, 33140, US",
   "date_start":"2019-12-05",
   "date_end":"2019-12-10",
   "num_rooms":1,
   "room_details":{
      "night_rate":19993,
      "room_type":"suite",
      "num_adults":2,
      "num_children":2,
      "num_beds":2
   },
   "num_traveler":4,
   "discount_rates":"true",
   "loyalty_program":"true"
}

Cruise attributes

The cruise type provides additional attributes that define each cruise itinerary.

cruiseline

string

The name of the cruise line. For example, "Carnival, "Norwegian", "Princess", etc.

origin

string

Location where cruise will start.

destination

string

Location where cruise will end.

location_stops

array

Array of international port codes where the boat will stops.

date_start

datetime

Date and time of initial check in. ISO format, excluding milliseconds. Note: All times should be converted into UTC, for standardization.

date_end

datetime

Date and time of final check out. ISO format, excluding milliseconds. Note: All times should be converted into UTC, for standardization.

room_details

object

Details around the room.

travelers

array

Array of traveler objects with additional details.

loyalty_program

boolean

Did a loyalty program number was provided.

Vacation_rental attributes

The vacation_rental type provides additional attributes that define each vacation rented during the itinerary.

management

string

The individual or company.

brand

string

The specific brand of the property.

location

array

The address object that can be parsed.

date_start

datetime

Date and time of check-in. ISO format, excluding milliseconds. Note: All times should be converted into UTC, for standardization.

date_end

datetime

Date and time of check-out. ISO format, excluding milliseconds. Note: All times should be converted into UTC, for standardization.

rental_details

object

Details around the rental.

num_travelers

integer

Number of travelers.

loyalty_program

boolean

Did a loyalty program number was provided.

Rental_car attributes

The rental_car type provides additional attributes that define each car rented during the itinerary.

company

string

The name of the rental car company. For example, "Hertz", "Enterprise", etc.

origin

string

Address of the rental car pick-up location. Airport code if applicable.

destination

string

Address of the rental car return location. Airport code if applicable.

date_start

datetime

Date and time of initial pick up. ISO format, excluding milliseconds. Note: All times should be converted into UTC, for standardization.

date_end

datetime

Date and time of final drop off. ISO format, excluding milliseconds. Note: All times should be converted into UTC, for standardization.

car_detail

object

Details around the car.

driver_detail

list

Array of driver names.

loyalty_program

boolean

Did a loyalty program number was provided.