File-based delivery for Itineraries
The standard report for Itineraries API in the Partner Portal includes transaction-level bookings, either for Lodging only or for multiple lines of business (LOBs). Using our standard reports means that you can get your data quickly, without additional development time.
Reports for the Itineraries API are made at the transaction level, and offer a curated list of more than 60 fields to choose from for Lodging, plus more than 100 fields for multi-LOB reports. Field choices include:
- Basic booking information such as travel dates, itineraries, and trip amounts
- Traveler and purchaser (if different) customer information
- Product information such as confirmation numbers, vendors and locations, the number of LOBs used, and costs
Learn more about file delivery setup
Best practices for file ingestion
Standard report default fields
There are many fields to choose from when customizing your reports. These are included by default in standard reports.
| Field name | Data type | Description | Example |
|---|---|---|---|
book_date | date | The date a booking was initially made, represented in ISO 8601 date format (YYYY-MM-DD). | 2023-02-05 |
transaction_date | date | The date a booking was last modified. This is the same as book_date if the booking is never updated. The date is represented in ISO 8601 date format (YYYY-MM-DD). | 2023-02-05 |
begin_use_date | date | The date the travel begins: departure date, check-in date, pick-up date, etc. represented in ISO 8601 date format (YYYY-MM-DD). | 2023-04-05 |
end_use_date | date | The date the travel ends: arrival date, check-out date, drop-off date, etc., represented in ISO 8601 date format (YYYY-MM-DD). | 2023-04-06 |
transaction_type | varchar(200) | The type of transaction recorded. | Possible values: purchase, award, modification, cancel. |
product_line_name | varchar(200) | The type of business the booking item falls under. | Possible values: Air, Car, Cruise, Destination Services, Insurance, Lodging, Package, unknown |
package_indicator | varchar(100) | Whether the booking item is part of a package (such as flight + hotel). | Possible values: part of package, standalone, unknown |
product_component | varchar(200) | Products included in a package purchase. If the purchase is not a package, only a single product line name will be shown. | Air, Car |
itinerary_number | varchar(50) | The itinerary number or point of sale order reference number. | 12345678910111 |
booking_item_id | varchar(50) | Identifier of a specific element booked as part of an itinerary. The value of the field can be positive as well as negative. | 1400882912 |
currency_code | char(3) | Currency in which the booking was paid, represented in standard International Bank Account Number (IBAN) currency code format. | USD |
gbv_local | decimal(18,4) | The gross booking value (GBV), or total booking amount including taxes and fees, in the currency used to pay. | 694.89 |
order_count | smallint | Number of orders (not items) in the package purchase. | 1 |
Additional optional fields
Note: The below table is not the order in which the fields will be displayed in the report. The order of the fields is determined by the order in which the fields are enabled during create/edit.
| Field name | Data type | Description | Example |
|---|---|---|---|
transaction_datetime | timestamp | Date/time booking was last updated (modified); is the same as the book date if booking is never changed. | 2023-02-05 06:05:00 |
booking_window | integer | Days between booked date and check-in date. | 32 |
booking_status | varchar(50) | Open, in progress, completed, awarded, or cancelled. | In progress |
online_offline_indicator | varchar(100) | Indication of whether the booking was made online or offline via an agent. | Online |
point_of_sale_country | char(3) | Point of sale from which customer is booking. | USD |
payment_type | varchar(50) | Payment method used (credit card, points, split pay). | Split pay |
coupon_code | varchar(100) | Code of coupon used. | ABCD |
coupon_name | varchar(200) | Name of coupon. | PRIME |
coupon_description | varchar(510) | Description of coupon used. | BoGo 5% |
coupon_price_amount_usd | decimal(18,4) | Amount of coupon in US Dollars. | -58.6877 |
gbv_usd | decimal(18,4) | Gross booking value of booking in US Dollars. | 694.8941 |
taxes_and_fees_local | decimal(18,4) | Total taxes and fees in local currency. | 144.77 |
taxes_and_fees_usd | decimal(18,4) | Total taxes and fees in US Dollars. | 144.77 |
taxes_and_fees_tpid | decimal(18,4) | Total taxes and fees in TPID currency. | 144.77 |
insurance_gbv_local | decimal(18,4) | Amount of insurance in local currency. | 80.4 |
insurance_gbv_usd | decimal(18,4) | Amount of insurance in US Dollars. | 80.4 |
air_supplier_pnr | varchar(100) | Supplier air passenger name record. | ABCDEF |
air_carrier_pnr | varchar(100) | Air carrier passenger name record. | BCDEFG |
air_business_model | varchar(200) | Business model of air component of booking. | Agency |
air_trip_type | varchar(200) | Type of air trip. | One way |
air_fare_class | varchar(200) | Class of air fare purchased. | Business class |
air_plating_carrier | varchar(200) | Name of air carrier. | Air Canada |
airport_origin_code | char(3) | Airport code where flight is departing/originating from. | YYZ |
airport_origin_location | varchar(406) | Location where flight is departing/originating from. | Toronto, Ontario CAN |
airport_destination_code | char(3) | Airport code where flight is arriving at/the destination. | FLL |
airport_destination_location | varchar(406) | Location where flight is arriving at/the destination. | Fort Lauderdale, Florida USA |
air_ticket_number | varchar(100) | Airline ticket number. | 123456789101 |
air_ticket_count | smallint | Number of air tickets in booking (with detailed files including booking item ID usually 0 or 1). | 1 |
air_segment_count | smallint | Number of segments of the air trip (if aggregated above booking item ID level, it will be a summation of all segments for all passengers in the booking). | 2 |
air_gbv_local | decimal(18,4) | Gross booking value of air portion of booking in local currency. | 694.8941 |
air_gbv_usd | decimal(18,4) | Gross booking value of air portion of booking in US Dollars. | 694.8941 |
air_gbv_tpid | decimal(18,4) | Gross booking value of air portion of booking in TPID currency. | 694.8941 |
air_tpid_currency_code | char(3) | TPID booking currency represented in standard International Bank Account Number (IBAN) currency code format. | USD |
total_person_count | integer | Total number of people accounted for within the booking (lodging portion only). | 3 |
adult_count | smallint | Number of adults accounted for within the booking (lodging portion only). | 2 |
child_count | smallint | Number of children accounted for within the booking (lodging portion only). | 1 |
lodging_supplier_confirmation_code | varchar(100) | Confirmation code provided by property at booking. | 1516171819 |
lodging_business_model | varchar(200) | Business model of lodging component of booking. | Merchant |
lodging_chain_independent | varchar(200) | Indicator of whether property is an independent or part of a chain. | Independent |
lodging_chain_name | varchar(200) | Name of chain (brand) of property booked. | Independent |
lodging_property_name | varchar(200) | Name of property booked | Hotel Cordelia |
lodging_star_rating | float | Star rating of property booked. | 3 |
lodging_property_city | varchar(40) | City where booked property is located. | Paris |
lodging_property_market_name | varchar(80) | Market where booked property is located. | IDF - Paris, France |
lodging_property_state_province | varchar(40) | State/province where booked property is located. | Paris |
lodging_property_country | varchar(80) | Country code where booked property is located. | France |
lodging_refundable_rate_indicator | varchar(100) | Indication of whether or not the rate booked is refundable or non refundable. | Refundable cancel penalty rate. |
lodging_rate_plan_name | varchar(200) | Name of rate plan booked. | Package |
lodging_rate_type_name | varchar(200) | Name of rate type booked. | Package |
lodging_room_type_name | varchar(200) | Name of room type booked. | Comfort double room, private bathroom |
lodging_length_of_stay | integer | Length of stay (number of nights) at booked property. | 5 |
lodging_room_count | smallint | Number of rooms booked at property. | 1 |
lodging_room_night_count | smallint | Number of room nights in booking (length of stay * room count). | 5 |
lodging_gbv_local | decimal(18,4) | Gross booking value of lodging portion of booking in local currency. | 1379.8 |
lodging_gbv_usd | decimal(18,4) | Gross booking value of lodging portion of booking in US Dollars. | 1029.9317 |
lodging_gbv_tpid | decimal(18,4) | Gross booking value of lodging portion of booking in TPID currency. | 1029.9317 |
lodging_average_daily_rate_local | decimal(18,4) | Average daily rate of booked property (GBV / length of stay) in local currency. | 275.96 |
lodging_average_daily_rate_usd | decimal(18,4) | Average daily rate of booked property (GBV / length of stay) in US Dollars. | 205.9863 |
lodging_tpid_currency_code | char(3) | Lodging TPID booking currency represented in standard International Bank Account Number (IBAN) currency code format. | USD |
car_supplier_confirmation_code | varchar(100) | Confirmation code provided by car rental company at booking. | ABC1234 |
car_business_model | varchar(200) | Business model of car component of booking. | n/a |
car_vendor_name | varchar(200) | Name of car rental company booked. | Hertz |
car_type | varchar(200) | Type of car booked. | 2/4 door compact |
car_pickup_location_code | char(3) | Location code (usually airport code) where booked car is to be picked up. | YDF |
car_pickup_location | varchar(200) | Location where car booked is to be picked up. | Deer Lake, NL (YDF-Deer Lake Regional) |
car_dropoff_location_code | char(3) | Location code (usually airport code) where booked car is to be dropped off. | YDF |
car_dropoff_location | varchar(200) | Location where car booked is to be dropped off. | Deer Lake, NL (YDF-Deer Lake Regional) |
car_trip_type | varchar(200) | Whether car is booked round trip or one way. | Round trip |
car_rental_day_count | smallint | Number of days car was booked for. | 7 |
car_count | smallint | Number of cars booked. | 1 |
car_gbv_local | decimal(18,4) | Gross booking value of car portion of booking in local currency. | 310.8 |
car_gbv_usd | decimal(18,4) | Gross booking value of car portion of booking in US Dollars. | 231.9919 |
car_gbv_tpid | decimal(18,4) | Gross booking value of car portion of booking in TPID currency. | 1029.9317 |
car_tpid_currency_code | char(3) | Car TPID booking currency represented in standard International Bank Account Number (IBAN) currency code format. | USD |
activity_offering_name | varchar(200) | Name of Destination Services activity booked. | Passions of Paradise Great Barrier Reef |
activity_vendor_name | varchar(200) | Name of Destination Services vendor booked. | Viator (3P) |
activity_vendor_city | varchar(200) | City where vendor branch is located. | Unknown |
activity_vendor_country_code | char(3) | Country code where vendor branch is located. | NZL |
activity_ticket_count | smallint | Number of tickets booked for activity. | 1 |
activity_gbv_local | decimal(18,4) | Gross booking value of Destination Services portion of booking in local currency. | 204.02 |
activity_gbv_usd | decimal(18,4) | Gross booking value of Destination Services portion of booking in US Dollars. | 152.2878 |
activity_gbv_tpid | decimal(18,4) | Gross booking value of activity portion of booking in TPID currency. | 1029.9317 |
activity_tpid_currency_code | char(3) | Activity TPID booking currency represented in standard International Bank Account Number (IBAN) currency code format. | USD |
loyalty_id | varchar(200) | Loyalty / membership ID number. | 12345678 |
program_id | varchar(200) | Represents tier information | 6549 |
passenger_name | varchar(200) | Name of person attached to the bookings (usually same as purchaser name except for airline bookings where all ticketed passengers are listed). | James Smith |
purchaser_first_name | varchar(200) | First name of person purchasing booking. | James |
purchaser_last_name | varchar(200) | Last name of person purchasing booking. | Smith |
purchaser_email_address | varchar(200) | Email address of person purchasing booking. | james.smith@email.com |
billing_address | varchar(200) | Address of person purchasing booking (including street, city, state/province, country, postal code). | 123 1st Street, New York, NY |
billing_phone_number | varchar(200) | Phone number of person purchasing booking. | 10111213141 |
promotional_mail_indicator | char(3) | Indicator of whether individual is signed up to receive promotional mail. | 0 |