ロイヤルティEarn向けのAPI配信
ロイヤルティEarnをご利用いただくと、お客様のロイヤルティRewardsを、ご自身のプログラムと照合することができます。また、このデータを活用して、付与待ちおよび付与済みのポイントに関するup-to-dateな視点を提供したり、プログラムの傾向を分析したり、ステークホルダー向けのレポートを作成したりすることも可能です。
配送方法
当社の ロイヤルティEarnサービスでは、プル方式によるデータ取得が可能であり、これにより、以下の機能をサポートする詳細な旅程データを提供いたします：
- データ分析
- お客様にポイントを付与します
- ヘルプデスクの調査
このサービスは、2つのHTTP GET エンドポイントで構成されており、これらを利用することで以下のことが可能になります：
- データが最後に更新された日時をご確認ください。ロイヤルティ のポイントは毎日更新されます。
transaction_date_start、transaction_date_end、and membership_id、またはitinerary_idの各変数を使用して、指定した期間における保留中または付与済みのロイヤルティ通貨の一覧を作成します。
利用可能なフィールド
以下の表に、プッシュとプルの配信方法を通じて利用可能なフィールド (ネストされたオブジェクトを含む) の一覧を示します。
| フィールド名 | 定義 | 例 |
|---|---|---|
itinerary_id | 旅程番号または POS 注文参照番号。 | 72622069245694 |
transaction_type | 記録された取引の種類 。 | 指定可能な値 : ご購入 受賞 変更 CANCEL |
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）の通貨コード形式で表記されたものです。 | JPY |
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 | ロイヤルティ プログラムの名称。 | Rewards |
member | 顧客情報を表すオブジェクトです。ネストされた項目については、「member」の表をご参照ください。 |
すべての項目に関する注意事項
- 日付フィールドは太平洋標準時（PST）で表示されており、夏時間が適用されます。
** 個人を特定できる情報（PII）データ。必ず御社のガイドラインに従って適切に処理し、どうしても必要な場合にのみ記載してください。
API の詳細
このページでエンドポイントの定義を調べてから、API テストソフトウェアを使用して、例とスキーマ定義が実際の出力とどのように比較されるかを理解します。