Developer Hub

API delivery for Itineraries

With Itineraries, you can display 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 sends itinerary updates as they occur. Core booking fields are available within minutes of a transaction, with ancillary and enrichment fields following within 2–4 hours. This option allows you to:

  • Display customers' booking information on your website or app
  • Offer travelers 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.

Working with push events

Because itinerary data is delivered as it becomes available, you may receive multiple events for the same itinerary—an initial event with core fields followed by subsequent events as ancillary data is enriched or the itinerary is updated. See Available fields for a full breakdown of which fields arrive in real time and which follow within 2–4 hours.

Do:

  • Expect multiple events per itinerary: use itinerary_id to correlate events and always treat the event with the latest update_date_time as authoritative
  • Choose how to handle updates: when you receive a new event for an existing itinerary, you can either overwrite the previous record with the latest data, or append each event to maintain a history of changes
  • Handle missing fields gracefully: ancillary fields may be absent from early events; check for field presence before processing

Don't:

  • Assume the first event contains the full payload: ancillary fields follow in later events
  • Treat multiple events for the same itinerary as errors: this is expected behavior
  • Treat real-time financial values as final: they may be refined within 24 hours

Pull mechanism

Checkmark

Note

Pull delivery is only available to White Label Travel Platform partners.

The pull service provides detailed itinerary data to support:

  • Data analysis
  • Reconciling booking records against Expedia Group data
  • Data retrieval for time windows where push delivery failed
  • Help desk investigations

As with push delivery, itinerary data is available in two tiers for pull delivery: core fields (itinerary_ID, status, gross_booking_value, checkin_date, and checkout_date) are accessible within minutes of a booking or update, with ancillary and enrichment fields following within 2–4 hours. See Available fields for a full breakdown by field.

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.

Retrieving itinerary data by time window

To retrieve itinerary data for a given time window, poll the GET /itineraries endpoint using update_date_time_start and update_date_time_end as your query window.

Recommended approach:

  1. Use update_date_time fields for the query window: Use update_date_time_start and update_date_time_end as your query window to retrieve itineraries created or updated in a given period. Using creation_date alone will miss itinerary updates.
  2. Persist your last successful poll timestamp: Use this as your next update_date_time_start, advancing the window incrementally.
  3. Deduplicate: Use itinerary_id + update_date_time in your queries. The same itinerary may appear across multiple poll windows as ancillary fields are enriched. Always treat the record with the latest update_date_time as authoritative.

If your use case requires the most complete and timely itinerary data, push delivery is recommended.

Available fields

The tables below list the fields, including any nested objects, available through our push and pull delivery methods. The Availability column indicates when each field is typically accessible after a booking event or update:

  • Real time: Available within minutes of a booking or update
  • Near-real-time: Available within 2–4 hours of a booking or update

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

White Label Travel Platform

Field nameDefinitionExampleAvailability
itinerary_idThe itinerary number or point of sale order reference number.72622069245694Real time
statusThe status of the itinerary and of its individual items.Possible values:
confirmed
cancelled
Real time
creation_date*The date a booking was initially made, represented in ISO 8601 date format (YYYY-MM-DD).2023-02-05Real time
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.000ZReal time
onlineIndicates whether the itinerary was booked online (true) or via an agent (false). Represented as a Boolean.trueNear-real-time
packageIndicates whether the itinerary is a part of a package or a standalone booking. Represented as a Boolean.falseNear-real-time
payment_typeThe means of payment used at checkout.Possible values:
credit card
points
split pay
Real time
point_of_sale_country_codeThe country code for the point of sale from which the customer made the booking. Represented in two-letter ISO 3166-1 alpha-2 format.GBNear-real-time
purchaserIdentification of the person who made the booking. See purchaser table for listing of nested items.  
property_booking_itemsLodging components booked as part of the itinerary. See property_booking_items table for listing of nested items.  
flight_booking_itemsAir components booked as part of the itinerary. See flight_booking_items table for listing of nested items.  
car_booking_itemsCar components booked as part of the itinerary. See car_booking_items table for listing of nested items.  
activity_booking_itemsActivity components booked as part of the itinerary. See activity_booking_items table for listing of nested items.  
insurance_booking_itemsInsurance components booked as part of the itinerary. See insurance_booking_items table for listing of nested items.  
rateThe rate and pricing details of a booking item or of the whole itinerary. See rate table for listing of nested items.  
couponThe 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 nameDefinitionExampleAvailability
purchaser.email**Email address of the person who made the booking.smith@example.comReal time
purchaser.loyalty_id**Loyalty program membership identifier.12345678Near-real-time
purchaser.first_name**First name of the person who made the booking.JaneReal time
purchaser.last_name**Last name of the person who made the booking.SmithReal time

property_booking_items

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

Field nameDefinitionExampleAvailability
booking_item_idIdentifier of a specific element booked as part of an itinerary.1400882912Real time
statusStatus of the specific lodging element.Possible values:
confirmed
cancelled
Real time
checkin_date*Date of check-in for the corresponding lodging element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-01Real time
checkout_date*Date of check-out for the corresponding lodging element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-05Real time
property.idExpedia Group's unique identifier for the hotel or vacation rental property.1400882912Near-real-time
property.chain_nameName of the chain the property belongs to, when applicable.IndependentNear-real-time
property.brand_nameName of the brand the property belongs to, when applicable. A chain may have multiple brands.Savoy SignatureNear-real-time
property.nameName of the hotel or vacation rental.Hotel 1Real time
property.cityName of the city where the property is located.TorontoReal time
property.state_province_nameName of the state or province where the property is located.OntarioNear-real-time
property.country_codeCode of the country where the property is located. Represented in two-letter ISO 3166-1 alpha-2 format.CAReal time
property.star_ratingStar rating of the property.3.0Near-real-time
room_nameThe type of the booked room, as defined by the hotel or vacation rental company.Comfort double room with private bathroomNear-real-time
adult_countNumber of adults included on the corresponding booking.2Real time
child_countNumber of children included on the corresponding booking.0Real time
expedia_collectBoolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).trueNear-real-time
property_confirmation_idConfirmation number provided by the hotel or vacation rental company.1516171819Near-real-time
rateThe 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 nameDefinitionExampleAvailability
booking_item_idIdentifier of a specific element booked as part of an itinerary.1400882911Real time
statusStatus of the specific air trip element.Possible values:
confirmed
cancelled
Real time
departure_date*Start date of the corresponding air trip element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-01Real time
arrival_date*End date for the corresponding air trip element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-02Real time
airline.plating_carrier_nameName of the airline that issued the ticket.Air CanadaNear-real-time
airline.plating_carrier_codeInternational Air Transport Association (IATA) code of the airline that issued the ticket.ACReal time
carrier_pnrPassenger name on record with the airline that issued the ticket.SMITHNear-real-time
trip_typeThe type of trip booked.Possible values:
one way
round trip
multiple destinations
Near-real-time
fare_classThe fare class of the ticket.EconomyNear-real-time
airport_origin_codeThe IATA code for the origin airport.LHRReal time
airport_origin_locationThe location of the origin airport.London, GB (LHR-Heathrow)Near-real-time
airport_destination_codeThe code for the destination airport. Represented in IATA format.YYZReal time
airport_destination_locationThe location of the destination airport.Toronto, ON (YYZ-Lester B. Pearson Intl.)Near-real-time
ticket_numberTicket number for the flight.123456789Near-real-time
expedia_collectBoolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).trueNear-real-time
segment_countThe number of flight segments for the flight ticket.1Near-real-time
rateThe 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 nameDefinitionExampleAvailability
booking_item_idIdentifier of a specific element booked as part of an itinerary.1400882910Real time
statusStatus of the specific car trip element.Possible values:
confirmed
cancelled
Real time
pickup_date*Start date for the car trip element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-02Real time
return_date*End date for the car trip element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-05Real time
rental_company.nameName of the car rental company.HertzReal time
car_typeType of car rented.2/4 door compactNear-real-time
pickup_locationPickup location for the car.Deer Lake, NL (YDF-Deer Lake Regional)Real time
pickup_country_codeCountry code for the car pickup location. Represented in two-letter ISO 3166-1 alpha-2 format.CAReal time
return_locationReturn location for the car.Deer Lake, NL (YDF-Deer Lake Regional)Real time
return_country_codeCountry code for the car return location. Represented in two-letter ISO 3166-1 alpha-2 format.CAReal time
trip_typeThe type of trip booked.Possible values:
one way
round trip
multiple destinations
Near-real-time
rental_company_confirmation_idConfirmation number provided by the car rental company.ABC1234Near-real-time
expedia_collectBoolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).falseNear-real-time
rateThe 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 nameDefinitionExampleAvailability
booking_item_idIdentifier of a specific element booked as part of an itinerary.1400882910Real time
statusStatus of the specific activity.Possible values:
confirmed
cancelled
Real time
activity_start_date*Start date for the activity. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-03Real time
activity_end_date*End date for the activity. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-03Real time
vendor.nameName of the vendor providing the activity.Olivia's ToursReal time
vendor.cityCity where the activity vendor is located.Deer Lake, NL (YDF-Deer Lake Regional)Real time
vendor.country_codeCountry code where the activity vendor is located. Represented in two-letter ISO 3166-1 alpha-2 format.CAReal time
offering_nameName of the activity.Passions of Paradise Great Barrier ReefNear-real-time
expedia_collectBoolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).trueNear-real-time
rateThe 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 nameDefinitionExampleAvailability
booking_item_idIdentifier of a specific element booked as part of an itinerary.1400882610Real time
statusStatus of the specific insurance selected.Possible values:
confirmed
cancelled
Real time
rateThe 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 nameDefinitionExampleAvailability
rate_plan_nameThe name of the rate plan used for pricing of the item. Available for property booking items only.Room onlyNear-real-time
rate_plan_typeThe type of rate used for the booking. Available for property booking items only.Distribution rateNear-real-time
refundableWhether the corresponding booking component is refundable (true) or not (false).trueNear-real-time
pricingObject capturing the monetary value of the booking, broken down by gross booking value and taxes and fees.  
pricing.gross_booking_valueObject capturing the monetary value of the booking.  
pricing.gross_booking_value.billable_currencyObject representing the monetary value of the booking in the currency used for the payment.  
pricing.gross_booking_value.billable_currency.currencyCurrency in which the booking is paid by the customer. Represented in ISO 4217 format.GBPReal time
pricing.gross_booking_value.billable_currency.valueThe gross booking value.2520.80Real time
pricing.taxes_and_feesThe value and currency of the taxes and fees for the booking.  
pricing.taxes_and_fees.billable_currencyThe monetary value of the taxes and fees for the booking, in the currency used for the payment.  
pricing.taxes_and_fees.billable_currency.currencyCurrency in which the booking is paid by the customer. Represented in ISO 4217 format.GBPReal time
pricing.taxes_and_fees.billable.currency.valueThe gross booking value of the booking.491.10Real time

coupon

Field nameDefinitionExampleAvailability
codeCoupon code used for the booking.ABCDNear-real-time
nameCoupon name.PRIMENear-real-time
descriptionDescription of the coupon.BoGo 5%Near-real-time
currencyCurrency in which the coupon value has been applied. Represented in ISO 4217 format.GBPNear-real-time
valueMonetary value of the coupon.126.04Near-real-time

Notes for all White Label Travel Platform 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. Include only when absolutely necessary.

Travel Agent Affiliate Program (TAAP)

Field nameDefinitionExampleAvailability
itinerary_idThe itinerary number or point of sale order reference number.72622069245694Real time
agency_reference_codeA custom itinerary reference provided by the agency at checkout.86549B_GBReal time
statusThe status of the itinerary and of its individual items.Possible values:
confirmed
cancelled
Near-real-time
creation_date*The date a booking was initially made, represented in ISO 8601 date format (YYYY-MM-DD).2023-02-05Real time
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.000ZReal time
onlineIndicates whether the itinerary was booked online (true) or via an agent (false). Represented as a Boolean.trueNear-real-time
point_of_sale_country_codeThe code for the country in which the customer made the booking. Represented in two-letter ISO 3166-1 alpha-2 format.GBNear-real-time
purchaserIdentification of the person who made the booking. See purchaser table for listing of nested items.  
agencyIdentification of the TAAP agency and agent who made the booking. See agency table for listing of nested items.  
paymentPayment information for the itinerary. See payment table for listing of nested items.  
property_booking_itemsLodging components booked as part of the itinerary. See property_booking_items table for listing of nested items.  
flight_booking_itemsAir components booked as part of the itinerary. See flight_booking_items table for listing of nested items.  
car_booking_itemsCar components booked as part of the itinerary. See car_booking_items table for listing of nested items.  
activity_booking_itemsActivity components booked as part of the itinerary. See activity_booking_items table for listing of nested items.  
rateThe rate and pricing details of a booking item or of the whole itinerary. See rate table for listing of nested items.  
earningsThe 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 nameDefinitionExampleAvailability
purchaser.email**Email address of the traveler.smith@example.comReal time
purchaser.first_name**First name of the traveler.JaneReal time
purchaser.last_name**Last name of the traveler.SmithReal time

agency

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

Field nameDefinitionExampleAvailability
agency.nameName of the TAAP agency that made the booking.World TravelNear-real-time
agency.idTracking code of the TAAP agency who made the booking.WS02555Real time
agency.agent.first_name**First name of the TAAP agent who made the booking.BobReal time
agency.agent.last_name**Last name of the TAAP agent who made the booking.JonesReal time
agency.agent.email**Email address of the TAAP agent who made the booking.bjones@worldtravel.comReal time

payment

These fields contain payment details for the itinerary.

Field nameDefinitionExampleAvailability
payment_typeThe means of payment used at checkout.Possible values:
credit card
points
split pay
Real time
statusIndicates whether the itinerary has been paid for.Possible values:
paid
unpaid
Near-real-time
deferredWhether the payment for the itinerary was deferred (true) or paid (false). Represented as a Boolean.trueNear-real-time
payment_due_dateThe payment due date ISO 8601 date format (YYYY-MM-DD). Only applicable for deferred payments.2023-02-05Near-real-time
payeeIndicates who is responsible for making the itinerary payment.Possible values:
agency
customer
Near-real-time

property_booking_items

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

Field nameDefinitionExampleAvailability
booking_item_idIdentifier of a specific element booked as part of an itinerary.1400882912Real time
statusStatus of the specific lodging element.Possible values:
confirmed
cancelled
Real time
checkin_date*Date of check-in for the corresponding lodging element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-01Real time
checkout_date*Date of check-out for the corresponding lodging element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-05Real time
property.idExpedia Group's unique identifier for the hotel or vacation rental property1400882912Near-real-time
property.chain_nameName of the chain the property belongs to, when applicable.IndependentNear-real-time
property.brand_nameName of the brand the property belongs to, when applicable. A chain may have multiple brands.Savoy SignatureNear-real-time
property.nameName of the hotel or vacation rental.Hotel 1Real time
property.cityName of the city where the property is located.TorontoReal time
property.state_province_nameName of the state or province where the property is located.OntarioNear-real-time
property.country_codeCode of the country where the property is located. Represented in two-letter ISO 3166-1 alpha-2 format.CAReal time
property.star_ratingStar rating of the property.3.0Near-real-time
room_nameThe type of the booked room, as defined by the hotel or vacation rental company.Comfort double room with private bathroomNear-real-time
adult_countNumber of adults included on the booking.2Real time
child_countNumber of children included on the booking.0Real time
expedia_collectBoolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).trueNear-real-time
property_confirmation_idConfirmation number provided by the hotel or vacation rental company.1516171819Near-real-time
rateThe rate and pricing details of the lodging booking. See rate table for listing of nested items.  
earningsThe commission details of the lodging booking. See earnings table for listing of nested items.  

flight_booking_items

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

Field nameDefinitionExampleAvailability
booking_item_idIdentifier of a specific element booked as part of an itinerary.1400882911Real time
statusStatus of the specific air trip element.Possible values:
confirmed
cancelled
Real time
departure_date*Start date of the corresponding air trip element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-01Real time
arrival_date*End date for the corresponding air trip element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-02Real time
airline.plating_carrier_nameName of the airline that issued the ticket.Air CanadaNear-real-time
airline.plating_carrier_codeIATA code of the airline that issued the ticket.ACReal time
carrier_pnrPassenger name on record with the airline that issued the ticket.SMITHNear-real-time
trip_typeThe type of trip booked.Possible values:
one way
round trip
multiple destinations
Near-real-time
fare_classThe fare class of the ticket.EconomyNear-real-time
airport_origin_codeThe IATA code for the origin airport.LHRReal time
airport_origin_locationThe location of the origin airport.London, GB (LHR-Heathrow)Near-real-time
airport_destination_codeThe code for the destination airport. Represented in IATA format.YYZReal time
airport_destination_locationThe location of the destination airport.Toronto, ON (YYZ-Lester B. Pearson Intl.)Near-real-time
ticket_numberTicket number for the flight.123456789101Near-real-time
expedia_collectBoolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).trueNear-real-time
segment_countThe number of flight segments for the ticket.1Near-real-time
rateThe rate and pricing details of the flight booking. See rate table for listing of nested items.  
earningsThe commission details of the flight booking. See earnings table for listing of nested items.  

car_booking_items

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

Field nameDefinitionExampleAvailability
booking_item_idIdentifier of a specific element booked as part of an itinerary.1400882910Real time
statusStatus of the specific car trip element.Possible values:
confirmed
cancelled
Real time
pickup_date*Start date for the car trip element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-02Real time
return_date*End date for the car trip element. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-05Real time
rental_company.nameName of the car rental company.HertzReal time
car_typeType of car rented.2/4 door compactNear-real-time
pickup_locationPickup location for the car.Deer Lake, NL (YDF-Deer Lake Regional)Real time
pickup_country_codeCountry code for the car pickup location. Represented in two-letter ISO 3166-1 alpha-2 format.CAReal time
return_locationReturn location for the car.Deer Lake, NL (YDF-Deer Lake Regional)Real time
return_country_codeCountry code for the car return location. Represented in two-letter ISO 3166-1 alpha-2 format.CAReal time
trip_typeThe type of trip booked.Possible values:
one way
round trip
multiple destinations
Near-real-time
rental_company_confirmation_idConfirmation number provided by the car rental company.ABC1234Near-real-time
expedia_collectBoolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).falseNear-real-time
rateThe rate and pricing details of the car booking. See rate table for listing of nested items.  
earningsThe commission details of the car booking. See earnings table for listing of nested items.  

activity_booking_items

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

Field nameDefinitionExampleAvailability
booking_item_idIdentifier of a specific element booked as part of an itinerary.1400882910Real time
statusStatus of the specific activity.Possible values:
confirmed
cancelled
Real time
activity_start_date*Start date for the activity. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-03Real time
activity_end_date*End date for the activity. Represented in ISO 8601 date format (YYYY-MM-DD).2023-02-03Real time
vendor.nameName of the vendor providing the activity.Olivia's ToursReal time
vendor.cityCity where the activity vendor is located.Deer Lake, NL (YDF-Deer Lake Regional)Real time
vendor.country_codeCountry code where the activity vendor is located. Represented in two-letter ISO 3166-1 alpha-2 format.CAReal time
offering_nameName of the activity.Humber River Trail HikeNear-real-time
expedia_collectBoolean value representing whether the booking has been paid for at checkout (true) or must be paid directly to the provider (false).trueNear-real-time
rateThe rate and pricing details of the activity booking. See rate table for listing of nested items.  
earningsThe commission details of the activity booking item. See earnings 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 nameDefinitionExampleAvailability
refundableWhether the corresponding booking component is refundable (true) or not (false).trueNear-real-time
pricingObject capturing the monetary value of the booking, broken down by gross booking value and taxes and fees.  
pricing.gross_booking_valueThe monetary value of the booking including taxes and fees.  
pricing.gross_booking_value.billable_currencyThe monetary value of the booking in the currency used for the payment.  
pricing.gross_booking_value.billable_currency.currencyCurrency in which the booking is paid by the customer. Represented in ISO 4217 format.GBPReal time
pricing.gross_booking_value.billable_currency.valueThe gross booking value.2520.80Real time
pricing.taxes_and_feesThe value and currency of the taxes and fees for the booking.  
pricing.taxes_and_fees.billable_currencyThe monetary value of the taxes and fees for the booking, in the currency used for the payment.  
pricing.taxes_and_fees.billable_currency.currencyCurrency in which the booking is paid by the customer. Represented in ISO 4217 format.GBPReal time
pricing.taxes_and_fees.billable.currency.valueThe gross booking value of the booking.491.10Real time

earnings

Field nameDefinitionExampleAvailability
commissionObject representing the commission amount for the booking or item, included in the gross booking value.  
commission.billable_currencyObject representing the commission amount in the payment currency.  
commission.billable_currency.currencyCurrency of the commission value, represented in ISO 4217 formatUSDReal time
commission.billable_currency.valueMonetary value of the commission.100.25Real time
service_chargeObject representing service fees applied by a TAAP agency to the itinerary.  
service_charge.amountObject representing the monetary value of the service fee applied by a TAAP agency to the itinerary.  
service_charge.amount.billable_currencyObject representing the service fee value amount in the payment currency.  
service_charge.amount.billable_currency.currencyCurrency of the service charge value, represented in ISO 4217 format.USDReal time
service_charge.amount.billable_currency.valueMonetary value of the service fees applied by the TAAP agency to the itinerary.50.50Real time
service_charge.taxes_and_feesObject representing the value and currency of the taxes and fees for the service fee.  
service_charge.taxes_and_fees.billable_currencyObject representing the monetary value of the taxes and fees for the service fee, in the payment currency.  
service_charge.taxes_and_fees.billable_currency.currencyPayment currency, represented in ISO 4217 format.USDReal time
service_charge.taxes_and_fees.billable_currency.valueAmount paid by the customer for taxes and fees, in the billable currency.5.25Real time

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. Include only when absolutely necessary.

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 tool to understand how the examples and schema definitions compare to the actual output.

White Label Travel Platform

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




TAAP

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




Did you find this page helpful?
How can we improve this content?
Thank you for helping us improve!