旅程のAPI配信
Itinerariesを使用すると、顧客の予約情報を表示し、ツアーや体験などのbooking-related商品やサービスを見つけることができます。また、データを利用して予約の傾向を分析し、関係者向けのレポートを作成することもできます。
配送オプション
旅程データのAPI配信は、プッシュまたはプルのいずれかのメカニズムを使用できます。
プッシュ方式
このプッシュサービスは、旅程の最新情報をnear-real、transaction-level。このオプションでは、以下のことが可能です:
- ウェブサイトやアプリに顧客の予約情報を表示
- 旅行中に購入できる追加商品やサービスの提供
プッシュイベントは、HTTP POST メッセージの形式で、指定したURLにWebhookを介して配信されます。これらのメッセージは順番に並べられずに届くことがあるので、creation_date とupdate_date_time 要素を参照して順番を決めてください。
この配信オプションを採用する方法の詳細については、APIセットアップを参照してください。
プル方式
プルサービスは、サポートするために詳細な旅程データを提供します:
- データ分析
- プッシュ配信に失敗したタイムウィンドウのデータ検索
- ヘルプデスク調査
このサービスは、HTTP GET の2つのエンドポイントで構成されています:
- creation_date_start、- creation_date_end、- update_date_time_start、- update_date_time_end変数を使用して、指定した時間範囲に作成または更新された旅程のリストを作成します。
- 特定の旅程を検索 itinerary_id
認証プロセスの詳細については、API setup を参照してください。
利用可能なフィールド
以下の表に、プッシュとプルの配信方法を通じて利用可能なフィールド (ネストされたオブジェクトを含む) の一覧を示します。
名前の後にピリオドが続くフィールド名 (例 : <変数>.<ネストされた変数>) はネスト関係を示しています。
ホワイトレーベルテンプレート
| フィールド名 | 定義 | 例 | 
|---|---|---|
| itinerary_id | 旅程番号または POS 注文参照番号。 | 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 | チェックアウト時に使用されたお支払い方法。 | 取り得る値 : credit card points split pay | 
| point_of_sale_country_code | お客様が予約を行った販売サイトの国コード。2 文字の 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時(UTC)の間に利用可能になります。現在、ほぼリアルタイムでは利用できません。
旅行代理店アフィリエイトプログラム(TAAP)
| フィールド名 | 定義 | 例 | 
|---|---|---|
| itinerary_id | 旅程番号または POS 注文参照番号。 | 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 | お客様が予約を行った国のコードです。2 文字の 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時(UTC)の間に利用可能になります。現在、ほぼリアルタイムでは利用できません。
API の詳細
お客様のビジネスでItineraries APIデータをどのように使用するかに基づいて、APIスキーマと設定のスナップショットを提供します。OpenAPI仕様書をダウンロードし、APIテストソフトウェアを使用することで、例やスキーマ定義と実際の出力との比較を理解することができます。
ホワイトレーベルテンプレート
ホワイトレーベルのテンプレートパートナーは、プッシュ配信とプル配信の両方の方法で、ネストされたオブジェクトを含むフィールドを利用できます:
TAAP
TAAPパートナーは、プッシュ型およびプル型の配信方法で、ネストされたオブジェクトを含むフィールドを利用できます: