Histórico do itinerário
A seção de histórico do itinerário da API de recuperação da Rapid permite que você veja as informações históricas de cada quarto associado à reserva
Visão geral
O histórico do itinerário é útil para todas as reservas, em especial para aquelas que sofreram alterações, pois serve para conciliação e validação em caso de interrupções, problemas, encaminhamentos etc. A solução é flexível o suficiente para ser incluída em ferramentas de agente e atendimento, bem como em sites e aplicativos voltados para o cliente.
O histórico do itinerário pode ser incluído em uma resposta da API de recuperação existente passando o sinalizador include=history
, assim as informações históricas sobre um itinerário de reserva serão incluídas. Uma seção de histórico separada vai ficar disponível para todos os quartos de uma reserva, e cada seção será constituída por três objetos de evento de reserva: created
, modified
e canceled
. Além disso, você também vai ver a seção itinerary_history
, que vai fornecer ajustes no nível do itinerário feitos por agentes do Expedia Group.
created | modified | canceled |
---|---|---|
O objeto de evento vai incluir informações da reserva original. | O objeto de evento vai incluir informações das alterações feitas na reserva.* | O objeto de evento vai incluir informações dos cancelamentos feitos na reserva.* |
Se você fizer várias alterações principais, ou seja, que têm impacto financeiro, juntas no mesmo fluxo, o histórico vai ter apenas um evento modified
. Mas, se as alterações principais forem feitas de maneira separada, uma após a outra, o histórico vai mostrar vários objetos modified
.
*O evento modified
no histórico do itinerário de um determinado quarto só será gerado quando uma alteração principal for feita no quarto por meio das nossas APIs ou das ferramentas de atendimento e de agente do Expedia Group. As alterações que não têm impacto financeiro, como alteração de nome, preferência por ambientes onde não/é permitido fumar, alterações de solicitação especial etc., feitas no quarto por meio da API de detalhes da alteração ou das ferramentas de atendimento e de agente do Expedia Group são consideradas alterações secundárias e não serão refletidas como um novo evento modificado, mas serão mescladas ao último evento do quarto.
Por exemplo, as ações a seguir vão gerar as seguintes informações no histórico do itinerário:
- Criar uma reserva de quarto individual vai gerar um evento
created
. - Atualizar a solicitação especial por meio da API de detalhes da alteração ou das ferramentas de atendimento e agente do Expedia Group não vai gerar um evento
modified
. O eventocreated
existente criado na etapa anterior vai mostrar aspecial_request
atualizada ou mais recente. - Solicitar a alteração do quarto para uma data de check-in diferente por meio da API de alterações principais ou das ferramentas de atendimento e agente do Expedia Group vai gerar um evento
modified
com a nova data de check-in. - Atualizar o
given_name
por meio da API de detalhes da alteração ou das ferramentas de atendimento e agente do Expedia Group não vai gerar um eventomodified
. O evento existentemodified
criado na etapa anterior vai mostrar ogiven_name
atualizado ou mais recente. - Cancelar o quarto vai gerar um evento
canceled
.
Para visualizar o histórico da reserva, você deve chamar a API de recuperação de itinerário usando o sinalizador include=history
. As informações de nível do itinerário e do quarto serão retornadas na resposta.
Exemplo:
{
"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"
}
]
]
}
Para detectar alterações de itinerário feitas pela propriedade, procure uma combinação de tipo de evento e origem do evento.
Quando o parâmetro de solicitação include
na solicitação de recuperação de itinerário é history
:
event_source
-other
event_type
-- Para fornecedor com estadia reduzida, alteração e reembolso de cortesia:
modified
- Para fornecedor com cancelamento e no show:
canceled
- Para fornecedor com estadia reduzida, alteração e reembolso de cortesia:
Quando o parâmetro de solicitação include
na solicitação de recuperação de itinerário é history_v2
:
event_source
-supplier
event_type
-- Para fornecedor com estadia reduzida, alteração e reembolso de cortesia:
modified
- Para fornecedor com cancelamento:
canceled
- Para viajante com no show:
canceled_no_show
- Para fornecedor com estadia reduzida, alteração e reembolso de cortesia:
Para obter um exemplo completo da resposta do itinerário com o histórico presente, verifique o exemplo denominado Itinerary with History
para o ponto de extremidade de recuperação de itinerário.