Itineraries API

お客様のほぼリアルタイムの予約データにアクセスできます

Itineraries API を使用すると、お客様の予約情報を表示し、ツアーや体験などの予約関連の商品やサービスを見つけるお手伝いをすることができます。また、この API からのデータを活用して、予約のトレンドを分析し、関係者向けのレポートを作成することもできます。

利用可能なフィールド

以下の表に、プッシュとプルの配信方法を通じて利用可能なフィールド (ネストされたオブジェクトを含む) の一覧を示します。

フィールド名	定義	例
`itinerary_id`	旅程番号または POS 注文参照番号。	72622069245694
`status`	旅程とその各項目のステータス。	取り得る値 : booked cancelled
`creation_date`*	予約が最初に行われた日付で、ISO8601 日付形式 (YYYY-MM-DD) で表されます。	2023-02-05
`update_date_time`*	旅程が最後に更新された日時で、ISO8601 日付形式 (YYYY-MM-dd"T"HH:mm:ss.SSSZ) で表されます。	2023-10-21T00:00:00.000-08:00
`online`	旅程がオンラインで予約されたか、エージェント経由で予約されたかを示します。ブール値で表されます。	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

property_booking_items

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

フィールド名	定義	例
`booking_item_id`	旅程の一部として予約された特定の要素の識別子。	1400882912
`status`	特定の宿泊施設要素のステータス。	取り得る値 : booked cancelled
`checkin_date`*	対応する宿泊施設要素のチェックイン日。ISO8601 日付形式 (YYYY-MM-DD) で表されます。	2023-02-01
`checkout_date`*	対応する宿泊施設要素のチェックアウト日。ISO8601 日付形式 (YYYY-MM-DD) で表されます。	2023-02-05
`property.id`	ホテルまたはバケーションレンタル施設の Expedia Group における一意識別子	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
`room_name`	予約された客室のタイプ。	Comfort Double Room, Private Bathroom
`adult_count`	対応する予約に含まれる大人の人数。	2
`child_count`	対応する予約に含まれる子供の人数。	0
`expedia_collect`	予約についてお支払いページで支払われているか (true)、プロバイダーに直接支払わなければならないか (false) を表すブール値。	true
`property_confirmation_id`***	ホテルまたはバケーションレンタル会社から提供された確認用 ID。	1516171819
`rate`	宿泊施設予約の料金と価格設定の詳細。ネストされた項目の一覧は `rate` の表を参照してください。

flight_booking_items

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

フィールド名	定義	例
`booking_item_id`	旅程の一部として予約された特定の要素の識別子。	1400882911
`status`	特定の航空券要素のステータス。	取り得る値 : booked cancelled
`departure_date`*	対応する航空券要素の開始日。ISO8601 日付形式 (YYYY-MM-DD) で表されます。	2023-02-01
`arrival_date`*	対応する航空券要素の終了日。ISO8601 日付形式 (YYYY-MM-DD) で表されます。	2023-02-02
`airline.plating_carrier`	代理で発券された航空券の航空会社の名称。	Air Canada
`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`	航空券番号。	123456789101
`expedia_collect`	予約についてお支払いページで支払われているか (true)、プロバイダーに直接支払わなければならないか (false) を表すブール値。	true
`segment_count`	航空券のフライト区間数。	1
`rate`	航空券予約の料金と価格設定の詳細。ネストされた項目の一覧は `rate` の表を参照してください。

car_booking_items

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

フィールド名	定義	例
`booking_item_id`	旅程の一部として予約された特定の要素の識別子。	1400882910
`status`	特定のレンタカー要素のステータス。	取り得る値 : booked cancelled
`pickup_date`*	レンタカー要素の開始日。ISO8601 日付形式 (YYYY-MM-DD) で表されます。	2023-02-02
`return_date`*	レンタカー要素の終了日。ISO8601 日付形式 (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`***	レンタカー会社から提供された確認用 ID。	ABC1234
`expedia_collect`	予約についてお支払いページで支払われているか (true)、プロバイダーに直接支払わなければならないか (false) を表すブール値。	false
`rate`	レンタカー予約の料金と価格設定の詳細。ネストされた項目の一覧は `rate` の表を参照してください。

activity_booking_items

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

フィールド名	定義	例
`booking_item_id`	旅程の一部として予約された特定の要素の識別子。	1400882910
`status`	特定の現地ツアーのステータス。	取り得る値 : booked cancelled
`activity_start_date`*	現地ツアーの開始日。ISO8601 日付形式 (YYYY-MM-DD) で表されます。	2023-02-03
`activity_end_date`*	現地ツアーの終了日。ISO8601 日付形式 (YYYY-MM-DD) で表されます。	2023-02-03
`vendor.name`***	現地ツアーを提供するサプライヤーの名称。	Viator
`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
`rate`	現地ツアー予約の料金と価格設定の詳細。ネストされた項目の一覧は `rate` の表を参照してください。

insurance_booking_items

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

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

rate と pricing

以下の各フィールドは、予約項目または旅程全体の料金と価格設定の詳細です。

rate

フィールド名	定義	例
`rate_plan_name`	項目の価格設定に使用される料金プランの名称。property_booking_items についてのみ利用できます。	Room only
`rate_plan_type`	予約に使用された料金のタイプ。property_booking_items についてのみ利用できます。	Distribution rate
`refundable`	対応する予約の構成要素が返金可能かどうか。	true

pricing

このフィールドには、予約金額を記述する値がネストされており、その内訳は総予約売上 (GBV) と税金および手数料です。柔軟性のために、各フィールドはさらにネストされています。

名前の後にピリオドが続くフィールド名 (例 : <変数>.<ネストされた変数>) はネスト関係を示しています。この表のすべてのフィールドは、pricing 変数の下にネストされています。

フィールド名	定義	例
`taxes_and_fees`	予約にかかる税金および手数料の金額と通貨。以下のネストされた項目を参照してください。
`gross_booking_value`	税金および手数料を含む予約金額。	2523.00
`taxes_and_fees.billable_currency`	予約にかかる税金および手数料の、お支払いに使用する通貨での金額。`taxes_and_fees` 変数の下にネストされています。以下のネストされた項目を参照してください。
`gross_booking_value.billable_currency`	お支払いに使用する通貨での予約金額。`gross_booking_value` 変数の下にネストされています。以下のネストされた項目を参照してください。
`billable_currency.currency`	予約のお支払いにお客様が使用する通貨。ISO 4217 形式で表されます。`billable_currency` 変数の下にネストされています。	GBP
`billable.currency.value`	予約の総予約売上 (GBV)。`billable_currency` 変数の下にネストされています。	2520.80
`billable_currency.currency`	税金および手数料のお支払いにお客様が使用する通貨。ISO 4217 形式で表されます。`billable_currency` 変数の下にネストされています。	GBP
`billable_currency.value`	お客様が税金および手数料に支払った、使用する通貨での金額。`billable_currency` 変数の下にネストされています。	491.10

coupon

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

*日付フィールドは協定世界時 (UTC) です。

**個人を特定できる情報 (PII) データ。貴社のガイドラインに従って正しく処理してください。どうしても必要な場合のみ含めてください。

***これらのフィールドのデータは、予約が作成または更新された翌日の午後 6 時から午後 8 時 (UTC) の間に利用可能になります。現在、ほぼリアルタイムでは利用できません。

配信方法

Itineraries API は、プッシュとプルの 2 つの方式でデータを提供します。

プッシュ方式

プッシュサービスは、旅程の最新情報を、利用可能になったらほぼリアルタイムで、旅程の主要な詳細に焦点を絞って送信するように設計されています。このサービスは以下のユーザーケースを対象としています。

パートナーのウェブサイトやアプリにお客様の予約情報を表示できるようにする
パートナーが予約関連の商品やサービスを販売できるようにする

イベントは、指定した URL への Webhook を通じて、HTTP POST メッセージの形式で配信されます。メッセージは順番が前後して届く場合があることにご留意ください。順番を特定するには、creation_date 要素と update_date_time 要素を参照してください。

認証プロセスの詳細については、「利用開始の準備」を参照してください。

プル方式

プルサービスは、詳細な旅程データを提供し、以下のようなユーザーケースをサポートします。

データ分析を実施する
プッシュ配信に失敗した期間のデータを取得する
リアルタイムでのヘルプデスクサポートを実現する

このサービスは、2 つの HTTP GET エンドポイントで構成されています。一方は指定した時間範囲に作成または更新された旅程のリストを提供するもので、もう一方は ID で特定の旅程を取得するものです。クエリパラメータは以下の通りです。

creation_date_start
creation_date_end
update_date_time_start
update_date_time_end
itinerary_id

認証プロセスの詳細については、「利用開始の準備」を参照してください。

API の詳細

このページでエンドポイントの定義を調べてから、API テストソフトウェアを使用して、例とスキーマ定義が実際の出力とどのように比較されるかを理解します。