API de cancelamento de reservas de carro

Orientações e exemplos para acessar a API de cancelamento de reservas de carro

A API de cancelamento de reservas de carro permite que você cancele uma reserva existente. Ela exige dados que estão disponíveis apenas no momento da reserva. Portanto, você só pode cancelar as viagens que reservou.

Ponto de extremidade

Método	Ponto de extremidade	Pré-requisitos*
PUT	https://apim.expedia.com/cars/bookings/[TripNumber]	Um TripNumber ativo da API de reserva de carro.

Cabeçalhos obrigatórios

Key:	Chave de API da Expedia
Authorization:	Sequência de autorização de API da Expedia
Accept:	application/vnd.exp-car.v3+json
User-Id:	username@domain.com O endereço de e-mail associado à reserva.
Partner-Transaction-Id:	Sequência TransactionID do parceiro

Exemplo de solicitação de cancelamento

Solicitação

https://apim.expedia.com/cars/bookings/1065756938

Corpo do cancelamento

Opcional: inclua apenas se o parceiro quiser armazenar metadados sobre o cancelamento para posterior recuperação.

{
	"PartnerMetaData": {
		"SampleKey1": "SampleValue1",
		"SampleKey2": "SampleValue2"
	}
}

Resposta de cancelamento

{
    
    "TransactionId": "f06edfa3-27f4-44e6-838c-b8dd3d0a3210",
    "SupplierConfirmationNumber": "221542",
    "CancellationDateTime": "2021-07-20T22:01:00-0800",
    "TotalRefund": {
        "Value": "1487.12",
        "Currency": "USD"
    },
    "TotalPenalty": {
        "Value": "100.08",
        "Currency": "USD"
    },
     "DeepLinkUrls": {
        "WebItinRetrieve": {
            "Href": "https://www.expedia.com/1234567"
        },
        "ApiItinRetrieve": {
            "Accept": "application/vnd.exp-booking.v3+json",
            "Method": "Get",
            "Href": "https://apim.expedia.com/cars/bookings/12345"
        }
    }
}

Códigos de erro

Códigos de erro comuns

Código de status HTTP	Código de erro	Mensagem de erro
400	UNKNOWN_PATH	Caminho de solicitação desconhecido.
400	INVALID_ACCEPT	Accept está ausente ou é inválido. Forneça um cabeçalho Accept correto da seguinte maneira: Accept:application/vnd.exp-<product>.<version>+<format> (product={car,flight,hotel},version={v3},format={json}).
400	Apenas um cabeçalho Accept é permitido.
400	INVALID_PARTNER_TRANSACTION_ID	Partner-Transaction-Id está ausente.
400	Apenas um cabeçalho Partner-Transaction-Id é permitido.
400	INVALID_CLIENT_KEY	Chave de cliente inválida: XXX.
400	Apenas um cabeçalho Key é permitido.
400	INVALID_USER_ID	O user-Id nos cabeçalhos http está ausente ou é inválido. Ele precisa ser um e-mail válido.
400	Apenas um cabeçalho User-Id é permitido.
400	INVALID_USER_CREDENTIALS	As credenciais do usuário estão ausentes ou são inválidas.
400	ITINERARY_NOT_FOUND	O itinerário não foi encontrado. Forneça um user-id e um tripNumber válidos.
400	BOOKING_NOT_FOUND	O itinerário não foi reservado.
400	BOOKING_ALREADY_CANCELED	A reserva já foi cancelada.
400	BOOKING_CANNOT_BE_CANCELED	A reserva não pode ser cancelada.
400	INVALID_PARTNER_META_DATA	O tamanho dos metadados do parceiro excede o limite.
500	CANCEL_APPLICATION_ERROR	Falha no cancelamento. Erro do aplicativo.

Códigos de aviso

Códigos de aviso comuns

Código	Mensagem	Descrição
UNSUPPORTED_PRODUCT_TYPE	Essa reserva contém tipos de produtos não aceitos: xxx. Somente o tipo de produto carro é processado pela nossa API. Processe xxx de maneira separada.	Esse aviso é retornado ao fazer reservas com produtos não aceitos.

Detalhes da API

Aqui você pode explorar as definições de ponto de extremidade para essa API e acessar o API Explorer para testar todos os pontos de extremidade da XAP, baixar especificações OpenAPI ou baixar as nossas coleções Postman. Teste uma ou todas essas opções para entender como os exemplos e as definições de esquema se comparam com o resultado real.