This is an auto-generated translation

行程表的 API 傳遞

透過行程規劃功能,您可顯示客戶的預訂資訊,並協助他們尋找 booking-related 的產品或服務,例如旅遊行程或體驗活動。您亦可運用這些數據分析預訂趨勢,並為相關利益方製作報告。

配送選項

您的行程資料 API 傳遞機制可採用推送或拉取任一方式。

推播機制

推送服務旨在於行程資訊於 near-real 平台更新時即時發送,重點聚焦於核心 transaction-level 行程細節。此選項可讓您:

  • 在您的網站上顯示客戶的預訂資訊或 App
  • 為旅客提供額外產品與服務供其購買,以滿足旅程需求

推送事件將透過 Webhook 發送至您提供的 URL,格式為HTTP POST 訊息。這些訊息可能以無序方式送達,因此請參照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's 飯店或度假租賃旅宿的唯一識別碼。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出發機場的國際航空運輸協會代碼。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
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 時至 8 時之間提供。目前無法透過近乎即時的方式提供。

旅遊代理商聯盟計劃 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開立機票之航空公司之國際航空運輸協會代碼。AC
carrier_pnr航空公司票務系統中登記的乘客姓名。SMITH
trip_type預訂的旅行類型。可能的值:
單程
來回
多個目的地
fare_class機票艙等。經濟艙
airport_origin_code出發機場的國際航空運輸協會代碼。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
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 時至 8 時期間提供。目前無法透過近乎即時的方式提供。

API 詳細資料

我們根據貴公司使用行程規劃 API 資料的方式,提供了 API 架構與設定的概覽。您可以下載 OpenAPI 規格文件,並使用 API 測試軟體來了解範例與架構定義如何與實際輸出結果進行對照。

白標旅遊平台

透過我們的推送與拉取傳輸方式,可供白標旅遊平台合作夥伴使用的欄位 (包含任何嵌套物件) 如下:




TAAP

透過我們的推送與拉取傳遞方式,可供 TAAP 合作夥伴使用的欄位 (包含任何嵌套物件) 如下:




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