Skip to main content

Vehicle Price Check

Car
Search
REST API
Travel Agency
Try Now

What is it?

Vehicle Price Check is a new API that allows you to validate if a previous car/vehicle and rate is still valid. This is needed to ensure that on the occasion of the previous availability response being either cached in the users system or if several minutes have passed since the original availability response.

If the original availability response was from GetVehAvail V2 or higher, then it is recommended to use the “RateKey” that was returned to verify price.

If the original availability response was from GetVehAvail V1 or any other car/vehicle availability response, then it is required to populate all the applicable elements and attributes that were part of the original request plus additional elements and attributes to be able to validate the vehicle and rate.

The response will validate if the vehicle and rate is still available. If the vehicle is still available, but the price has increased or decreased, then the difference will be returned. In addition, all the details from the original GetVehAvail response for this specific vehicle and rate will be returned, including all monetary amounts, car extras/special equipment, and if applicable, cancelation penalties and commissions. Lastly, the address, latitude/longitude, and hours of operation will be included for both pickup and return locations and dates.

Why use it?

The Vehicle Price Check is designed to be used after an original vehicle availability request. It is particularly useful if the availability entry was done several minutes ago, as all Car Supplier’s vehicles and rates have limited availability and it is possible the vehicle is no longer available. The Vehicle Price Check should be done immediately prior to using one of the Car booking APIs, to reduce the likelihood of a booking failure or a price change.

How it works

Send information in JSON format that adheres with the VehPriceCheckRQ structure to the Get Vehicle Availability API and retrieve car rates and location details in the response.

How to use

The Price Check API allows Users to easily confirm if a rate originally returned from a GetVehAvail Car Shop is still valid.  

A unique ‘key’, called a Rate Key, will be generated for each individual car rate item in each GetVehAvail Car Shop response. It can then be used by the Price Check API to determine the rate returned is still valid.

When Users consume the Price Check API, the response will indicate if the rate has not changed or indicate the rate has changed and the price difference. A Booking Key will also be returned in the Price Check API response.

Sample Request

Note: A RateKey needs to be generated from the Get Vehicle Availability request.

{
    "VehPriceCheckRQ": {
        "version": "1.0.0",
        "VehRateInfoRef": {
            "RateKey": "Xas1XjN1JJR9xSaJfjemQTw9H4GGFtpZToGIODr9iWYNKS0byknzx2j175YiYiuu1WJ2yMFOGbHzOhVQTpxjjKDXIbG2sOIajT5AUAMplFKYzuLX2IzzsgPI6J0glc5lRy7etmyiAk40x8tID38HoPT8t3UwT/RHFgCl/jcxBmOYfc5gRSvVyo6aV6XjdJJKikDGLAMXbIMGvdQWX9yB/HCVNmu5zG6qR80zVPle54bLpYpL02zATzrfscTEnGjhQYQgaEuosc5y4iSDS7y7XV8cgOv5D9qIACSI09HiDXEbKHfB3IqZan1yx9k7MW5/bOziRMWIjw/BU/SA4c+NSSMQPNZ2ART79M5GE97DAa4="
        }
    }
}

Sample Response

{
  "VehPriceCheckRS": {
    "ApplicationResults": {
      "status": "Complete",
      "Success": [
        {
          "timeStamp": "2021-01-05T11:04:29.938-06:00"
        }
      ]
    },
    "PriceCheckInfo": {
      "BookingKey": "e56e7529-e0e9-4552-b51b-e0b4dfc10a73",
      "PriceChange": false,
      "PriceDifference": "0.00",
      "CurrencyCode": "USD",
      "VehRateInfo": {
        "VehAvailInfos": {
          "PickUpDate": "2021-02-10",
          "PickUpTime": "0730",
          "ReturnDate": "2021-02-15",
          "ReturnTime": "0730",
          "RentalDays": "5",
          "RentalHours": "0",
          "VehAvailInfo": [
            {
              "Vendor": {
                "Code": "ZI",
                "Name": "AVIS"
              },
              "PickUpLocation": {
                "PolicyRef": "ZISFOSFO",
                "LocationCode": "SFO",
                "ExtendedLocationCode": "SFO",
                "Distance": "NA"
              },
              "ReturnLocation": {
                "PolicyRef": "ZISFOSFO",
                "LocationCode": "SFO",
                "ExtendedLocationCode": "SFO",
                "Distance": "NA"
              },
              "VehRentalRate": [
                {
                  "AvailabilityStatus": "S",
                  "RateCode": "BP",
                  "RatePlanReturned": "W",
                  "GuaranteeInd": "Q",
                  "SupplierCurrency": true,
                  "Vehicle": {
                    "VehType": "ECAR",
                    "SeatBeltsAndBagsInfo": {
                      "SeatBelts": {
                        "Quantity": 5
                      },
                      "BagsInfo": {
                        "Bags": [
                          {
                            "Quantity": 1,
                            "Size": "Large"
                          },
                          {
                            "Quantity": 1,
                            "Size": "Small"
                          }
                        ]
                      }
                    }
                  },
                  "VehicleCharges": {
                    "VehicleCharge": [
                      {
                        "Amount": "280.00",
                        "CurrencyCode": "USD",
                        "ChargeType": "BaseRateTotal",
                        "MileageAllowance": "UNL",
                        "ExtraMileageCharge": ".00",
                        "UOM": "MI"
                      },
                      {
                        "Amount": "56.00",
                        "ChargeType": "ExtraDay",
                        "MileageAllowance": "UNL",
                        "ExtraMileageCharge": ".00",
                        "UOM": "MI"
                      },
                      {
                        "Amount": "42.01",
                        "ChargeType": "ExtraHour",
                        "MileageAllowance": "UNL",
                        "ExtraMileageCharge": ".00",
                        "UOM": "MI"
                      },
                      {
                        "Amount": "384.31",
                        "ChargeType": "ApproximateTotalPrice",
                        "MileageAllowance": "UNL",
                        "ExtraMileageCharge": ".00",
                        "UOM": "MI"
                      }
                    ]
                  },
                  "Commission": {},
                  "CarExtraCharges": {},
                  "GuaranteePrepaid": {}
                }
              ],
              "ConvertedVehRentalRate": []
            }
          ]
        }
      },
      "VehLocPolicyInfos": {
        "VehLocPolicyinfo": [
          {
            "PolicyRef": "ZISFOSFO",
            "LocationName": "SAN FRANCISCO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "LocationOwner": "C",
            "CounterLocation": "A",
            "LocationType": "PickUp",
            "VendorDetails": {
              "Code": "ZI",
              "Name": "AVIS"
            },
            "LocationInfo": {
              "Latitude": "37.6294",
              "Longitude": "-122.4004",
              "Address": {
                "AddressLine1": "780 MCDONNELL ROAD FLOOR 3",
                "CityName": {
                  "value": "SAN FRANCISCO"
                },
                "StateProv": {
                  "StateCode": "CA"
                },
                "PostalCode": "94128-3114",
                "CountryName": {
                  "Code": "US",
                  "value": "United States"
                }
              }
            },
            "OperationSchedule": {
              "StartDate": "2021-02-10-06:00",
              "OperationTimes": {
                "OperationTime": [
                  {
                    "Start": "0000",
                    "End": "2359",
                    "DayOfTheWeek": "Wednesday"
                  }
                ]
              }
            }
          },
          {
            "PolicyRef": "ZISFOSFO",
            "LocationName": "SAN FRANCISCO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "LocationOwner": "C",
            "CounterLocation": "A",
            "LocationType": "DropOff",
            "VendorDetails": {
              "Code": "ZI",
              "Name": "AVIS"
            },
            "LocationInfo": {
              "Latitude": "37.6294",
              "Longitude": "-122.4004",
              "Address": {
                "AddressLine1": "780 MCDONNELL ROAD FLOOR 3",
                "CityName": {
                  "value": "SAN FRANCISCO"
                },
                "StateProv": {
                  "StateCode": "CA"
                },
                "PostalCode": "94128-3114",
                "CountryName": {
                  "Code": "US",
                  "value": "United States"
                }
              }
            },
            "OperationSchedule": {
              "StartDate": "2021-02-15-06:00",
              "OperationTimes": {
                "OperationTime": [
                  {
                    "Start": "0000",
                    "End": "2359",
                    "DayOfTheWeek": "Monday"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}