Developer Hub

行程 API

存取近乎即時的旅客預訂資料

使用我們的行程 API，您就能顯示旅客的預訂資訊，並協助他們找出與預訂相關的產品或服務，例如旅行團或體驗。此外，您也可以使用此 API 來分析預訂趨勢，並為相關人員建立報告。

可用欄位

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

欄位名稱定義範例
itinerary_id行程編號或銷售點訂單參考編號。72622069245694
status行程和當中個別項目的狀態。可能的值：
已預訂
已取消
creation_date*最初預訂的日期，以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-05
update_date_time*行程的最後更新日期和時間，以 ISO8601 日期格式 (YYYY-MM-dd"T"HH:mm:ss.SSSZ) 表示。2023-10-21T00:00:00.000-08:00
online指明行程是否為線上預訂，或透過旅行社預訂。以布林值表示。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

property_booking_items

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

欄位名稱定義範例
booking_item_id做為行程一部分而預訂的特定元素識別碼。1400882912
status特定住宿元素的狀態。可能的值：
已預訂
已取消
checkin_date*相應住宿元素的入住日期。以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-01
checkout_date*相應住宿元素的退房日期。以 ISO8601 日期格式 (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
room_name預訂的客房類型。舒適雙人房，設有獨立衛浴
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*相應機票行程元素的開始日期。以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-01
arrival_date*相應機票行程元素的結束日期。以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-02
airline.plating_carrier代為出票的航空公司名稱。加拿大航空
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*租車行程元素的開始日期。以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-02
return_date*租車行程元素的結束日期。以 ISO8601 日期格式 (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*活動的開始日期。以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-03
activity_end_date*活動的結束日期。以 ISO8601 日期格式 (YYYY-MM-DD) 表示。2023-02-03
vendor.name***提供活動的廠商名稱。Viator
vendor.city***活動廠商所在的城市。鹿湖，紐芬蘭與拉布拉多 (YDF-鹿湖地方機場)
vendor.country_code***活動廠商所在的城市代碼。以雙字母 ISO 3166-1 alpha-2 格式表示。CA
offering_name***活動名稱。Passions of Paradise Great Barrier Reef
rate活動預訂的房價和價格詳情。請參閱 rate 表格以取得嵌入項目清單。 

insurance_booking_items

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

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

房價和價格

這些欄位會列出預訂項目或整體行程的房價和價格詳情。


房價

欄位名稱定義範例
rate_plan_name用來為項目定價的房價計畫名稱。僅適用於 property_booking_items。僅訂客房
rate_plan_type預訂使用的房價類型。僅適用於 property_booking_items。經銷房價
refundable相應的預訂項目是否可退款。true

價格

此欄位包含用來描述預訂貨幣價值的嵌入值，該值會細分為總預訂金額、稅金和費用。這些欄位會進一步嵌入，以提供更多彈性。

以名稱開頭並緊接英文句號的欄位名稱 (例如，<variable>.<nested variable>) 可指出嵌入關係。此表格中的所有欄位都會嵌入至 pricing 變數下方。

欄位名稱定義範例
taxes_and_fees預訂所含稅金和費用的價值與貨幣。請參閱下方的嵌入項目。 
gross_booking_value預訂的貨幣價值，包含稅金和費用。2523.00
taxes_and_fees.billable_currency預訂所含稅金和費用的貨幣價值 (以付款所用的貨幣表示)。嵌入至 taxes_and_fees 變數下方。請參閱下方的嵌入項目。 
gross_booking_value.billable_currency預訂的貨幣價值 (以付款所用的貨幣表示)。嵌入至 gross_booking_value 變數下方。請參閱下方的嵌入項目。 
billable_currency.currency旅客在預訂時使用的支付貨幣。以 ISO 4217 格式表示。嵌入至 billable_currency 變數下方。GBP
billable.currency.value預訂的總預訂金額。嵌入至 billable_currency 變數下方。2520.80
billable_currency.currency旅客支付稅金和費用所使用的貨幣。以 ISO 4217 格式表示。嵌入至 billable_currency 變數下方。GBP
billable_currency.value旅客已支付的稅金和費用 (以帳單幣別表示)。嵌入至 billable_currency 變數下方。491.10

優惠券

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

*日期欄位使用世界協調時間 (UTC)。

**可辨識個人的資訊 (PII) 資料。請務必按照貴公司的指南正確處理此問題。請只在必要時納入。

***這些欄位的資料將在建立或更新預訂當天的 18:00 至 20:00 UTC 之間提供。目前無法透過近乎即時的方式提供。

交付方法

行程 API 會透過兩種方法來交付資料：推播機制和提取機制。

推播機制

推播服務會於行程更新可供使用後，透過近乎即時的方式加以傳送，且著重核心行程詳情。這項服務鎖定的使用案例包括：

  • 讓合作夥伴在自身的網站或 App 上顯示旅客的預訂資訊
  • 讓合作夥伴行銷與預訂相關的產品和服務

事件將透過 Webhook 交付至您提供的 URL，並使用 HTTP POST 訊息格式。請注意，訊息可能不會依序送達。請參閱 creation_date 和 update_date_time 元素，以判斷順序。

如需驗證流程的詳細資訊，請參閱開始使用。

提取機制

提取服務會提供詳盡的行程資料，以支援以下使用案例：

  • 進行資料分析
  • 擷取推播交付失敗期間的資料
  • 提供即時的服務台支援

此服務是由兩個 HTTP GET 端點組成：一個會負責提供在特定時間範圍內建立或更新的行程清單，另一個則會依照其行程 ID 來擷取特定行程。查詢參數包括：

  • creation_date_start
  • creation_date_end
  • update_date_time_start
  • update_date_time_end
  • itinerary_id

如需驗證流程的詳細資訊，請參閱開始使用。

API 詳細資料

在此頁面探索端點的定義，然後使用 API 測試軟體，了解範例和結構描述定義與實際輸出的比較。




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

隱私權聲明Cookie 聲明使用條款

Expedia, Inc. 針對外部網站的內容恕不負責。
© 2024 Expedia, Inc. 為 Expedia Group 旗下公司。著作權所有，並保留一切權利。Expedia 智遊網和飛機標誌為 Expedia, Inc. 的商標或註冊商標。CST# 2029030-50。