This is an auto-generated translation

行程安排的 API 交付

透過行程,您可以顯示客戶的預訂資訊並協助他們找到 booking-related 產品或服務,例如旅遊或體驗。您還可以使用數據來分析預訂趨勢並為利害關係人建立報告。

送貨選項

您的行程資料 API 傳送可以使用推送或拉取機制。

推播機制

推送服務旨在在 near-real 時間內發送行程更新,重點關注核心 transaction-level 細節。此選項可讓您:

  • 在您的網站或應用程式上顯示客戶的預訂訊息
  • 為您的客戶提供旅行所需的額外產品和服務

推播事件將透過 Webhook 以 HTTP POST訊息的格式傳送到您提供的 URL。這些訊息可能無序到達,因此請參考 creation_dateupdate_date_time元素來決定順序。

有關如何採用此傳送選項的詳細信息,請參閱API 設定

提取機制

拉取服務提供詳細的行程資料以支援:

  • 數據分析
  • 推送失敗的時間視窗資料檢索
  • 服務台調查

此服務由兩個 HTTP GET端點組成,可讓您:

  • 使用 creation_date_startcreation_date_endupdate_date_time_startupdate_date_time_end變數建立在指定時間範圍內建立或更新的行程列表
  • 透過其檢索特定行程 itinerary_id

有關身份驗證過程的詳細信息,請參閱API 設定

可用欄位

下表列出我們推播和提取交付方法所提供的欄位,包括所有嵌入物件。

以名稱開頭並緊接英文句號的欄位名稱 (例如,<variable>.<nested variable>) 可指出嵌入關係。

白牌範本

欄位名稱定義範例
itinerary_id行程編號或銷售點訂單參考編號。72622069245694
status行程和當中個別項目的狀態。可能的值:
已確認
已取消
creation_date*最初預訂的日期,以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-05
update_date_time*行程的最後更新日期和時間,以 ISO 8601 日期格式表示 (YYYY-MM-dd'T"HH:mm:ss.SSSZ)。2023-10-21T00:00:00.000Z
online指示行程是在線上預訂 (true) 還是透過代理商預訂 (false)。以布林值表示。true
package指示行程是套餐的一部分還是獨立預訂。以布林值表示。false
payment_type付款時使用的付款方式。可能的值:
信用卡
點數
分期付款
point_of_sale_country_code旅客預訂所用銷售點的國家/地區代碼。以雙字母 ISO 3166-1 alpha-2 格式表示。GB
purchaser預訂者的身分識別。請參閱 purchaser 表格以取得嵌入項目清單。 
property_booking_items做為行程一部分而預訂的住宿項目。請參閱 property_booking_items 表格以取得嵌入項目清單。 
flight_booking_items做為行程一部分而預訂的機票項目。請參閱 flight_booking_items 表格以取得嵌入項目清單。 
car_booking_items做為行程一部分而預訂的租車項目。請參閱 car_booking_items 表格以取得嵌入項目清單。 
activity_booking_items做為行程一部分而預訂的活動項目。請參閱 activity_booking_items 表格以取得嵌入項目清單。 
insurance_booking_items做為行程一部分而預訂的保險項目。請參閱 insurance_booking_items 表格以取得嵌入項目清單。 
rate預訂項目或整體行程的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 
coupon套用至行程的優惠券 (如果適用)。請參閱 coupon 表格以取得嵌入項目清單。 
|

訂購者

這些欄位會識別進行預訂的人員。

欄位名稱定義範例
purchaser.email**預訂者的電子郵件地址。smith@example.com
purchaser.loyalty_id**會員計畫的識別碼。12345678
purchaser.first_name**預訂人的名字。
purchaser.last_name**預訂人的姓氏。Smith

property_booking_items

這些欄位會列出做為行程一部分而預訂的住宿項目。

欄位名稱定義範例
booking_item_id做為行程一部分而預訂的特定元素識別碼。1400882912
status特定住宿元素的狀態。可能的值:
已確認
已取消
checkin_date*相應住宿元素的入住日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-01
checkout_date*相應住宿元素的退房日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-05
property.idExpedia Group 的飯店或度假租賃物業的唯一識別碼。1400882912
property.chain_name旅宿隸屬的連鎖體系名稱 (如果適用)。獨立住宿
property.brand_name旅宿隸屬的品牌名稱 (如果適用)。單一連鎖體系可能包含多個品牌。Savoy Signature
property.name飯店或出租度假屋的名稱。飯店 1
property.city旅宿所在城市的名稱。多倫多
property.state_province_name旅宿所在州/省的名稱。安大略
property.country_code旅宿所在國家/地區的名稱。以雙字母 ISO 3166-1 alpha-2 格式表示。CA
property.star_rating旅宿星級。3.0
room_name預訂的客房的類型,由飯店或度假租賃公司定義。Comfort 雙人房客房附私人浴室
adult_count相應預訂所包含的成人人數。2
child_count相應預訂所包含的兒童人數。0
expedia_collect布林值,用來表示預訂是否已在付款頁面支付 (true),還是必須直接支付給供應商 (false)。true
property_confirmation_id***飯店或度假租賃公司提供的確認號碼。1516171819
rate住宿預訂的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 

flight_booking_items

這些欄位會列出做為行程一部分而預訂的機票項目。

欄位名稱定義範例
booking_item_id做為行程一部分而預訂的特定元素識別碼。1400882911
status特定機票行程的狀態。可能的值:
已確認
已取消
departure_date*相應機票行程元素的開始日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-01
arrival_date*相應機票行程元素的結束日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-02
airline.plating_carrier_name簽發機票的航空公司名稱。加拿大航空
airline.plating_carrier_code簽發機票的航空公司的國際航空運輸協會 (IATA) 代碼。AC
carrier_pnr簽發機票的航空公司記錄的乘客姓名。SMITH
trip_type預訂的旅行類型。可能的值:
單程
來回
多個目的地
fare_class機票艙等。經濟艙
airport_origin_code出發機場的 IATA 代碼。LHR
airport_origin_location出發地機場的所在地。倫敦,英國 (LHR-希斯洛機場)
airport_destination_code目的地機場的代碼。以 IATA 格式表示。YYZ
airport_destination_location目的地機場的所在地。多倫多,安大略 (YYZ-列斯特 B. 皮爾森國際機場)
ticket_number航班的機票號碼。123456789
expedia_collect布林值,用來表示預訂是否已在付款頁面支付 (true),還是必須直接支付給供應商 (false)。true
segment_count機票的航段數量。1
rate機票預訂的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 

car_booking_items

這些欄位會列出做為行程一部分而預訂的租車項目。

欄位名稱定義範例
booking_item_id做為行程一部分而預訂的特定元素識別碼。1400882910
status特定租車行程的狀態。可能的值:
已確認
已取消
pickup_date*租車行程元素的開始日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-02
return_date*租車行程元素的結束日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-05
rental_company.name***租車公司的名稱。Hertz
car_type***租車的類型。2/4 門小型車
pickup_location租車的取車地點。鹿湖,紐芬蘭與拉布拉多 (YDF-鹿湖地方機場)
pickup_country_code***取車地點的國家/地區代碼。以雙字母 ISO 3166-1 alpha-2 格式表示。CA
return_location租車的還車地點。鹿湖,紐芬蘭與拉布拉多 (YDF-鹿湖地方機場)
return_country_code***還車地點的國家/地區代碼。以雙字母 ISO 3166-1 alpha-2 格式表示。CA
trip_type預訂的旅行類型。可能的值:
單程
來回
多個目的地
rental_company_confirmation_id***汽車租賃公司提供的確認號碼。ABC1234
expedia_collect布林值,用來表示預訂是否已在付款頁面支付 (true),還是必須直接支付給供應商 (false)。false
rate租車預訂的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 

activity_booking_items

這些欄位會列出做為行程一部分而預訂的活動項目。

欄位名稱定義範例
booking_item_id做為行程一部分而預訂的特定元素識別碼。1400882910
status特定活動的狀態。可能的值:
已確認
已取消
activity_start_date*活動的開始日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-03
activity_end_date*活動的結束日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-03
vendor.name***提供活動的廠商名稱。奧利維亞之旅
vendor.city***活動廠商所在的城市。鹿湖,紐芬蘭與拉布拉多 (YDF-鹿湖地方機場)
vendor.country_code***活動廠商所在的城市代碼。以雙字母 ISO 3166-1 alpha-2 格式表示。CA
offering_name***活動名稱。Passions of Paradise Great Barrier Reef
expedia_collect布林值,用來表示預訂是否已在付款頁面支付 (true),還是必須直接支付給供應商 (false)。true
rate活動預訂的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 

insurance_booking_items

這些欄位會列出做為行程一部分而預訂的保險項目。

欄位名稱定義範例
booking_item_id做為行程一部分而預訂的特定元素識別碼。1400882610
status所選特定保險的狀態。可能的值:
已確認
已取消
rate所選保險的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 

房價

這些欄位會列出預訂項目或整體行程的房價和價格詳情。它們包括描述預訂貨幣價值的嵌套值,並按預訂總價值和稅費細分。

欄位名稱定義範例
rate_plan_name用來為項目定價的房價計畫名稱。僅適用於物業預訂項目。僅訂客房
rate_plan_type預訂使用的房價類型。僅適用於物業預訂項目。經銷房價
refundable相應的預訂組件是否可以退款 (true) 或不可退款 (false)。true
pricing物件捕獲預訂的貨幣價值,按預訂總價值和稅費細分。 
pricing.gross_booking_value捕獲預訂貨幣價值的對象。 
pricing.gross_booking_value.billable_currency表示用於支付的貨幣的預訂貨幣價值的對象。 
pricing.gross_booking_value.billable_currency.currency旅客在預訂時使用的支付貨幣。以 ISO 4217 格式表示。GBP
pricing.gross_booking_value.billable_currency.value總預訂價值。2520.80
pricing.taxes_and_fees預訂所含稅金和費用的價值與貨幣。 
pricing.taxes_and_fees.billable_currency預訂所含稅金和費用的貨幣價值 (以付款所用的貨幣表示)。 
pricing.taxes_and_fees.billable_currency.currency旅客在預訂時使用的支付貨幣。以 ISO 4217 格式表示。GBP
pricing.taxes_and_fees.billable.currency.value預訂的總預訂金額。491.10

優惠券

欄位名稱定義範例
code***預訂使用的優惠代碼。ABCD
name***優惠券名稱。PRIME
description***優惠券詳情。BoGo 5%
currency***所套用優惠券價值的貨幣。以 ISO 4217 格式表示。GBP
value***優惠券的貨幣價值。126.04

所有白標模板欄位的註釋

* 日期欄位採用協調世界時 (UTC)。
** 這代表個人識別資訊 (PII) 資料。請務必按照貴公司的指南正確處理此問題。請只在必要時納入。
*** 這些欄位的資料將在預訂建立或更新後的第二天下午 6:00 至晚上 8:00 (UTC) 之間提供。目前無法透過近乎即時的方式提供。

旅行社聯盟計劃 (TAAP)

欄位名稱定義範例
itinerary_id行程編號或銷售點訂單參考編號。72622069245694
status行程和當中個別項目的狀態。可能的值:
已確認
已取消
creation_date*最初預訂的日期,以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-05
update_date_time*行程的最後更新日期和時間,以 ISO 8601 日期格式表示 (YYYY-MM-dd'T"HH:mm:ss.SSSZ)。2023-10-21T00:00:00.000Z
online指示行程是在線上預訂 (true) 還是透過代理商預訂 (false)。以布林值表示。true
point_of_sale_country_code客戶進行預訂所在國家/地區的代碼。以雙字母 ISO 3166-1 alpha-2 格式表示。GB
purchaser預訂者的身分識別。請參閱 purchaser 表格以取得嵌入項目清單。 
agency識別進行預訂的 TAAP 代理商和代理商。請參閱 agency 表格以取得嵌入項目清單。 
payment行程的付款資訊。請參閱 payment 表格以取得嵌入項目清單。 
property_booking_items做為行程一部分而預訂的住宿項目。請參閱 property_booking_items 表格以取得嵌入項目清單。 
flight_booking_items做為行程一部分而預訂的機票項目。請參閱 flight_booking_items 表格以取得嵌入項目清單。 
car_booking_items做為行程一部分而預訂的租車項目。請參閱 car_booking_items 表格以取得嵌入項目清單。 
activity_booking_items做為行程一部分而預訂的活動項目。請參閱 activity_booking_items 表格以取得嵌入項目清單。 
rate預訂項目或整體行程的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 
earnings預訂項目或整個行程的佣金詳情。請參閱 earnings 表格以取得嵌入項目清單。 
|

訂購者

這些字段標識了將要旅行的人。

欄位名稱定義範例
purchaser.email**旅行者的電子郵件地址。smith@example.com
purchaser.first_name**旅行者的名字。
purchaser.last_name**旅行者的姓氏。Smith

機構

這些欄位標識了進行預訂的 TAAP 代理商和代理人。

欄位名稱定義範例
agency.name進行預訂的 TAAP 代理商的名稱。世界旅行
agency.id進行預訂的 TAAP 代理商的追蹤程式碼。WS02555
agency.agent.first_name**進行預訂的 TAAP 代理的名字。Bob
agency.agent.last_name**進行預訂的 TAAP 代理的姓氏。Jones
agency.agent.email**進行預訂的 TAAP 代理的電子郵件地址。bjones@worldtravel.com

付款

這些欄位包含行程的付款詳情。

欄位名稱定義範例
payment_type付款時使用的付款方式。可能的值:
信用卡
個百分點
分擔工資
status表示行程是否已付款。可能的值:
有薪資的
未付
deferred行程付款是否延期 (真) 或已付款 (假)。以布林值表示。true
payment_due_date付款到期日 ISO 8601 日期格式 (YYYY-MM-DD)。僅適用於延期付款。2023-02-05
payee指示誰負責支付行程費用。可能的值:
機構
顧客

property_booking_items

這些欄位會列出做為行程一部分而預訂的住宿項目。

欄位名稱定義範例
booking_item_id做為行程一部分而預訂的特定元素識別碼。1400882912
status特定住宿元素的狀態。可能的值:
已確認
取消
checkin_date*相應住宿元素的入住日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-01
checkout_date*相應住宿元素的退房日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-05
property.idExpedia Group 飯店或出租度假屋旅宿的唯一識別碼1400882912
property.chain_name旅宿隸屬的連鎖體系名稱 (如果適用)。獨立住宿
property.brand_name旅宿隸屬的品牌名稱 (如果適用)。單一連鎖體系可能包含多個品牌。Savoy Signature
property.name飯店或出租度假屋的名稱。飯店 1
property.city旅宿所在城市的名稱。多倫多
property.state_province_name旅宿所在州/省的名稱。安大略
property.country_code旅宿所在國家/地區的名稱。以雙字母 ISO 3166-1 alpha-2 格式表示。CA
property.star_rating旅宿星級。3.0
room_name預訂的客房的類型,由飯店或度假租賃公司定義。Comfort 雙人房客房附私人浴室
adult_count預訂中包含的成人人數。2
child_count預訂中包含的兒童人數。0
expedia_collect布林值,用來表示預訂是否已在付款頁面支付 (true),還是必須直接支付給供應商 (false)。true
property_confirmation_id***飯店或度假租賃公司提供的確認號碼。1516171819
rate住宿預訂的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 

flight_booking_items

這些欄位會列出做為行程一部分而預訂的機票項目。

欄位名稱定義範例
booking_item_id做為行程一部分而預訂的特定元素識別碼。1400882911
status特定機票行程的狀態。可能的值:
已確認
已取消
departure_date*相應機票行程元素的開始日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-01
arrival_date*相應機票行程元素的結束日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-02
airline.plating_carrier_name簽發機票的航空公司名稱。加拿大航空
airline.plating_carrier_code簽發機票的航空公司的 IATA 代碼。AC
carrier_pnr簽發機票的航空公司記錄的乘客姓名。SMITH
trip_type預訂的旅行類型。可能的值:
單程
來回
多個目的地
fare_class機票艙等。經濟艙
airport_origin_code出發機場的 IATA 代碼。LHR
airport_origin_location出發地機場的所在地。倫敦,英國 (LHR-希斯洛機場)
airport_destination_code目的地機場的代碼。以 IATA 格式表示。YYZ
airport_destination_location目的地機場的所在地。多倫多,安大略 (YYZ-列斯特 B. 皮爾森國際機場)
ticket_number航班的機票號碼。123456789101
expedia_collect布林值,用來表示預訂是否已在付款頁面支付 (true),還是必須直接支付給供應商 (false)。true
segment_count機票的航段數。1
rate機票預訂的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 

car_booking_items

這些欄位會列出做為行程一部分而預訂的租車項目。

欄位名稱定義範例
booking_item_id做為行程一部分而預訂的特定元素識別碼。1400882910
status特定租車行程的狀態。可能的值:
已確認
已取消
pickup_date*租車行程元素的開始日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-02
return_date*租車行程元素的結束日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-05
rental_company.name***租車公司的名稱。Hertz
car_type***租車的類型。2/4 門小型車
pickup_location租車的取車地點。鹿湖,紐芬蘭與拉布拉多 (YDF-鹿湖地方機場)
pickup_country_code***取車地點的國家/地區代碼。以雙字母 ISO 3166-1 alpha-2 格式表示。CA
return_location租車的還車地點。鹿湖,紐芬蘭與拉布拉多 (YDF-鹿湖地方機場)
return_country_code***還車地點的國家/地區代碼。以雙字母 ISO 3166-1 alpha-2 格式表示。CA
trip_type預訂的旅行類型。可能的值:
單程
來回
多個目的地
rental_company_confirmation_id***汽車租賃公司提供的確認號碼。ABC1234
expedia_collect布林值,用來表示預訂是否已在付款頁面支付 (true),還是必須直接支付給供應商 (false)。false
rate租車預訂的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 

activity_booking_items

這些欄位會列出做為行程一部分而預訂的活動項目。

欄位名稱定義範例
booking_item_id做為行程一部分而預訂的特定元素識別碼。1400882910
status特定活動的狀態。可能的值:
已確認
已取消
activity_start_date*活動的開始日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-03
activity_end_date*活動的結束日期。以 ISO 8601 日期格式表示 (YYYY-MM-DD)。2023-02-03
vendor.name***提供活動的廠商名稱。奧利維亞之旅
vendor.city***活動廠商所在的城市。鹿湖,紐芬蘭與拉布拉多 (YDF-鹿湖地方機場)
vendor.country_code***活動廠商所在的城市代碼。以雙字母 ISO 3166-1 alpha-2 格式表示。CA
offering_name***活動名稱。亨伯河步道健行
expedia_collect布林值,用來表示預訂是否已在付款頁面支付 (true),還是必須直接支付給供應商 (false)。true
rate活動預訂的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 
earnings活動預訂項目的佣金詳情。請參閱 earnings 表格以取得嵌入項目清單。 

房價

這些欄位會列出預訂項目或整體行程的房價和價格詳情。它們包括描述預訂貨幣價值的嵌套值,並按預訂總價值和稅費細分。

欄位名稱定義範例
refundable相應的預訂組件是否可以退款 (true) 或不可退款 (false)。true
pricing物件捕獲預訂的貨幣價值,按預訂總價值和稅費細分。 
pricing.gross_booking_value預訂的貨幣價值,包含稅金和費用。 
pricing.gross_booking_value.billable_currency預訂的貨幣價值 (以付款所用的貨幣表示)。 
pricing.gross_booking_value.billable_currency.currency旅客在預訂時使用的支付貨幣。以 ISO 4217 格式表示。GBP
pricing.gross_booking_value.billable_currency.value總預訂價值。2520.80
pricing.taxes_and_fees預訂所含稅金和費用的價值與貨幣。 
pricing.taxes_and_fees.billable_currency預訂所含稅金和費用的貨幣價值 (以付款所用的貨幣表示)。 
pricing.taxes_and_fees.billable_currency.currency旅客在預訂時使用的支付貨幣。以 ISO 4217 格式表示。GBP
pricing.taxes_and_fees.billable.currency.value預訂的總預訂金額。491.10

效益

欄位名稱定義範例
commission表示預訂或項目的佣金金額的對象,包含在總預訂價值中。 
commission.billable_currency表示支付貨幣中的佣金金額的物件。 
commission.billable_currency.currency佣金價值的貨幣,以 ISO 4217 格式表示USD
commission.billable_currency.value佣金的貨幣價值。100.25
service_charge表示 TAAP 代理商對行程應用的服務費的物件。 
service_charge.amount表示 TAAP 代理商對行程應用的服務費的貨幣價值的物件。 
service_charge.amount.billable_currency表示以支付貨幣表示的服務費價值金額的物件。 
service_charge.amount.billable_currency.currency服務費用的貨幣,以 ISO 4217 格式表示。USD
service_charge.amount.billable_currency.valueTAAP 代理商對行程收取的服務費的貨幣價值。50.50
service_charge.taxes_and_fees表示服務費的稅費價值和貨幣的對象。 
service_charge.taxes_and_fees.billable_currency以支付貨幣表示服務費的稅費的貨幣價值的對象。 
service_charge.taxes_and_fees.billable_currency.currency付款貨幣,以 ISO 4217 格式表示。USD
service_charge.taxes_and_fees.billable_currency.value旅客已支付的稅金和費用 (以帳單幣別表示)。5.25

所有 TAAP 欄位的註釋

* 日期欄位採用協調世界時 (UTC)。 ** 這代表個人識別資訊 (PII) 資料。請務必按照貴公司的指南正確處理此問題。請僅在絕對必要時才包含。 *** 這些欄位的資料將在預訂建立或更新後的第二天下午 6:00 至晚上 8:00 UTC 之間提供。目前無法透過近乎即時的方式提供。

API 詳細資料

根據您的業務使用行程 API 資料的方式,我們提供了 API 模式和配置的快照。您可以下載 OpenAPI 規格並使用 API 測試軟體來了解範例和模式定義與實際輸出的比較。

白牌範本

透過我們的推拉式交付方法,我們的白標模板合作夥伴可以使用的欄位 (包括任何嵌套物件) 包括:




TAAP

我們的 TAAP 合作夥伴可以透過推拉式交付方法使用的欄位 (包括任何巢狀物件) 如下:




這個頁面有幫助嗎?
我們能如何改善內容?
感謝您協助我們進行改善!