API delivery for Itineraries

With Itineraries, you can display your customers’ booking information and help them find booking-related products or services such as tours or experiences. You can also use the data to analyze booking trends and create reports for your stakeholders.

Delivery options

Your API delivery of Itineraries data can use either a push or pull mechanism.

Push mechanism

The push service has been designed to send itinerary updates as they become available in near-real time, focusing on core transaction-level details. This option allows you to:

Display customers’ booking information on your website or app
Offer your customers additional products and services to purchase for their trip

Push events will be delivered via a Webhook to the URL you provide, in the format of an HTTP POST message. These messages may arrive unordered, so refer to the creation_date and update_date_time elements to determine order.

For details on how to adopt this delivery option, see API setup.

Pull mechanism

The pull service provides detailed itinerary data to support:

Data analysis
Data retrieval for time windows where the push delivery failed
Help desk investigations

This service consists of two HTTP GET endpoints that allow you to:

Create a list of itineraries created or updated in a specified time range using the creation_date_start, creation_date_end, update_date_time_start, and update_date_time_end variables
Retrieve specific itineraries by their itinerary_id

For details on the authentication process, see API setup.

Available fields

The tables below list the fields, including any nested objects, available through our push and pull delivery methods.

Field names that begin with a name followed by a period (for example, <variable>.<nested variable>) indicate a nesting relationship.

White Label Template

Field name	Definition	Example
`itinerary_id`	The itinerary number or point of sale order reference number.	72622069245694
`status`	The status of the itinerary and of its individual items.	Possible values: confirmed cancelled
`creation_date`*	The date a booking was initially made, represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-05
`update_date_time`*	The last update date and time for the itinerary, represented in ISO 8601 date format (YYYY-MM-dd"T"HH:mm:ss.SSSZ).	2023-10-21T00:00:00.000Z
`online`	Indicates whether the itinerary was booked online (true) or via an agent (false). Represented as a Boolean.	true
`package`	Indicates whether the itinerary is a part of a package or a standalone booking. Represented as a Boolean.	false
`payment_type`	The means of payment used at checkout.	Possible values: credit card points split pay
`point_of_sale_country_code`	The country code for the point of sale from which the customer made the booking. Represented in two-letter ISO 3166-1 alpha-2 format.	GB
`purchaser`	Identification of the person who made the booking. See `purchaser` table for listing of nested items.
`property_booking_items`	Lodging components booked as part of the itinerary. See `property_booking_items` table for listing of nested items.
`flight_booking_items`	Air components booked as part of the itinerary. See `flight_booking_items` table for listing of nested items.
`car_booking_items`	Car components booked as part of the itinerary. See `car_booking_items` table for listing of nested items.
`activity_booking_items`	Activity components booked as part of the itinerary. See `activity_booking_items` table for listing of nested items.
`insurance_booking_items`	Insurance components booked as part of the itinerary. See `insurance_booking_items` table for listing of nested items.
`rate`	The rate and pricing details of a booking item or of the whole itinerary. See `rate` table for listing of nested items.
`coupon`	The coupon applied to the itinerary, when applicable. See `coupon` table for listing of nested items.

purchaser

These fields identify the person who made the booking.

Field name	Definition	Example
`purchaser.email`**	Email address of the person who made the booking.	smith@example.com
`purchaser.loyalty_id`**	Loyalty program membership identifier.	12345678
`purchaser.first_name`**	First name of the person who made the booking.	Jane
`purchaser.last_name`**	Last name of the person who made the booking.	Smith

property_booking_items

These fields list the lodging components booked as part of the itinerary.

Field name	Definition	Example
`booking_item_id`	Identifier of a specific element booked as part of an itinerary.	1400882912
`status`	Status of the specific lodging element.	Possible values: confirmed cancelled
`checkin_date`*	Date of check-in for the corresponding lodging element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-01
`checkout_date`*	Date of check-out for the corresponding lodging element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-05
`property.id`	Expedia Group’s unique identifier for the hotel or vacation rental property.	1400882912
`property.chain_name`	Name of the chain the property belongs to, when applicable.	Independent
`property.brand_name`	Name of the brand the property belongs to, when applicable. A chain may have multiple brands.	Savoy Signature
`property.name`	Name of the hotel or vacation rental.	Hotel 1
`property.city`	Name of the city where the property is located.	Toronto
`property.state_province_name`	Name of the state or province where the property is located.	Ontario
`property.country_code`	Code of the country where the property is located. Represented in two-letter ISO 3166-1 alpha-2 format.	CA
`property.star_rating`	Star rating of the property.	3.0
`room_name`	The type of the booked room, as defined by the hotel or vacation rental company.	Comfort double room with private bathroom
`adult_count`	Number of adults included on the corresponding booking.	2
`child_count`	Number of children included on the corresponding booking.	0
`expedia_collect`	Boolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).	true
`property_confirmation_id`***	Confirmation number provided by the hotel or vacation rental company.	1516171819
`rate`	The rate and pricing details of the lodging booking. See `rate` table for listing of nested items.

flight_booking_items

These fields list the air components booked as part of the itinerary.

Field name	Definition	Example
`booking_item_id`	Identifier of a specific element booked as part of an itinerary.	1400882911
`status`	Status of the specific air trip element.	Possible values: confirmed cancelled
`departure_date`*	Start date of the corresponding air trip element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-01
`arrival_date`*	End date for the corresponding air trip element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-02
`airline.plating_carrier_name`	Name of the airline that issued the ticket.	Air Canada
`airline.plating_carrier_code`	International Air Transport Association (IATA) code of the airline that issued the ticket.	AC
`carrier_pnr`	Passenger name on record with the airline that issued the ticket.	SMITH
`trip_type`	The type of trip booked.	Possible values: one way round trip multiple destinations
`fare_class`	The fare class of the ticket.	Economy
`airport_origin_code`	The IATA code for the origin airport.	LHR
`airport_origin_location`	The location of the origin airport.	London, GB (LHR-Heathrow)
`airport_destination_code`	The code for the destination airport. Represented in IATA format.	YYZ
`airport_destination_location`	The location of the destination airport.	Toronto, ON (YYZ-Lester B. Pearson Intl.)
`ticket_number`	Ticket number for the flight.	123456789
`expedia_collect`	Boolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).	true
`segment_count`	The number of flight segments for the flight ticket.	1
`rate`	The rate and pricing details of the flight booking. See `rate` table for listing of nested items.

car_booking_items

These fields list the car components booked as part of the itinerary.

Field name	Definition	Example
`booking_item_id`	Identifier of a specific element booked as part of an itinerary.	1400882910
`status`	Status of the specific car trip element.	Possible values: confirmed cancelled
`pickup_date`*	Start date for the car trip element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-02
`return_date`*	End date for the car trip element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-05
`rental_company.name`***	Name of the car rental company.	Hertz
`car_type`***	Type of car rented.	2/4 door compact
`pickup_location`	Pickup location for the car.	Deer Lake, NL (YDF-Deer Lake Regional)
`pickup_country_code`***	Country code for the car pickup location. Represented in two-letter ISO 3166-1 alpha-2 format.	CA
`return_location`	Return location for the car.	Deer Lake, NL (YDF-Deer Lake Regional)
`return_country_code`***	Country code for the car return location. Represented in two-letter ISO 3166-1 alpha-2 format.	CA
`trip_type`	The type of trip booked.	Possible values: one way round trip multiple destinations
`rental_company_confirmation_id`***	Confirmation number provided by the car rental company.	ABC1234
`expedia_collect`	Boolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).	false
`rate`	The rate and pricing details of the car booking. See `rate` table for listing of nested items.

activity_booking_items

These fields list the activity components booked as part of the itinerary.

Field name	Definition	Example
`booking_item_id`	Identifier of a specific element booked as part of an itinerary.	1400882910
`status`	Status of the specific activity.	Possible values: confirmed cancelled
`activity_start_date`*	Start date for the activity. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-03
`activity_end_date`*	End date for the activity. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-03
`vendor.name`***	Name of the vendor providing the activity.	Olivia’s Tours
`vendor.city`***	City where the activity vendor is located.	Deer Lake, NL (YDF-Deer Lake Regional)
`vendor.country_code`***	Country code where the activity vendor is located. Represented in two-letter ISO 3166-1 alpha-2 format.	CA
`offering_name`***	Name of the activity.	Passions of Paradise Great Barrier Reef
`expedia_collect`	Boolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).	true
`rate`	The rate and pricing details of the activity booking. See `rate` table for listing of nested items.

insurance_booking_items

These fields list the insurance components booked as part of the itinerary.

Field name	Definition	Example
`booking_item_id`	Identifier of a specific element booked as part of an itinerary.	1400882610
`status`	Status of the specific insurance selected.	Possible values: confirmed cancelled
`rate`	The rate and pricing details of the insurance selected. See `rate` table for listing of nested items.

rate

These fields list the rate and pricing details of a booking item or of the whole itinerary. They include nested values that describe the monetary value of the booking, broken down by gross booking value and taxes and fees.

Field name	Definition	Example
`rate_plan_name`	The name of the rate plan used for pricing of the item. Available for property booking items only.	Room only
`rate_plan_type`	The type of rate used for the booking. Available for property booking items only.	Distribution rate
`refundable`	Whether the corresponding booking component is refundable (true) or not (false).	true
`pricing`	Object capturing the monetary value of the booking, broken down by gross booking value and taxes and fees.
`pricing.gross_booking_value`	Object capturing the monetary value of the booking.
`pricing.gross_booking_value.billable_currency`	Object representing the monetary value of the booking in the currency used for the payment.
`pricing.gross_booking_value.billable_currency.currency`	Currency in which the booking is paid by the customer. Represented in ISO 4217 format.	GPB
`pricing.gross_booking_value.billable_currency.value`	The gross booking value.	2520.80
`pricing.taxes_and_fees`	The value and currency of the taxes and fees for the booking.
`pricing.taxes_and_fees.billable_currency`	The monetary value of the taxes and fees for the booking, in the currency used for the payment.
`pricing.taxes_and_fees.billable_currency.currency`	Currency in which the booking is paid by the customer. Represented in ISO 4217 format.	GBP
`pricing.taxes_and_fees.billable.currency.value`	The gross booking value of the booking.	491.10

coupon

Field name	Definition	Example
`code`***	Coupon code used for the booking.	ABCD
`name`***	Coupon name.	PRIME
`description`***	Description of the coupon.	BoGo 5%
`currency`***	Currency in which the coupon value has been applied. Represented in ISO 4217 format.	GBP
`value`***	Monetary value of the coupon.	126.04

Notes for all White Label Template fields

* Date fields are in Coordinated Universal Time (UTC).
** This represents Personally Identifiable Information (PII) data. Be sure to handle this correctly per your company’s guidelines. Please include only when absolutely necessary.
*** Data for these fields will be made available between 6:00 PM and 8:00 PM UTC on the day after the booking was created or updated. Not currently available in near-real time.

Travel Agent Affiliate Program (TAAP)

Field name	Definition	Example
`itinerary_id`	The itinerary number or point of sale order reference number.	72622069245694
`status`	The status of the itinerary and of its individual items.	Possible values: confirmed cancelled
`creation_date`*	The date a booking was initially made, represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-05
`update_date_time`*	The last update date and time for the itinerary, represented in ISO 8601 date format (YYYY-MM-dd"T"HH:mm:ss.SSSZ).	2023-10-21T00:00:00.000Z
`online`	Indicates whether the itinerary was booked online (true) or via an agent (false). Represented as a Boolean.	true
`point_of_sale_country_code`	The code for the country in which the customer made the booking. Represented in two-letter ISO 3166-1 alpha-2 format.	GB
`purchaser`	Identification of the person who made the booking. See `purchaser` table for listing of nested items.
`agency`	Identification of the TAAP agency and agent who made the booking. See `agency` table for listing of nested items.
`payment`	Payment information for the itinerary. See `payment` table for listing of nested items.
`property_booking_items`	Lodging components booked as part of the itinerary. See `property_booking_items` table for listing of nested items.
`flight_booking_items`	Air components booked as part of the itinerary. See `flight_booking_items` table for listing of nested items.
`car_booking_items`	Car components booked as part of the itinerary. See `car_booking_items` table for listing of nested items.
`activity_booking_items`	Activity components booked as part of the itinerary. See `activity_booking_items` table for listing of nested items.
`rate`	The rate and pricing details of a booking item or of the whole itinerary. See `rate` table for listing of nested items.
`earnings`	The commission details of a booking item or of the whole itinerary. See `earnings` table for listing of nested items.

purchaser

These fields identify the person who'll be traveling.

Field name	Definition	Example
`purchaser.email`**	Email address of the traveler.	smith@example.com
`purchaser.first_name`**	First name of the traveler.	Jane
`purchaser.last_name`**	Last name of the traveler.	Smith

agency

These fields identify the TAAP agency and agent who made the booking.

Field name	Definition	Example
`agency.name`	Name of the TAAP agency that made the booking.	World Travel
`agency.id`	Tracking code of the TAAP agency who made the booking.	WS02555
`agency.agent.first_name`**	First name of the TAAP agent who made the booking.	Bob
`agency.agent.last_name`**	Last name of the TAAP agent who made the booking.	Jones
`agency.agent.email`**	Email address of the TAAP agent who made the booking.	bjones@worldtravel.com

payment

These fields contain payment details for the itinerary.

Field name	Definition	Example
`payment_type`	The means of payment used at checkout.	Possible values: credit card points split pay
`status`	Indicates whether the itinerary has been paid for.	Possible values: paid unpaid
`deferred`	Whether the payment for the itinerary was deferred (true) or paid (false). Represented as a Boolean.	true
`payment_due_date`	The payment due date ISO 8601 date format (YYYY-MM-DD). Only applicable for deferred payments.	2023-02-05
`payee`	Indicates who is responsible for making the itinerary payment.	Possible values: agency customer

property_booking_items

These fields list the lodging components booked as part of the itinerary.

Field name	Definition	Example
`booking_item_id`	Identifier of a specific element booked as part of an itinerary.	1400882912
`status`	Status of the specific lodging element.	Possible values: confirmed cancelled
`checkin_date`*	Date of check-in for the corresponding lodging element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-01
`checkout_date`*	Date of check-out for the corresponding lodging element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-05
`property.id`	Expedia Group’s unique identifier for the hotel or vacation rental property	1400882912
`property.chain_name`	Name of the chain the property belongs to, when applicable.	Independent
`property.brand_name`	Name of the brand the property belongs to, when applicable. A chain may have multiple brands.	Savoy Signature
`property.name`	Name of the hotel or vacation rental.	Hotel 1
`property.city`	Name of the city where the property is located.	Toronto
`property.state_province_name`	Name of the state or province where the property is located.	Ontario
`property.country_code`	Code of the country where the property is located. Represented in in two-letter ISO 3166-1 alpha-2 format.	CA
`property.star_rating`	Star rating of the property.	3.0
`room_name`	The type of the booked room, as defined by the hotel or vacation rental company.	Comfort double room with private bathroom
`adult_count`	Number of adults included on the booking.	2
`child_count`	Number of children included on the booking.	0
`expedia_collect`	Boolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).	true
`property_confirmation_id`***	Confirmation number provided by the hotel or vacation rental company.	1516171819
`rate`	The rate and pricing details of the lodging booking. See `rate` table for listing of nested items.

flight_booking_items

These fields list the air components booked as part of the itinerary.

Field name	Definition	Example
`booking_item_id`	Identifier of a specific element booked as part of an itinerary.	1400882911
`status`	Status of the specific air trip element.	Possible values: confirmed cancelled
`departure_date`*	Start date of the corresponding air trip element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-01
`arrival_date`*	End date for the corresponding air trip element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-02
`airline.plating_carrier_name`	Name of the airline that issued the ticket.	Air Canada
`airline.plating_carrier_code`	IATA code of the airline that issued the ticket.	AC
`carrier_pnr`	Passenger name on record with the airline that issued the ticket.	SMITH
`trip_type`	The type of trip booked.	Possible values: one way round trip multiple destinations
`fare_class`	The fare class of the ticket.	Economy
`airport_origin_code`	The IATA code for the origin airport.	LHR
`airport_origin_location`	The location of the origin airport.	London, GB (LHR-Heathrow)
`airport_destination_code`	The code for the destination airport. Represented in IATA format.	YYZ
`airport_destination_location`	The location of the destination airport.	Toronto, ON (YYZ-Lester B. Pearson Intl.)
`ticket_number`	Ticket number for the flight.	123456789101
`expedia_collect`	Boolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).	true
`segment_count`	The number of flight segments for the ticket.	1
`rate`	The rate and pricing details of the flight booking. See `rate` table for listing of nested items.

car_booking_items

These fields list the car components booked as part of the itinerary.

Field name	Definition	Example
`booking_item_id`	Identifier of a specific element booked as part of an itinerary.	1400882910
`status`	Status of the specific car trip element.	Possible values: confirmed cancelled
`pickup_date`*	Start date for the car trip element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-02
`return_date`*	End date for the car trip element. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-05
`rental_company.name`***	Name of the car rental company.	Hertz
`car_type`***	Type of car rented.	2/4 door compact
`pickup_location`	Pickup location for the car.	Deer Lake, NL (YDF-Deer Lake Regional)
`pickup_country_code`***	Country code for the car pickup location. Represented in two-letter ISO 3166-1 alpha-2 format.	CA
`return_location`	Return location for the car.	Deer Lake, NL (YDF-Deer Lake Regional)
`return_country_code`***	Country code for the car return location. Represented in two-letter ISO 3166-1 alpha-2 format.	CA
`trip_type`	The type of trip booked.	Possible values: one way round trip multiple destinations
`rental_company_confirmation_id`***	Confirmation number provided by the car rental company.	ABC1234
`expedia_collect`	Boolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).	false
`rate`	The rate and pricing details of the car booking. See `rate` table for listing of nested items.

activity_booking_items

These fields list the activity components booked as part of the itinerary.

Field name	Definition	Example
`booking_item_id`	Identifier of a specific element booked as part of an itinerary.	1400882910
`status`	Status of the specific activity.	Possible values: confirmed cancelled
`activity_start_date`*	Start date for the activity. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-03
`activity_end_date`*	End date for the activity. Represented in ISO 8601 date format (YYYY-MM-DD).	2023-02-03
`vendor.name`***	Name of the vendor providing the activity.	Olivia’s Tours
`vendor.city`***	City where the activity vendor is located.	Deer Lake, NL (YDF-Deer Lake Regional)
`vendor.country_code`***	Country code where the activity vendor is located. Represented in two-letter ISO 3166-1 alpha-2 format.	CA
`offering_name`***	Name of the activity.	Humber River Trail Hike
`expedia_collect`	Boolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).	true
`rate`	The rate and pricing details of the activity booking. See `rate` table for listing of nested items.
`earnings`	The commission details of the activity booking item. See `earnings` table for listing of nested items.

rate

Field name	Definition	Example
`refundable`	Whether the corresponding booking component is refundable (true) or not (false).	true
`pricing`	Object capturing the monetary value of the booking, broken down by gross booking value and taxes and fees.
`pricing.gross_booking_value`	The monetary value of the booking including taxes and fees.
`pricing.gross_booking_value.billable_currency`	The monetary value of the booking in the currency used for the payment.
`pricing.gross_booking_value.billable_currency.currency`	Currency in which the booking is paid by the customer. Represented in ISO 4217 format.	GPB
`pricing.gross_booking_value.billable_currency.value`	The gross booking value.	2520.80
`pricing.taxes_and_fees`	The value and currency of the taxes and fees for the booking.
`pricing.taxes_and_fees.billable_currency`	The monetary value of the taxes and fees for the booking, in the currency used for the payment.
`pricing.taxes_and_fees.billable_currency.currency`	Currency in which the booking is paid by the customer. Represented in ISO 4217 format.	GBP
`pricing.taxes_and_fees.billable.currency.value`	The gross booking value of the booking.	491.10

earnings

Field name	Definition	Example
`commission`	Object representing the commission amount for the booking or item, included in the gross booking value.
`commission.billable_currency`	Object representing the commission amount in the payment currency.
`commission.billable_currency.currency`	Currency of the commission value, represented in ISO 4217 format	USD
`commission.billable_currency.value`	Monetary value of the commission.	100.25
`service_charge`	Object representing service fees applied by a TAAP agency to the itinerary.
`service_charge.amount`	Object representing the monetary value of the service fee applied by a TAAP agency to the itinerary.
`service_charge.amount.billable_currency`	Object representing the service fee value amount in the payment currency.
`service_charge.amount.billable_currency.currency`	Currency of the service charge value, represented in ISO 4217 format.	USD
`service_charge.amount.billable_currency.value`	Monetary value of the service fees applied by the TAAP agency to the itinerary.	50.50
`service_charge.taxes_and_fees`	Object representing the value and currency of the taxes and fees for the service fee.
`service_charge.taxes_and_fees.billable_currency`	Object representing the monetary value of the taxes and fees for the service fee, in the payment currency.
`service_charge.taxes_and_fees.billable_currency.currency`	Payment currency, represented in ISO 4217 format.	USD
`service_charge.taxes_and_fees.billable_currency.value`	Amount paid by the customer for taxes and fees, in the billable currency.	5.25

Notes for all TAAP fields

* Date fields are in Coordinated Universal Time (UTC). ** This represents Personally Identifiable Information (PII) data. Be sure to handle this correctly per your company’s guidelines. Please include only when absolutely necessary. *** Data for these fields will be made available between 6:00 PM and 8:00 PM UTC on the day after the booking was created or updated. Not currently available in near-real time.

API details

We’ve provided a snapshot of the API schema and configurations based on how your business would use Itineraries API data. You can download the OpenAPI specifications and use an API testing software to get an understanding of how the examples and schema definitions compare to the actual output.

White Label Template

The fields, including any nested objects, available to our White Label Template partners through our push and pull delivery methods are:

TAAP

The fields, including any nested objects, available to our TAAP partners through our push and pull delivery methods are: