Recuperar una reserva

Obtener los datos de una reserva existente.

Protocolo soportado:
HTTPS / TLS 1.2 - TLS 1.3
Endpoint:

Solicitud
Encabezados:
Accept-Encoding: gzip
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.goyEtVbG9naW5OYW1lIjoiURTLmqwCRJT05TIEdST1VQIEFTU09DSUFUT05TIFNSTCAyIiwiVWxvZ2luSUQiOiJSKLIMNCVI4MWU2YjUzZTc1ZWQxYzUwMzXXv98UMxYmIxNjliMDlhM2VlZmYxYzIyMDdhOwCvfAM1ZTA5ZjM4NDNq2jJhNGFjMDIwN2JhNGEzN2ZhNWQ3YWNmMzQ4OTQ0YjRmMDU3MTZmNGRmMDA1OGZmNzZhNiIsImlzcyI6ImFwaS5hYmctY2Fycy5jb20iLCJyZW50YWxjb21wYW55IjpbIkFWSVMiLCJCVURHRVQiXSwic2NvcGVzIjpbIlZlaFJldFJlc1JRIiwiVmVoQXZhaWxSYXRlUlEiLCJBdXRoVG9rZW5SUSIsIlZlaFJlc1JRIiwiVmVoTW9kaWZ5UlEiLCJWZWhDYW5jZWxSUSIsIlZlaEZsZWV0UlEiLCJWZWhMb2NhdGlvblJRIl0sImlhdCI6MTUxMTk4NTEzNCwiZXhwI2QASTg1MzE0fQ.Gy8hejPlT3KScb-g1x9KW2LSszESBSQO1zmZD4RTUIMz9e0yn8W6-UkYzxnlSdHsz1Z9Qe2CERCqpiqLUC
ejemplo consulta GET:
          
  https://api.carrental-int.com/v2/vehreservation/?brand=AVIS&iata=111111B&last_name=TEST&confirmation_number=12345678AR9
                    
                           
Parámetros:
campodescripción
brand
string requerido
valores aceptados
  • AVIS
  • BUDGET
iata
string requerido
valores aceptados
Número IATA / Avis Assign / Budget Assign de la agencia.
last_name
string requerido
valores aceptados
Apellido del titular de la reserva.
confirmation_number
string requerido
valores aceptados
Nombre del titular de la reserva.

Respuestas
respuesta HTTP: 200 OK
Ejemplo de respuesta exitosa :
          
{
  "appVersion": "2.0",
  "status": true,
  "brand": "AVIS",
  "environment": "Production",
  "reservation_response": {
    "customer": {
      "first_name": "PARTNER",
      "last_name": "TEST",
      "citizen_country_code": "AR",
      "arrival_details": {
        "airline_code": "AR",
        "flight_number": "1403"
      }
    },
    "reservation": {
      "confirmation_number": "12345678AR9",
      "pickup_location": "MIA",
      "return_location": "JFK",
      "pickup_datetime": "2020-03-05T10:00:00",
      "return_datetime": "2020-03-13T10:00:00",
      "rate": {
        "rate_code": "F2",
        "rate_name": "F2 - INCLUSIVE + GAS",
        "currency": "USD",
        "rate_total_amount": "312.87",
        "estimated_total_amount": "740.87",
        "discount_code": "XXXX90X",
        "rate_distance": {
          "unlimited": "true",
          "distance_unit": "Mile",
          "distance_period": "RentalPeriod"
        },
        "rental_days": "8",
        "tax": {
          "tax_total_amount": "428.00",
          "tax_currency": "USD",
          "description": "Taxes and surcharges"
        },
        "rate_inclutions": [
          "Millaje libre",
          "Coberturas LDW y ALI",
          "Un tanque de gasolina",
          "Impuestos estatales y locales",
          "Recargo de Aeropuerto",
          "Conductor Adicional"
        ]
      },
      "vehicle_charges": [
        {
          "description": "Maximum 59 Day(s)",
          "amount": "312.87",
          "currency": "USD",
          "included_in_rate": "true",
          "purpose": "1"
        },
        {
          "description": "One way fee",
          "amount": "400.00",
          "currency": "USD",
          "included_in_rate": "true",
          "purpose": "2"
        },
        {
          "description": "Local Tax",
          "amount": "28.00",
          "currency": "USD",
          "included_in_rate": "true",
          "purpose": "7"
        },
        {
          "description": "CUSTOMER FACILITY FEE",
          "amount": "0.00",
          "currency": "USD",
          "included_in_rate": "true",
          "purpose": "6"
        },
        {
          "description": "$10.00    EXTENSION FEE MAY APPLY",
          "amount": "0.00",
          "currency": "USD",
          "included_in_rate": "false",
          "purpose": "28"
        },
        {
          "description": "FUEL POLICY IS FULL TO FULL",
          "amount": "0.00",
          "currency": "USD",
          "included_in_rate": "false",
          "purpose": "28"
        },
        {
          "description": "$15.00    LATE FEE MAY APPLY",
          "amount": "0.00",
          "currency": "USD",
          "included_in_rate": "false",
          "purpose": "28"
        },
        {
          "description": "STATE SURCHARGE",
          "amount": "0.00",
          "currency": "USD",
          "included_in_rate": "true",
          "purpose": "6"
        },
        {
          "description": "TIRE & BATTERY FEE",
          "amount": "0.00",
          "currency": "USD",
          "included_in_rate": "true",
          "purpose": "6"
        },
        {
          "description": "VEH. LICENSE FEE",
          "amount": "0.00",
          "currency": "USD",
          "included_in_rate": "true",
          "purpose": "6"
        },
        {
          "description": "NO SHOW FEE MAY APPLY",
          "amount": "0.00",
          "currency": "USD",
          "included_in_rate": "false",
          "purpose": "28"
        }
      ],
      "priced_coverages": [
        {
          "coverage_code": "TPL",
          "coverage_description": "Third Party Liability (TPL)",
          "tax_inclusive": "true",
          "included_in_rate": "true",
          "amount": "0.00",
          "currency": "USD"
        },
        {
          "coverage_code": "CDW",
          "coverage_description": "Collision Damage Waiver (CDW)",
          "tax_inclusive": "true",
          "included_in_rate": "true",
          "amount": "0.00",
          "currency": "USD"
        }
      ],
      "special_equipment": [
        {
          "equipment_id": "13",
          "quantity": "1",
          "currency": "USD",
          "amount": "116.98",
          "included_in_rate": "false",
          "tax_inclusive": "false",
          "equipment_GDS_code": "GPS",
          "equipment_description": "Sistema de Navegación (GPS)"
        },
        {
          "equipment_id": "103",
          "quantity": "1",
          "currency": "USD",
          "amount": "56.92",
          "included_in_rate": "false",
          "tax_inclusive": "false",
          "equipment_GDS_code": "RSN",
          "equipment_description": "Asistencia en carretera"
        }
      ]
    },
    "vehicle": {
      "vehicle_group_code": "A",
      "vehicle_category_code": "ECAR",
      "vehicle_class_name": "Económico ",
      "vehicle_make_model": "Ford Fiesta or similar",
      "vehicle_details": {
        "name": "Ford Fiesta",
        "image_URL": "https:\/\/www.avis.com\/content\/dam\/cars\/l\/2019\/ford\/2019-ford-fiesta-se-5door-2wd-hatchback-grey.png",
        "seats": "5",
        "doors": "2-4",
        "air_conditioned": "true",
        "transmission": "auto",
        "large_suitcase": "0",
        "medium_suitcase": "1",
        "small_suitcase": "1"
      }
    },
    "RequestorAgent": {
      "RequestorID": "111111B"
    },
    "LocationDetail": {
      "PickUpLocation": {
        "LocationName": "Miami Intl Airport",
        "LocationStreet": "3900 Northwest 25th Street, Suite 402",
        "LocationCity": "Miami",
        "LocationPostalCode": "33142",
        "LocationStateCode": "FL",
        "LocationStateName": "Florida",
        "LocationCountry": "US",
        "LocationCountryName": "Estados Unidos",
        "LocationPhoneNumber": "(1) 305-876-1800",
        "LocationCode": "MIA",
        "ExtendedLocationCode": "MIAT01",
        "LocationType": "Corporate",
        "CounterLocation": "S",
        "LocationLatitude": 25.796684,
        "LocationLongitude": -80.262,
        "AtAirport": "true",
        "OperationTime": {
          "Lunes": [
            "Abierto las 24 Horas"
          ],
          "Martes": [
            "Abierto las 24 Horas"
          ],
          "Miércoles": [
            "Abierto las 24 Horas"
          ],
          "Jueves": [
            "Abierto las 24 Horas"
          ],
          "Viernes": [
            "Abierto las 24 Horas"
          ],
          "Sábado": [
            "Abierto las 24 Horas"
          ],
          "Domingo": [
            "Abierto las 24 Horas"
          ]
        }
      },
      "ReturnLocation": {
        "LocationName": "John F Kennedy Intl Airport",
        "LocationStreet": "305 Federal Circle",
        "LocationCity": "Jamaica",
        "LocationPostalCode": "11430",
        "LocationStateCode": "NY",
        "LocationStateName": "New York",
        "LocationCountry": "US",
        "LocationCountryName": "Estados Unidos",
        "LocationPhoneNumber": "(1) 718-244-5400",
        "LocationCode": "JFK",
        "ExtendedLocationCode": "JFKT01",
        "LocationType": "Corporate",
        "CounterLocation": "S",
        "LocationLatitude": 40.66007,
        "LocationLongitude": -73.80406,
        "AtAirport": "true",
        "OperationTime": {
          "Lunes": [
            "Abierto las 24 Horas"
          ],
          "Martes": [
            "Abierto las 24 Horas"
          ],
          "Miércoles": [
            "Abierto las 24 Horas"
          ],
          "Jueves": [
            "Abierto las 24 Horas"
          ],
          "Viernes": [
            "Abierto las 24 Horas"
          ],
          "Sábado": [
            "Abierto las 24 Horas"
          ],
          "Domingo": [
            "Abierto las 24 Horas"
          ]
        }
      }
    },
   "TID": "475ca1ea-bfc7-47c5-a73f-1462f3e14dca--65f412b0-9aa7-4daa-8427-45407153bb72",
   "RHMAC": "5b71b46b1b002281eab4cf5608032ef5bcb806661840e21d5fcd85c4cd926262"   
  }
}
                
Datos de la respuesta:
La respuesta del servicio será devueltan en formato array/objeto JSON (application/json)
 
campotipodescripción
appVersionstringNúmero de versión de la API
statusbooleanoestado de la respuesta al request, toma los valores "true/false" siendo "true" una respuesta normal positiva y "false" un error o fallo.
brandstringDevuelve la marca con la que se esta trabajando.
environmentstringEntorno en el que se esta trabajando: TEST (QA) o Producción (Production)
reservation_responseObjetoEngloba todos los datos de la reserva
customerObjetoDatos del cliente
first_namestringNombre del cliente
last_namestringApellido del cliente
citizen_country_codestringcódigo de pais del cliente (código de 2 carácteres - ISO 3166)
arrival_detailsObjetodatos del vuelo de arribo del cliente (si hubieran sido suministrados al momento de realizar la reserva).
airline_codestring código IATA de linea aérea (2 carácteres)
flight_numberstringNúmero de identificación asignado por la línea aérea al segmento del vuelo
reservationObjeto datos de la reserva.
confirmation_numberstringNúmero de confirmación de la reserva.
pickup_locationstringcódigo alfanumérico de oficina o aeropuerto de inicio de la renta (3 a 5 carácteres).
return_locationstringcódigo alfanumérico de oficina o aeropuerto de finalización de la renta (3 a 5 carácteres).
pickup_datetimeTimedía y hora de inicio de la renta (estándar ISO 8601 - YYYY-MM-DDThh:mm:ss)
return_datetimeTimedía y hora de finalización de la renta (estándar ISO 8601 - YYYY-MM-DDThh:mm:ss)
rateObjetoDatos de la tarifa
rate_codestringcódigo de la tarifa reservada
rate_namestringnombre comercial de la tarifa reservada
currencystringmoneda de los valores expresados en la tarifa
rate_total_amountnúmeroTotal estimado de la tarifa reservada
estimated_total_amountnúmeroTotal estimado de los gastos de la reserva (tarifa + impuestos + cargos obligatorios del vehículo)
discount_codestringCódigo de descuento utilizado en la reserva (Si hubiera sido suministrado al momento de realizar la reserva).
rate_distanceObjetoInformación sobre las opciones y limitaciones de distancia de la renta.
unlimitedbooleanoToma el valor de true si es ilimitada, false en caso de existir un limite máximo
quantitynúmeroCantidad de distancia a recorrer sin costo adicional incluida en la tarifa (solo si unlimited es igual false)
distance_unitstringUnidad de medida de la distancia
rental_daysnúmerocantidad total de días reservados
taxObjetoImpuestos obligatorios de la renta
tax_total_amountnúmeroTotal de los impuestos y cargos obligatorios sobre la renta
tax_currencystringMoneda de los valores expresados en los cargos e impuestos
descriptionstringDescripcion del cargo o impuesto
rate_inclutionsArrayInclusiones de la tarifa reservada
vehicle_chargesArrayDetalle e información de los cargos obligatorios y opcionales del vehículo
descriptionstringdescripción del cargo
amountnúmerocosto del cargo
currencystringMoneda del valor expresado en el cargo
included_in_ratestringIndica si el valor esta incluido en el monto total estimado de la reserva
purposenúmero Código OTA númerico especificando:
 
  • 1  Vehicle rental
  • 2  One way fee
  • 5  Upgrade
  • 5  Airport/City/Other Surcharge
  • 5  Airport Concession Fee
  • 5  Under Age Surcharge
  • 6  Additional Distance Charge
  • 6  Vehicle Registration Fee
  • 6  Israel Stamp Duty
  • 7  Local Tax
  • 7  Austrian Contract Tax
  • 7  Goods and Services tax
  • 8  Additional mileage / additional distance charge
  • 9  Additional Week
  • 10  Additional Day
  • 11  Additional Hour
  • 13  Under Age Surcharge
  • 22  Pre Pay Fee
  • 28  Optional Fee
PPDcommissionable_itembooleanoIndica si el cargo puede ser comisionable. Toma el valor true en caso afirmativo. El cargo marcado como true solo será comisionable si se hace prepago.
priced_coveragesArrayInformación de las coberturas básicas incluidas en la tarifa
special_equipmentArrayEquipamiento y servicios opcionales del vehículo y la reserva a requerir
equipment_idnúmeroNúmero identificatorio del servicio/equipo
quantitynúmeroCantidad reservada del ítem
currencystringMoneda del valor expresado del equipo/servicio
amountnúmerocosto del cargo
equipment_GDS_codenúmeroCódigo GDS del equipo/servicio requerido
equipment_descriptionnúmeroDescripción del equipo/servicio requerido
vehicleObjetoDatos del vehículo reservado
vehicle_group_codestringGrupo del vehículo reservado.
vehicle_category_codestringCódigo de la categoría del vehículo reservado (Estándar ACRISS)
vehicle_class_namestringNombre de la clase del vehículo reservado
vehicle_make_modelstringMarca y modelo del vehículo reservado (solo a modo orientativo se confirman grupos o categorías, no marcas o modelos)
vehicle_detailsObjetoDetalles de equipamiento del vehículo
namestringCódigo GDS del equipo/servicio requerido
image_URLstringURL de la imagen ilustrativa del vehículo
seatsstringCantidad de asientos
doorsstringCantidad de puertas
air_conditionedbooleanotoma el valor de true si el vehículo cuenta con aire acondicionado, false en caso de no poseerlo
transmissionstringTipo de caja de cambios (automática / manual)
large_suitcasestringCantidad de maletas grandes
medium_suitcasestringCantidad de maletas medianas
small_suitcasestringCantidad de maletas pequeñas
RequestorAgentObjetoDatos del Agente/Agencia que realizó la reserva(IATA, Unlimited Rewards Number,etc)
LocationDetailObjetoDatos de las oficinas de inicio y retorno de la renta
PickUpLocationObjetoOficina de inicio de la renta (Nombre, Dirección, Código de oficina, Latitud, Longitud, Horarios, etc).
ReturnLocationObjetoOficina de retorno de la renta (Nombre, Dirección, Código de oficina, Latitud, Longitud, Horarios, etc).
TIDstringIdentificador de transacción que se utiliza para individualizar una solicitud determinada. Se puede utilizar para revisar problemas con una solicitud en particular.
RHMACstringHash verificador de la reserva.
Errores de solicitud
respuesta HTTP: 400 Bad Request
Si se encuentra algún tipo de error en la solicitud (parámetros / headers / expiración del token de acceso) recibirá un error similar al siguiente:
 
{
  "appVersion": "2.0",
  "status": "false",
  "brand": "AVIS",
  "environment": "QA",
  "error": "invalid_request",
  "error_description": "Missing confirmation_number or last_name parameters"
}
                            
respuesta HTTP: 404 Not Found
Si la reserva no puede recuperarse por algún motivo, recibirá un error similar al siguiente:

{
  "appVersion": "2.0",
  "status": false,
  "brand": "AVIS",
  "environment": "QA",
  "error": "not found",
  "error_description": "31005 BizRule - Trying to retrieve a cancelled reservation"
}