旅程の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` の表を参照してください。

purchaser

以下の各フィールドは、予約者の識別情報です。

フィールド名	定義	例
`purchaser.email`**	予約者のEメールアドレス。	smith@example.com
`purchaser.loyalty_id`**	ロイヤリティプログラムのメンバーシップ識別子。	12345678
`purchaser.first_name`**	ご予約者のお名前（名	ジェーン
`purchaser.last_name`**	ご予約者の姓名	Smith

property_booking_items

以下の各フィールドは、旅程の一部として予約された宿泊施設の構成要素です。

フィールド名	定義	例
`booking_item_id`	旅程の一部として予約された特定の要素の識別子。	1400882912
`status`	特定の宿泊施設要素のステータス。	可能な値確定キャンセル
`checkin_date`*	対応する宿泊施設要素のチェックイン日。ISO 8601の日付形式 (YYYY-MM-DD).	2023-02-01
`checkout_date`*	対応する宿泊施設要素のチェックアウト日。ISO 8601の日付形式 (YYYY-MM-DD).	2023-02-05
`property.id`	Expedia Group'sホテルまたはバケーションレンタルの一意の識別子施設。	1400882912
`property.chain_name`	その施設が属するホテルチェーンの名称 (該当する場合)。	Independent
`property.brand_name`	その施設が属するブランドの名称 (該当する場合)。1 つのホテルチェーンに複数のブランドがある場合があります。	Savoy Signature
`property.name`	ホテルまたはバケーションレンタルの名称	Hotel 1
`property.city`	施設が所在する都市の名称。	Toronto
`property.state_province_name`	施設が所在する州または都道府県の名称。	Ontario
`property.country_code`	施設が所在する国のコード。2 文字の ISO 3166-1 alpha-2 形式で表されます。	CA
`property.star_rating`	施設の星評価。	3.0
`room_name`	ホテルまたはバケーションレンタル会社によって定義された、予約された部屋のタイプ。	コンフォート・ダブルルーム（専用バスルーム付
`adult_count`	対応する予約に含まれる大人の人数。	2
`child_count`	対応する予約に含まれる子供の人数。	0
`expedia_collect`	予約についてお支払いページで支払われているか (true)、プロバイダーに直接支払わなければならないか (false) を表すブール値。	true
`property_confirmation_id`***	ホテルまたはバケーションレンタル会社から提供された確認番号。	1516171819
`rate`	宿泊施設予約の料金と価格設定の詳細。ネストされた項目の一覧は `rate` の表を参照してください。

flight_booking_items

以下の各フィールドは、旅程の一部として予約された航空券の構成要素です。

フィールド名	定義	例
`booking_item_id`	旅程の一部として予約された特定の要素の識別子。	1400882911
`status`	特定の航空券要素のステータス。	可能な値確定キャンセル
`departure_date`*	対応する航空券要素の開始日。ISO 8601の日付フォーマット (YYYY-MM-DD).	2023-02-01
`arrival_date`*	対応する航空券要素の終了日。ISO 8601の日付フォーマット (YYYY-MM-DD).	2023-02-02
`airline.plating_carrier_name`	航空券を発券した航空会社名。	Air Canada
`airline.plating_carrier_code`	国際航空運送協会(IATA) 航空券を発券した航空会社のコード。	AC
`carrier_pnr`	航空券を発券した航空会社に記録されている旅客名。	SMITH
`trip_type`	予約区間のタイプ。	取り得る値 : one way round trip multiple destinations
`fare_class`	航空券の運賃クラス。	Economy
`airport_origin_code`	出発空港のIATAコード。	LHR
`airport_origin_location`	出発空港の場所。	London, GB (LHR-Heathrow)
`airport_destination_code`	出発空港のコード。IATA 形式で表されます。	YYZ
`airport_destination_location`	出発空港の場所。	Toronto, ON (YYZ-Lester B. Pearson Intl.)
`ticket_number`	航空券番号。	123456789
`expedia_collect`	予約についてお支払いページで支払われているか (true)、プロバイダーに直接支払わなければならないか (false) を表すブール値。	true
`segment_count`	航空券のフライト区間数。	1
`rate`	航空券予約の料金と価格設定の詳細。ネストされた項目の一覧は `rate` の表を参照してください。

car_booking_items

以下の各フィールドは、旅程の一部として予約されたレンタカーの構成要素です。

フィールド名	定義	例
`booking_item_id`	旅程の一部として予約された特定の要素の識別子。	1400882910
`status`	特定のレンタカー要素のステータス。	可能な値確定キャンセル
`pickup_date`*	レンタカー要素の開始日。ISO 8601の日付フォーマット (YYYY-MM-DD).	2023-02-02
`return_date`*	レンタカー要素の終了日。ISO 8601の日付フォーマット (YYYY-MM-DD).	2023-02-05
`rental_company.name`***	レンタカー会社名。	Hertz
`car_type`***	借りるレンタカーのタイプ。	2/4 door compact
`pickup_location`	レンタカーの乗車場所。	Deer Lake, NL (YDF-Deer Lake Regional)
`pickup_country_code`***	レンタカー乗車場所の国コード。2 文字の ISO 3166-1 alpha-2 形式で表されます。	CA
`return_location`	レンタカーの返却場所。	Deer Lake, NL (YDF-Deer Lake Regional)
`return_country_code`***	レンタカー返却場所の国コード。2 文字の ISO 3166-1 alpha-2 形式で表されます。	CA
`trip_type`	予約区間のタイプ。	取り得る値 : one way round trip multiple destinations
`rental_company_confirmation_id`***	レンタカー会社から提供された確認番号。	ABC1234
`expedia_collect`	予約についてお支払いページで支払われているか (true)、プロバイダーに直接支払わなければならないか (false) を表すブール値。	false
`rate`	レンタカー予約の料金と価格設定の詳細。ネストされた項目の一覧は `rate` の表を参照してください。

activity_booking_items

以下の各フィールドは、旅程の一部として予約された現地ツアーの構成要素です。

フィールド名	定義	例
`booking_item_id`	旅程の一部として予約された特定の要素の識別子。	1400882910
`status`	特定の現地ツアーのステータス。	可能な値確定キャンセル
`activity_start_date`*	現地ツアーの開始日。ISO 8601の日付形式 (YYYY-MM-DD).	2023-02-03
`activity_end_date`*	現地ツアーの終了日。ISO 8601の日付形式 (YYYY-MM-DD).	2023-02-03
`vendor.name`***	現地ツアーを提供するサプライヤーの名称。	オリビアツアー
`vendor.city`***	現地ツアーのサプライヤーが所在する都市。	Deer Lake, NL (YDF-Deer Lake Regional)
`vendor.country_code`***	現地ツアーのサプライヤーが所在する国のコード。2 文字の ISO 3166-1 alpha-2 形式で表されます。	CA
`offering_name`***	現地ツアーの名称。	Passions of Paradise Great Barrier Reef
`expedia_collect`	予約についてお支払いページで支払われているか (true)、プロバイダーに直接支払わなければならないか (false) を表すブール値。	true
`rate`	現地ツアー予約の料金と価格設定の詳細。ネストされた項目の一覧は `rate` の表を参照してください。

insurance_booking_items

以下の各フィールドは、旅程の一部として予約された保険の構成要素です。

フィールド名	定義	例
`booking_item_id`	旅程の一部として予約された特定の要素の識別子。	1400882610
`status`	選択された特定の保険のステータス。	可能な値確定キャンセル
`rate`	選択された保険の料金と価格設定の詳細。ネストされた項目の一覧は `rate` の表を参照してください。

rate

以下の各フィールドは、予約項目または旅程全体の料金と価格設定の詳細です。これらは、総予約金額と税金と手数料によって分割された予約の金銭的価値を記述するネストされた値を含んでいます。

フィールド名	定義	例
`rate_plan_name`	項目の価格設定に使用される料金プランの名称。施設のご予約商品のみご利用いただけます。	Room only
`rate_plan_type`	予約に使用された料金のタイプ。施設のご予約商品のみご利用いただけます。	Distribution rate
`refundable`	対応する予約コンポーネントが払い戻し可能(true)か不可能(false)か。	true
`pricing`	総予約金額と税金および手数料に分けられた予約の金額をキャプチャするオブジェクト。
`pricing.gross_booking_value`	予約の金額を取得するオブジェクト。
`pricing.gross_booking_value.billable_currency`	支払いに使用される通貨での予約の金銭的価値を表すオブジェクト。
`pricing.gross_booking_value.billable_currency.currency`	予約のお支払いにお客様が使用する通貨。ISO 4217 形式で表されます。	GBP
`pricing.gross_booking_value.billable_currency.value`	予約総額。	2520.80
`pricing.taxes_and_fees`	予約にかかる税金および手数料の金額と通貨。
`pricing.taxes_and_fees.billable_currency`	予約にかかる税金および手数料の、お支払いに使用する通貨での金額。
`pricing.taxes_and_fees.billable_currency.currency`	予約のお支払いにお客様が使用する通貨。ISO 4217 形式で表されます。	GBP
`pricing.taxes_and_fees.billable.currency.value`	予約の総予約売上 (GBV)。	491.10

coupon

フィールド名	定義	例
`code`***	予約に使用されたクーポンコード。	ABCD
`name`***	クーポンの名称。	PRIME
`description`***	クーポンの説明。	BoGo 5%
`currency`***	クーポンの金額に適用されている通貨。ISO 4217 形式で表されます。	GBP
`value`***	クーポンの金額。	126.04

すべてのホワイトラベルテンプレートフィールドの注意事項

* 日付フィールドは協定世界時（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` の表を参照してください。

purchaser

これらのフィールドは旅行者を特定します。

フィールド名	定義	例
`purchaser.email`**	旅行者のEメールアドレス	smith@example.com
`purchaser.first_name`**	旅行者のファーストネーム	ジェーン
`purchaser.last_name`**	旅行者の姓	Smith

エージェンシー

これらのフィールドは、予約を行ったTAAP代理店とエージェントを識別します。

フィールド名	定義	例
`agency.name`	予約を行ったTAAP代理店名。	世界旅行
`agency.id`	予約を行ったTAAPエージェンシーのトラッキングコード。	WS02555
`agency.agent.first_name`**	予約を行ったTAAPエージェントのファーストネーム。	Bob
`agency.agent.last_name`**	予約を行ったTAAPエージェントの名字。	Jones
`agency.agent.email`**	予約を行ったTAAPエージェントのEメールアドレス。	bjones@worldtravel.com

お支払い

これらのフィールドには、旅程の支払いに関する詳細が含まれます。

フィールド名	定義	例
`payment_type`	チェックアウト時に使用されたお支払い方法。	指定可能な値 : クレジットカードポイントスプリットペイ
`status`	旅程の代金が支払われているかどうかを示します。	指定可能な値 : 支払い済み未払い
`deferred`	旅程の支払いが延期されたか（true）、支払われたか（false）。ブール値で表されます。	true
`payment_due_date`	支払期日ISO 8601日付形式 (YYYY-MM-DD). 後払いの場合のみ適用されます。	2023-02-05
`payee`	旅程代金の支払い責任者を示します。	指定可能な値 : エージェンシーお客様