旅程履歴
Rapid の Retrieve API の旅程履歴セクションでは、予約に関連付けられたすべての客室の履歴の詳細を確認できます。
概要
旅程履歴はすべての予約に役立ちますが、障害、問題、エスカレーションなどの場合の消し込みと検証に使用できるため、特に変更が加えられた予約で威力を発揮します。このソリューションには高い柔軟性があるため、エージェント / サービス提供ツールだけでなく、お客様向けのサイトやアプリなどにも組み込めます。
include=history
フラグを渡すことで既存の Retrieve API 応答に旅程履歴を含めることができ、予約旅程に関する履歴の詳細が含まれます。予約内のすべての客室ごとに専用の履歴セクションが利用可能になり、各セクションは 3 つの予約イベント オブジェクト (created
、modified
、canceled
) で構成されます。さらに、Expedia Group のエージェントによる旅程レベルの調整が可能な itinerary_history
セクションも表示されます。
created | modified | canceled |
---|---|---|
イベントオブジェクトには元の予約の詳細が含まれます。 | イベントオブジェクトには予約に対して行われた変更の詳細が含まれます。* | イベントオブジェクトには予約に対して行われたキャンセルの詳細が含まれます。 |
同じフロー内で複数の大幅な変更 (財務に影響を与える変更) をまとめて行った場合、履歴には modified
イベントが 1 つだけ記録されます。ただし、大幅な変更が 1 つずつ分けて行われた場合、履歴には複数の modified
オブジェクトが表示されます。
*特定の客室の旅程履歴の modified
イベントは、API または Expedia Group のサービス/エージェントツールを介して客室に大幅な変更が加えられた場合にのみ生成されます。名前の変更、禁煙 / 喫煙の希望、宿泊施設への要望の変更など、Change Details API または Expedia Group のサービス / エージェントツールを通じて客室に加えられた、財務に影響を及ぼさない変更は軽微な変更とみなされ、新しい変更イベントとしては反映されません。ただし、客室の最新のイベントにマージされます。
たとえば、次の対応ではこれらの旅程履歴の詳細が生成されます。
- 1 室予約を作成すると、
created
イベントが生成されます。 - Change Details API または Expedia Group のサービス / エージェントツールを介して宿泊施設への要望を更新しても、
modified
イベントは生成されません。前の手順で作成された既存のcreated
イベントに、更新された / 最新のspecial_request
が表示されます。 - Hard Change API または Expedia Group のサービス / エージェントツールを介して客室を別のチェックイン日に変更するようリクエストすると、新しいチェックイン日で
modified
イベントが生成されます。 - Change Details API または Expedia Group のサービス / エージェントツールを介して
given_name
を更新しても、modified
イベントは生成されません。前の手順の既存のmodified
イベントに、更新された / 最新のgiven_name
が表示されます。 - 客室をキャンセルすると、
canceled
イベントが生成されます。
予約の履歴を表示するには、include=history
フラグを使用して Itinerary Retrieve API を呼び出す必要があります。応答では旅程レベルと客室レベル両方の詳細が返されます。
例 :
{
"itinerary_id": "8999989898988",
"rooms": [ ... ],
...
"itinerary_history": [
{
"history_id": "842737548",
"event_timestamp": "2023-06-27T13:31:15.523Z",
"event_type": "adjustment",
"amount": {
"value": "-32.10",
"currency": "USD"
},
"agent_id": "10203"
}
],
"room_history": [
[
{
"history_id": "42b4240c-109d-4bd6-a141-1db50619b700",
"event_timestamp": "2023-06-27T20:54:47.551Z",
"event_type": "created",
"event_source": "rapid_api",
"confirmation_id": {
"expedia": "34222139"
},
"status": "canceled",
"checkin": "2023-06-27",
"checkout": "2023-06-29",
"number_of_adults": 1,
"given_name": "Jane",
"family_name": "Doe",
"bed_group_id": "37310",
"smoking": false,
"special_request": "Top floor or away from street please",
"rate": {
"id": "240273974",
"merchant_of_record": "property",
"refundable": false,
"cancel_refund": {
"amount": "-76.71",
"currency": "USD"
},
"cancel_penalties": [
{
"currency": "USD",
"nights": "1",
"start": "2023-06-27T14:00:00.000-07:00",
"end": "2023-06-27T15:00:00.000-07:00"
}
],
"pricing": {
"nightly": [
[
{
"value": "66.02",
"type": "base_rate",
"currency": "USD"
},
{
"value": "10.69",
"type": "tax_and_service_fee",
"currency": "USD"
}
],
[
{
"value": "66.02",
"type": "base_rate",
"currency": "USD"
},
{
"value": "10.69",
"type": "tax_and_service_fee",
"currency": "USD"
}
]
],
"totals": {
"inclusive": {
"billable_currency": {
"value": "153.42",
"currency": "USD"
}
},
"exclusive": {
"billable_currency": {
"value": "132.04",
"currency": "USD"
}
}
}
}
},
"amount_charged": {
"billable_currency": {
"value": "153.42",
"currency": "USD"
}
},
"room_id": "213014272"
},
{
"history_id": "e5f4221f-31bc-406c-a8e5-00aa46d13564",
"event_timestamp": "2023-06-27T21:11:31.578Z",
"event_type": "modified",
"event_source": "rapid_api",
"confirmation_id": {
"expedia": "34232470"
},
"status": "canceled",
"checkin": "2023-06-27",
"checkout": "2023-06-30",
"number_of_adults": 1,
"given_name": "Jane",
"family_name": "Doe",
"bed_group_id": "37310",
"smoking": false,
"special_request": "Top floor or away from street please",
"rate": {
"id": "240242975",
"merchant_of_record": "property",
"refundable": false,
"cancel_refund": {
"amount": "-191.100",
"currency": "USD"
},
"cancel_penalties": [
{
"currency": "USD",
"nights": "1",
"start": "2023-06-27T14:00:00.000-07:00",
"end": "2023-06-27T15:00:00.000-07:00"
}
],
"amenities": [
"2192",
"2109"
],
"pricing": {
"nightly": [
[
{
"value": "83.000",
"type": "base_rate",
"currency": "USD"
},
{
"value": "12.550",
"type": "tax_and_service_fee",
"currency": "USD"
}
],
[
{
"value": "83.000",
"type": "base_rate",
"currency": "USD"
},
{
"value": "12.550",
"type": "tax_and_service_fee",
"currency": "USD"
}
],
[
{
"value": "83.000",
"type": "base_rate",
"currency": "USD"
},
{
"value": "12.550",
"type": "tax_and_service_fee",
"currency": "USD"
}
]
],
"totals": {
"inclusive": {
"billable_currency": {
"value": "286.650",
"currency": "USD"
}
},
"exclusive": {
"billable_currency": {
"value": "249.000",
"currency": "USD"
}
}
}
}
},
"amount_charged": {
"billable_currency": {
"value": "209.940",
"currency": "USD"
}
},
"penalty": {
"billable_currency": {
"value": "76.71",
"currency": "USD"
}
},
"room_id": "213018273"
},
{
"history_id": "e5f4221f-31bc-406c-a8e5-00aa46d13564",
"event_timestamp": "2023-06-27T21:12:35.827852619Z",
"event_type": "canceled",
"event_source": "rapid_api",
"confirmation_id": {
"expedia": "34232470"
},
"status": "canceled",
"checkin": "2023-06-27",
"checkout": "2023-06-30",
"number_of_adults": 1,
"given_name": "Jane",
"family_name": "Doe",
"bed_group_id": "37310",
"smoking": false,
"special_request": "Top floor or away from street please",
"rate": {
"id": "242273975",
"merchant_of_record": "property",
"refundable": false,
"cancel_refund": {
"amount": "-191.100",
"currency": "USD"
},
"cancel_penalties": [
{
"currency": "USD",
"nights": "1",
"start": "2023-06-27T14:00:00.000-07:00",
"end": "2023-06-27T15:00:00.000-07:00"
}
],
"amenities": [
"2192",
"2109"
],
"pricing": {
"nightly": [
[
{
"value": "83.000",
"type": "base_rate",
"currency": "USD"
},
{
"value": "12.550",
"type": "tax_and_service_fee",
"currency": "USD"
}
],
[
{
"value": "83.000",
"type": "base_rate",
"currency": "USD"
},
{
"value": "12.550",
"type": "tax_and_service_fee",
"currency": "USD"
}
],
[
{
"value": "83.000",
"type": "base_rate",
"currency": "USD"
},
{
"value": "12.550",
"type": "tax_and_service_fee",
"currency": "USD"
}
]
],
"totals": {
"inclusive": {
"billable_currency": {
"value": "286.650",
"currency": "USD"
}
},
"exclusive": {
"billable_currency": {
"value": "249.000",
"currency": "USD"
}
}
}
}
},
"amount_refunded": {
"billable_currency": {
"value": "191.100",
"currency": "USD"
}
},
"penalty": {
"billable_currency": {
"value": "95.550",
"currency": "USD"
}
},
"room_id": "213014273"
}
]
]
}
履歴が存在する旅程応答の完全な例については、Itinerary Retrieve エンドポイントの Itinerary with History
という名前の例を確認してください。