Loyalty Earn 的 API 服務
透過 Loyalty Earn,您可以將客戶忠誠度網站 Rewards 與您的計劃進行對帳。您亦可利用這些資料,以 up-to-date 的視角檢視待核發及已核發的積分、分析計畫趨勢,並為相關利害關係人製作報告。
配送選項
我們的「Loyalty Earn」服務讓您能透過拉取機制擷取資料,該機制提供詳細的行程資料,以支援:
- 資料分析
- 向客戶發放獎勵點數
- 服務台調查
此服務包含兩個HTTP GET 端點,可讓您:
- 查看資料最後更新的時間。忠誠度積分會每日更新。
- 使用
transaction_date_start、transaction_date_end、and membership_id或itinerary_id變數,建立指定時間範圍內待處理或已兌換的忠誠度貨幣清單
有關驗證流程的詳細資訊,請參閱API 設定。
可用欄位
下表列出我們推播和提取交付方法所提供的欄位,包括所有嵌入物件。
| 欄位名稱 | 定義 | 範例 |
|---|---|---|
itinerary_id | 行程編號或銷售點訂單參考編號。 | 72622069245694 |
transaction_type | 已記錄交易的類型。 | 可能的值: 購買 獎項 修改 取消 |
transaction_date* | 預訂最後一次修改的日期。如果預訂資訊從未更新,這與book date 完全相同。以 ISO 8601 日期格式表示(YYYY-MM-DD). | 2023-02-05 |
transaction_datetime* | 預訂最後一次修改的日期和時間。若未進行任何更新,此值與 . 相同book_date。 | 2023-10-21T00:00:00.000Z |
booking_item | 代表個別預訂項目的物件。請參閱booking_item 表格以了解嵌套項目。 | — |
package_indicator | 該預訂項目是否屬於套裝行程的一部分 (例如:航班 + 飯店)。 | 可能的值: 套裝內容之一 純訂房 未知 |
currency_code | 預訂付款所使用的貨幣,以標準國際銀行帳號 (IBAN) 貨幣代碼格式呈現。 | USD |
gross_booking_value | 總預訂金額 (GBV),即包含稅金及手續費在內的總預訂金額,以實際付款貨幣計價。 | 694.89 |
base_price | 向旅客收取的金額,不含稅費、費用且未經調整,此為獎勵積分的基礎。以付款時使用的貨幣顯示。 | 154.78 |
award_date* | 授予積分的日期,以 ISO 8601 日期格式表示(YYYY-MM-DD). | 2023-03-14 |
point_definition | 表示某項活動或促銷將變更您計畫的基本收益模式。 | Partner_2X_promo |
pending_points | 已賺取但尚未發放的點數。 | 細分如下: 總計:–100.11 基準值:–90.01 獎勵分:–10.1 |
awarded_points | 該筆交易獲得的點數。 | 細分如下: 總計:100.11 基準值:90.01 額外獎勵:10.1 |
program_name | 會員計畫的名稱。 | 獎勵 |
member | 代表客戶資訊的物件。請參閱member 表格以了解嵌套項目。 |
所有欄位的說明
- 日期欄位採用太平洋標準時間 (PST),並已考慮夏令時調整。
** 個人可識別資訊 (PII) 資料。請務必依照貴公司的指引正確處理此事,並僅在絕對必要時才納入。
API 詳細資料
在此頁面探索端點的定義,然後使用 API 測試軟體,了解範例和結構描述定義與實際輸出的比較。