行程安排的 API 交付
透過行程,您可以顯示客戶的預訂資訊並協助他們找到 booking-related 產品或服務,例如旅遊或體驗。您還可以使用數據來分析預訂趨勢並為利害關係人建立報告。
送貨選項
您的行程資料 API 傳送可以使用推送或拉取機制。
推播機制
推送服務旨在在 near-real 時間內發送行程更新,重點關注核心 transaction-level 細節。此選項可讓您:
- 在您的網站或應用程式上顯示客戶的預訂訊息
- 為您的客戶提供旅行所需的額外產品和服務
推播事件將透過 Webhook 以 HTTP POST
訊息的格式傳送到您提供的 URL。這些訊息可能無序到達,因此請參考 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: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 表格以取得嵌入項目清單。 |
所有 TAAP 欄位的註釋
* 日期欄位採用協調世界時 (UTC)。 ** 這代表個人識別資訊 (PII) 資料。請務必按照貴公司的指南正確處理此問題。請僅在絕對必要時才包含。 *** 這些欄位的資料將在預訂建立或更新後的第二天下午 6:00 至晚上 8:00 UTC 之間提供。目前無法透過近乎即時的方式提供。
API 詳細資料
根據您的業務使用行程 API 資料的方式,我們提供了 API 模式和配置的快照。您可以下載 OpenAPI 規格並使用 API 測試軟體來了解範例和模式定義與實際輸出的比較。
白牌範本
透過我們的推拉式交付方法,我們的白標模板合作夥伴可以使用的欄位 (包括任何嵌套物件) 包括:
TAAP
我們的 TAAP 合作夥伴可以透過推拉式交付方法使用的欄位 (包括任何巢狀物件) 如下: