行程表的 API 傳遞
透過行程規劃功能,您可顯示客戶的預訂資訊,並協助他們尋找 booking-related 的產品或服務,例如旅遊行程或體驗活動。您亦可運用這些數據分析預訂趨勢,並為相關利益方製作報告。
配送選項
您的行程資料 API 傳遞機制可採用推送或拉取任一方式。
推播機制
推送服務旨在於行程資訊於 near-real 平台更新時即時發送,重點聚焦於核心 transaction-level 行程細節。此選項可讓您:
- 在您的網站上顯示客戶的預訂資訊或 App
- 為旅客提供額外產品與服務供其購買,以滿足旅程需求
推送事件將透過 Webhook 發送至您提供的 URL,格式為HTTP POST 訊息。這些訊息可能以無序方式送達,因此請參照creation_date 與update_date_time 元素來確定順序。
有關如何採用此傳送選項的詳細資訊,請參閱API 設定說明。
提取機制
拉取服務提供詳細行程資料以支援:
- 數據分析
- 針對推送傳遞失敗的時間區間進行資料檢索
- 服務台調查
此服務包含兩個HTTP GET 端點,可讓您:
- 使用
creation_date_start、creation_date_end、update_date_time_start及update_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 表格以取得嵌入項目清單。 |
所有白標旅遊平台欄位的備註說明
日期欄位採用協調世界時 (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 表格以取得嵌入項目清單。 |
所有 TAAP 欄位的備註
日期欄位採用協調世界時 (UTC)。
此代表個人識別資訊 (PII) 數據。請務必按照貴公司的指南正確處理此問題。請只在必要時納入。
*** 這些欄位的資料將於預約建立或更新後的次日,於世界協調時間下午 6 時至 8 時期間提供。目前無法透過近乎即時的方式提供。
API 詳細資料
我們根據貴公司使用行程規劃 API 資料的方式,提供了 API 架構與設定的概覽。您可以下載 OpenAPI 規格文件,並使用 API 測試軟體來了解範例與架構定義如何與實際輸出結果進行對照。
白標旅遊平台
透過我們的推送與拉取傳輸方式,可供白標旅遊平台合作夥伴使用的欄位 (包含任何嵌套物件) 如下:
TAAP
透過我們的推送與拉取傳遞方式,可供 TAAP 合作夥伴使用的欄位 (包含任何嵌套物件) 如下: