Skip Navigation

Get Vehicle Availability

Car
Search
REST API
Travel Agency

What is it?

GetVehAvailRQ is used to request information about car rental locations, the car type available, and the rates for those cars at specific locations.

Why use it?

GetVehAvailRQ is used to request information about car rental location/s, the car type available, and the rates for those cars at specific locations.

This is used to get car rates in one of three ways:

  1. Specific car supplier at a specific location
  2. Select one, multiple, or all car suppliers at an airport location
  3. Select one, multiple, or all car suppliers near a specific Geo point for one or more rental locations.

Note: For Point of Interest, Rail Station name, Address, and/or City name, a separate API call must be used to get a latitude / longitude prior to using the GetVehAvail API.

Use Geo AutoComplete API to input:

  1. Point of Interest, for example the Eiffel Tower.
  2. Rail Station name, for example Grand Central Station.

Use Geo Search API to input any type of Address information:

  1. Street Address, City Name, State/Province, Country Code, Postal code
  2. Or just City Name and Country Code.

See appendix for samples of Geo AutoComplete and GeoSearch.

Many optional items can be requested as follows:

  • Pickup location by airport code
  • City location code or geo reference
  • Multiple pickup location points
  • Return location by airport code
  • City location code, or geo reference
  • Delivery/Collection
  • Client ID numbers
  • Tour codes
  • Promotional Coupons
  • Corporate IDs
  • Frequent Traveler
  • Guaranteed/prepaid rates
  • Commission programs
  • Rate assured
  • Rate categories
  • Rate codes
  • Rate qualifiers
  • Rate assured
  • Commission
  • Special equipment / extra car preferences
  • Vehicle preferences
  • Seatbelts (number of occupants)
  • Bags

How it works

The Developer sends information in a JSON format that adheres with the GetVehAvailRQ structure to CarShopAPI and gets the car rates and location details in the response.

How to use

The Get Vehicle Availability API lets you view multiple sets of vehicle information, all within a single response. Requests contain several different search parameters, both required and optional, so a full understanding of what to search by is crucial in order to successfully use this API.

This user guide describes how to search for car rates and locations based on a variety of different use cases. We'll cover the following use cases:

  • Basic rental location
  • Basic airport ref
  • Basic georef
  • Customer loyalty
  • Guaranteed/prepaid
  • Car Extras/special equipment
  • Car rate rule
  • Car image references

Use Cases

Point of Service

The Point of Service feature allows you to keep your existing token, but change the request to appear as a new Pseudo City Code that you have access too. The POS element, if used, is the first element below GetVehAvailRQ, immediately prior to SearchCriteria.

{
"GetVehAvailRQ": {
    "POS": {
        "Source": {
            "PseudoCityCode": "TM61"
        }
    },
    "SearchCriteria": {
    }
}
}

Basic Rental Location

The basic RentalLocRef request is used when there is only one vendor and one specific location (airport or non-airport) to search, and returns car rates and location details. This request includes basic information, such as car rental vendor, pick up and drop off airport or non-airport location, dates needed, and pick up and drop off times.

Request

{
  "GetVehAvailRQ": {
    "POS": {
        "Source": {
            "PseudoCityCode": "TM61"
        }
    },
    "SearchCriteria": {
      "PickUpDate": "2019-03-12",
      "PickUpTime": "07:30",
      "ReturnDate": "2019-03-26",
      "ReturnTime": "07:30",
      "SortBy": "Preferred",
      "SortOrder": "ASC",
      "RentalLocRef": {
        "PickUpLocation": {
          "ExtendedLocationCode": "DFW",
          "LocationCode": "DFW"
        },
        "ReturnLocation": {
          "ExtendedLocationCode": "DFW",
          "LocationCode": "DFW"
        }
      },
      "ImageRef": {
        "Image": {
          "Type": "ORIGINAL"
        }
      },
      "LocPolicyRef": {
        "include": true
      },
      "RatePrefs": {
        "Commission": false,
        "RateAssured": false
      },
      "CarExtrasPrefs": {
        "CarExtrasPref": [
          {
            "Type": "NAV"
          }
        ]
      },
      "VendorPrefs": {
        "VendorPref": {
          "Code": "ET"
        }
      }
    }
  }
}

Response

{
  "GetVehAvailRS": {
    "ApplicationResults": {
      "status": "Complete",
      "Success": [
        {
          "timeStamp": "2019-02-20T10:21:17.721-06:00"
        }
      ]
    },
    "VehAvailInfos": {
      "PickUpDate": "2019-03-12",
      "PickUpTime": "0730",
      "ReturnDate": "2019-03-26",
      "ReturnTime": "0730",
      "RentalDays": "14",
      "RentalHours": "0",
      "VehAvailInfo": [
        {
          "Vendor": {
            "Code": "ET",
            "Name": "ENTERPRISE",
            "Logo": "http://vcmp.sgdcelab.sabre.com/image/upload/f_auto,q_auto:best,t_vcmp_logo/car/l/et/ET.png"
          },
          "PickUpLocation": {
            "PolicyRef": "ETDFWDFW",
            "LocationCode": "DFW",
            "ExtendedLocationCode": "DFW",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ETDFWDFW",
            "LocationCode": "DFW",
            "ExtendedLocationCode": "DFW",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "EW8",
            "RatePlanReturned": "W",
            "Category": "L",
            "GuaranteeInd": "G",
            "Vehicle": {
              "VehType": "ECAR",
              "Images": {
                "Image": [
                  {
                    "Url": "http://vcmp.sgdcelab.sabre.com/image/upload/f_auto,q_auto:best/car/i/38531/aecptlqnxqzma8h1e035.png",
                    "Type": "ORIGINAL",
                    "Height": 576,
                    "Width": 768
                  }
                ]
              }
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "249.00",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "47.00",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "15.67",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "926.22",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {
              "TotalAmount": "119.90",
              "CarExtra": [
                {
                  "BaseAmount": "119.90",
                  "Plan": "B",
                  "Code": "NAV",
                  "Status": "CNF"
                }
              ]
            },
            "GuaranteePrepaid": {}
          }
        }
          "Vendor": {
            "Code": "ET",
            "Name": "ENTERPRISE",
            "Logo": "http://vcmp.sgdcelab.sabre.com/image/upload/f_auto,q_auto:best,t_vcmp_logo/car/l/et/ET.png"
          },
          "PickUpLocation": {
            "PolicyRef": "ETDFWDFW",
            "LocationCode": "DFW",
            "ExtendedLocationCode": "DFW",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ETDFWDFW",
            "LocationCode": "DFW",
            "ExtendedLocationCode": "DFW",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "EW9",
            "RatePlanReturned": "W",
            "Category": "L",
            "GuaranteeInd": "G",
            "Vehicle": {
              "VehType": "SKAR",
              "Images": {}
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "950.00",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "135.71",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "27.14",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "2717.65",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {
              "TotalAmount": "119.90",
              "CarExtra": [
                {
                  "BaseAmount": "119.90",
                  "Plan": "B",
                  "Code": "NAV",
                  "Status": "CNF"
                }
              ]
            },
            "GuaranteePrepaid": {}
          }
        }
      ]
    },
    "VehLocPolicyInfos": {
      "VehLocPolicyinfo": [
        {
          "PolicyRef": "ETDFWDFW",
          "LocationName": "DALLAS FORT WORTH INTL",
          "LocationCode": "DFW",
          "ExtendedLocationCode": "DFW",
          "LocationOwner": "C",
          "CounterLocation": "A",
          "LocationType": "PickUp",
          "VendorDetails": {
            "Code": "ET",
            "Name": "ENTERPRISE"
          },
          "LocationInfo": {
            "Latitude": "32.89198",
            "Longitude": "-97.05988",
            "Address": {
              "AddressLine1": "2424 E 38TH ST",
              "CityName": {
                "value": "DALLAS"
              },
              "StateProv": {
                "StateCode": "TX"
              },
              "PostalCode": "75261-9999",
              "CountryName": {
                "Code": "US",
                "value": "United States"
              }
            }
          },
          "OperationSchedule": {
            "StartDate": "2019-03-12",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0600",
                  "end": "2300",
                  "DayOfTheWeek": "Tuesday"
                }
              ]
            }
          }
        },
        {
          "PolicyRef": "ETDFWDFW",
          "LocationName": "DALLAS FORT WORTH INTL",
          "LocationCode": "DFW",
          "ExtendedLocationCode": "DFW",
          "LocationOwner": "C",
          "CounterLocation": "A",
          "LocationType": "DropOff",
          "VendorDetails": {
            "Code": "ET",
            "Name": "ENTERPRISE"
          },
          "LocationInfo": {
            "Latitude": "32.89198",
            "Longitude": "-97.05988",
            "Address": {
              "AddressLine1": "2424 E 38TH ST",
              "CityName": {
                "value": "DALLAS"
              },
              "StateProv": {
                "StateCode": "TX"
              },
              "PostalCode": "75261-9999",
              "CountryName": {
                "Code": "US",
                "value": "United States"
              }
            }
          },
          "OperationSchedule": {
            "StartDate": "2019-03-26",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0600",
                  "end": "2300",
                  "DayOfTheWeek": "Tuesday"
                }
              ]
            }
          }
        }
      ]
    }
  }
}

Basic Airport Ref

The basic AirportRef request is used to search for airport car rental information with or without specific suppliers, and returns car rate and location details for airports in the response. It contains basic information, such as car rental supplier(s), pick-up and drop-off airport location, dates needed, and pick-up and drop-off times.

Request

{
  "GetVehAvailRQ": {
    "SearchCriteria": {
      "AirportRef": {
        "PickUpLocation": {
          "LocationCode": "SFO"
        },
        "ReturnLocation": {
          "LocationCode": "SFO"
        }
      },
      "RatePrefs": {
        "Commission": false
      },
      "PickUpTime": "07:30",
      "ReturnTime": "07:30",
      "PickUpDate": "2019-03-12",
      "ReturnDate": "2019-03-20",
      "LocPolicyRef": {
        "include": true
      },
      "VendorPrefs": {
        "VendorPref": [
          {
            "Code": "ZE"
          },
          {
            "Code": "ZI"
          }
        ]
      }
    }
  }
}

Response

{
    "GetVehAvailRS": {
        "ApplicationResults": {
            "status": "Complete",
            "Success": [
                {
                    "timeStamp": "2019-02-20T10:32:59.661-06:00"
                }
            ]
        },
        "VehAvailInfos": {
            "PickUpDate": "2019-03-12",
            "PickUpTime": "0730",
            "ReturnDate": "2019-03-20",
            "ReturnTime": "0730",
            "RentalDays": "8",
            "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": "2N",
                        "RatePlanReturned": "W",
                        "RatePlanChangeIndicator": "true",
                        "GuaranteeInd": "G",
                        "Vehicle": {
                            "VehType": "FFAR",
                            "SeatBeltsAndBagsInfo": {
                                "SeatBelts": {
                                    "Quantity": 7
                                },
                                "BagsInfo": {
                                    "Bags": [
                                        {
                                            "Quantity": 2,
                                            "Size": "Large"
                                        },
                                        {
                                            "Quantity": 4,
                                            "Size": "Small"
                                        }
                                    ]
                                }
                            }
                        },
                        "VehicleCharges": {
                            "VehicleCharge": [
                                {
                                    "Amount": "798.00",
                                    "CurrencyCode": "USD",
                                    "ChargeType": "BaseRateTotal",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "114.00",
                                    "ChargeType": "ExtraDay",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "80.01",
                                    "ChargeType": "ExtraHour",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "1193.71",
                                    "ChargeType": "ApproximateTotalPrice",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                }
                            ]
                        },
                        "Commission": {},
                        "CarExtraCharges": {},
                        "GuaranteePrepaid": {}
                    }
                },
                {
                    "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": "2N",
                        "RatePlanReturned": "W",
                        "RatePlanChangeIndicator": "true",
                        "GuaranteeInd": "G",
                        "Vehicle": {
                            "VehType": "MVAR",
                            "SeatBeltsAndBagsInfo": {
                                "SeatBelts": {
                                    "Quantity": 7
                                },
                                "BagsInfo": {
                                    "Bags": [
                                        {
                                            "Quantity": 2,
                                            "Size": "Large"
                                        },
                                        {
                                            "Quantity": 4,
                                            "Size": "Small"
                                        }
                                    ]
                                }
                            }
                        },
                        "VehicleCharges": {
                            "VehicleCharge": [
                                {
                                    "Amount": "858.00",
                                    "CurrencyCode": "USD",
                                    "ChargeType": "BaseRateTotal",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "122.57",
                                    "ChargeType": "ExtraDay",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "86.01",
                                    "ChargeType": "ExtraHour",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "1280.78",
                                    "ChargeType": "ApproximateTotalPrice",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                }
                            ]
                        },
                        "Commission": {},
                        "CarExtraCharges": {},
                        "GuaranteePrepaid": {}
                    }
                }
            ]
        },
        "VehLocPolicyInfos": {
            "VehLocPolicyinfo": [
                {
                    "PolicyRef": "ZISFOSFO",
                    "LocationName": "SAN FRANCISCO",
                    "LocationCode": "SFO",
                    "ExtendedLocationCode": "SFO",
                    "LocationOwner": "C",
                    "CounterLocation": "A",
                    "LocationType": "PickUp",
                    "VendorDetails": {
                        "Code": "ZI",
                        "Name": "AVIS"
                    },
                    "LocationInfo": {
                        "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": "2019-03-12",
                        "OperationTimes": {
                            "OperationTime": [
                                {
                                    "start": "0000",
                                    "end": "2359",
                                    "DayOfTheWeek": "Tuesday"
                                }
                            ]
                        }
                    }
                },
                    "PolicyRef": "ZESFOSFO",
                    "LocationName": "SAN FRANCISCO",
                    "LocationCode": "SFO",
                    "ExtendedLocationCode": "SFO",
                    "LocationOwner": "C",
                    "CounterLocation": "A",
                    "LocationType": "PickUp",
                    "VendorDetails": {
                        "Code": "ZE",
                        "Name": "HERTZ"
                    },
                    "LocationInfo": {
                        "Address": {
                            "AddressLine1": "780 MCDONNELL ROAD",
                            "CityName": {
                                "value": "SAN FRANCISCO"
                            },
                            "StateProv": {
                                "StateCode": "CA"
                            },
                            "PostalCode": "94128-3114",
                            "CountryName": {
                                "Code": "US",
                                "value": "United States"
                            }
                        }
                    },
                    "OperationSchedule": {
                        "StartDate": "2019-03-12",
                        "OperationTimes": {
                            "OperationTime": [
                                {
                                    "start": "0000",
                                    "end": "2359",
                                    "DayOfTheWeek": "Tuesday"
                                }
                            ]
                        }
                    }
                },
                {
                    "PolicyRef": "ZESFOSFO",
                    "LocationName": "SAN FRANCISCO",
                    "LocationCode": "SFO",
                    "ExtendedLocationCode": "SFO",
                    "LocationOwner": "C",
                    "CounterLocation": "A",
                    "LocationType": "DropOff",
                    "VendorDetails": {
                        "Code": "ZE",
                        "Name": "HERTZ"
                    },
                    "LocationInfo": {
                        "Address": {
                            "AddressLine1": "780 MCDONNELL ROAD",
                            "CityName": {
                                "value": "SAN FRANCISCO"
                            },
                            "StateProv": {
                                "StateCode": "CA"
                            },
                            "PostalCode": "94128-3114",
                            "CountryName": {
                                "Code": "US",
                                "value": "United States"
                            }
                        }
                    },
                    "OperationSchedule": {
                        "StartDate": "2019-03-20",
                        "OperationTimes": {
                            "OperationTime": [
                                {
                                    "start": "0000",
                                    "end": "2359",
                                    "DayOfTheWeek": "Wednesday"
                                }
                            ]
                        }
                    }
                }
            ]
        }
    }
}

Basic Geo Ref

The basic GeoRef request is used to search for car rental information by geolocation, with or without specific vendors. It contains basic information, such as car rental supplier(s), pick-up and drop-off geographic or airport/non-airport location, dates needed, and pick-up and drop-off times. It returns car rates and location details in the response.

Request

{
  "GetVehAvailRQ": {
    "SearchCriteria": {
      "GeoRef": {
        "PickUpLocRef": {
          "GeoCode": {
            "Latitude": 37.6213,
            "Longitude": -122.379
          }
        },
        "MaxLocations": 5,
        "Radius": 50,
        "UOM": "MI",
        "Direction": "SE"
      },
      "RatePrefs": {
        "Commission": false
      },
      "PickUpTime": "07:30",
      "ReturnTime": "07:30",
      "PickUpDate": "2019-03-12",
      "ReturnDate": "2019-03-20",
      "LocPolicyRef": {
        "include": true
      },
      "VendorPrefs": {
        "VendorPref": [
          {
            "Code": "ZE"
          },
          {
            "Code": "ZI"
          }
        ]
      }
    }
  }
}

Response

{
    "GetVehAvailRS": {
        "ApplicationResults": {
            "status": "Complete",
            "Success": [
                {
                    "timeStamp": "2019-02-20T10:32:59.661-06:00"
                }
            ]
        },
        "VehAvailInfos": {
            "PickUpDate": "2019-03-12",
            "PickUpTime": "0730",
            "ReturnDate": "2019-03-20",
            "ReturnTime": "0730",
            "RentalDays": "8",
            "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": "2N",
                        "RatePlanReturned": "W",
                        "RatePlanChangeIndicator": "true",
                        "GuaranteeInd": "G",
                        "Vehicle": {
                            "VehType": "FFAR",
                            "SeatBeltsAndBagsInfo": {
                                "SeatBelts": {
                                    "Quantity": 7
                                },
                                "BagsInfo": {
                                    "Bags": [
                                        {
                                            "Quantity": 2,
                                            "Size": "Large"
                                        },
                                        {
                                            "Quantity": 4,
                                            "Size": "Small"
                                        }
                                    ]
                                }
                            }
                        },
                        "VehicleCharges": {
                            "VehicleCharge": [
                                {
                                    "Amount": "798.00",
                                    "CurrencyCode": "USD",
                                    "ChargeType": "BaseRateTotal",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "114.00",
                                    "ChargeType": "ExtraDay",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "80.01",
                                    "ChargeType": "ExtraHour",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "1193.71",
                                    "ChargeType": "ApproximateTotalPrice",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                }
                            ]
                        },
                        "Commission": {},
                        "CarExtraCharges": {},
                        "GuaranteePrepaid": {}
                    }
                },
                {
                    "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": "2N",
                        "RatePlanReturned": "W",
                        "RatePlanChangeIndicator": "true",
                        "GuaranteeInd": "G",
                        "Vehicle": {
                            "VehType": "MVAR",
                            "SeatBeltsAndBagsInfo": {
                                "SeatBelts": {
                                    "Quantity": 7
                                },
                                "BagsInfo": {
                                    "Bags": [
                                        {
                                            "Quantity": 2,
                                            "Size": "Large"
                                        },
                                        {
                                            "Quantity": 4,
                                            "Size": "Small"
                                        }
                                    ]
                                }
                            }
                        },
                        "VehicleCharges": {
                            "VehicleCharge": [
                                {
                                    "Amount": "858.00",
                                    "CurrencyCode": "USD",
                                    "ChargeType": "BaseRateTotal",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "122.57",
                                    "ChargeType": "ExtraDay",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "86.01",
                                    "ChargeType": "ExtraHour",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "1280.78",
                                    "ChargeType": "ApproximateTotalPrice",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                }
                            ]
                        },
                        "Commission": {},
                        "CarExtraCharges": {},
                        "GuaranteePrepaid": {}
                    }
                }
            ]
        },
        "VehLocPolicyInfos": {
            "VehLocPolicyinfo": [
                {
                    "PolicyRef": "ZISFOSFO",
                    "LocationName": "SAN FRANCISCO",
                    "LocationCode": "SFO",
                    "ExtendedLocationCode": "SFO",
                    "LocationOwner": "C",
                    "CounterLocation": "A",
                    "LocationType": "PickUp",
                    "VendorDetails": {
                        "Code": "ZI",
                        "Name": "AVIS"
                    },
                    "LocationInfo": {
                        "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": "2019-03-12",
                        "OperationTimes": {
                            "OperationTime": [
                                {
                                    "start": "0000",
                                    "end": "2359",
                                    "DayOfTheWeek": "Tuesday"
                                }
                            ]
                        }
                    }
                },
                    "PolicyRef": "ZESFOSFO",
                    "LocationName": "SAN FRANCISCO",
                    "LocationCode": "SFO",
                    "ExtendedLocationCode": "SFO",
                    "LocationOwner": "C",
                    "CounterLocation": "A",
                    "LocationType": "PickUp",
                    "VendorDetails": {
                        "Code": "ZE",
                        "Name": "HERTZ"
                    },
                    "LocationInfo": {
                        "Address": {
                            "AddressLine1": "780 MCDONNELL ROAD",
                            "CityName": {
                                "value": "SAN FRANCISCO"
                            },
                            "StateProv": {
                                "StateCode": "CA"
                            },
                            "PostalCode": "94128-3114",
                            "CountryName": {
                                "Code": "US",
                                "value": "United States"
                            }
                        }
                    },
                    "OperationSchedule": {
                        "StartDate": "2019-03-12",
                        "OperationTimes": {
                            "OperationTime": [
                                {
                                    "start": "0000",
                                    "end": "2359",
                                    "DayOfTheWeek": "Tuesday"
                                }
                            ]
                        }
                    }
                },
                {
                    "PolicyRef": "ZESFOSFO",
                    "LocationName": "SAN FRANCISCO",
                    "LocationCode": "SFO",
                    "ExtendedLocationCode": "SFO",
                    "LocationOwner": "C",
                    "CounterLocation": "A",
                    "LocationType": "DropOff",
                    "VendorDetails": {
                        "Code": "ZE",
                        "Name": "HERTZ"
                    },
                    "LocationInfo": {
                        "Address": {
                            "AddressLine1": "780 MCDONNELL ROAD",
                            "CityName": {
                                "value": "SAN FRANCISCO"
                            },
                            "StateProv": {
                                "StateCode": "CA"
                            },
                            "PostalCode": "94128-3114",
                            "CountryName": {
                                "Code": "US",
                                "value": "United States"
                            }
                        }
                    },
                    "OperationSchedule": {
                        "StartDate": "2019-03-20",
                        "OperationTimes": {
                            "OperationTime": [
                                {
                                    "start": "0000",
                                    "end": "2359",
                                    "DayOfTheWeek": "Wednesday"
                                }
                            ]
                        }
                    }
                }
            ]
        }
    }
}

Customer Loyalty

The CustLoayalty request contains the same information as an AirportRef or GeoRef request, with the exception of containing customer discount code information. Valid customer discounts include:

  • CD - Corporate Discounts
  • PC - Promotional Coupons
  • IT - Tourcodes
  • ID - Identification
  • FT - Frequent Traveler

Request

{
  "GetVehAvailRQ": {
    "SearchCriteria": {
      "GeoRef": {
        "PickUpLocRef": {
          "GeoCode": {
            "Latitude": 37.6213,
            "Longitude": -122.379
          }
        },
        "MaxLocations": 5,
        "Radius": 50,
        "UOM": "MI",
        "Direction": "SE"
      },
      "RatePrefs": {
         "CustLoyalty": [
        {
          "MembershipType": "CD",
          "MembershipCode": "ZE",
          "MembershipId": "05"
        },
        {
          "MembershipType": "IT",
           "MembershipCode": "ZI",
          "MembershipId": "TOURUSA"
        },
        {
          "MembershipType": "PC",
         "MembershipCode": "AL",
          "MembershipId": "1234567890"
        }
      ],
        "Commission": false,
        "RateAssured": false
      },
      "PickUpTime": "07:30",
      "ReturnTime": "07:30",
      "PickUpDate": "2019-03-12",
      "ReturnDate": "2019-03-20",
      "LocPolicyRef": {
        "include": true
      },
      "VendorPrefs": {
        "VendorPref": [
          {
            "Code": "ZE"
          },
          {
            "Code": "ZI"
          }
        ]
      }
    }
  }
}

Response

{
    "GetVehAvailRS": {
        "ApplicationResults": {
            "status": "Complete",
            "Success": [
                {
                    "timeStamp": "2019-02-20T10:39:10.408-06:00"
                }
            ]
        },
        "VehAvailInfos": {
            "PickUpDate": "2019-03-12",
            "PickUpTime": "0730",
            "ReturnDate": "2019-03-20",
            "ReturnTime": "0730",
            "RentalDays": "8",
            "RentalHours": "0",
            "VehAvailInfo": [
                    "Vendor": {
                        "Code": "ZI",
                        "Name": "AVIS"
                    },
                    "PickUpLocation": {
                        "PolicyRef": "ZISFOSFO",
                        "LocationCode": "SFO",
                        "ExtendedLocationCode": "SFO",
                        "Distance": "1.3",
                        "Direction": "NW",
                        "UOM": "MI",
                        "Latitude": "37.6294",
                        "Longitude": "-122.4004"
                    },
                    "ReturnLocation": {
                        "PolicyRef": "ZISFOSFO",
                        "LocationCode": "SFO",
                        "ExtendedLocationCode": "SFO",
                        "Distance": "1.3",
                        "Direction": "NW",
                        "UOM": "MI",
                        "Latitude": "37.6294",
                        "Longitude": "-122.4004"
                    },
                    "VehRentalRate": {
                        "AvailabilityStatus": "S",
                        "RateCode": "2N",
                        "RatePlanReturned": "W",
                        "RatePlanChangeIndicator": "true",
                        "GuaranteeInd": "G",
                        "Vehicle": {
                            "VehType": "MVAR",
                            "SeatBeltsAndBagsInfo": {
                                "SeatBelts": {
                                    "Quantity": 7
                                },
                                "BagsInfo": {
                                    "Bags": [
                                        {
                                            "Quantity": 2,
                                            "Size": "Large"
                                        },
                                        {
                                            "Quantity": 4,
                                            "Size": "Small"
                                        }
                                    ]
                                }
                            }
                        },
                        "VehicleCharges": {
                            "VehicleCharge": [
                                {
                                    "Amount": "858.00",
                                    "CurrencyCode": "USD",
                                    "ChargeType": "BaseRateTotal",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "122.57",
                                    "ChargeType": "ExtraDay",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "86.01",
                                    "ChargeType": "ExtraHour",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "1280.78",
                                    "ChargeType": "ApproximateTotalPrice",
                                    "MileageAllowance": "UNL",
                                    "ExtraMileageCharge": ".00",
                                    "UOM": "MI"
                                }
                            ]
                        },
                        "Commission": {},
                        "CarExtraCharges": {},
                        "GuaranteePrepaid": {}
                    }
                },
                {
                    "Vendor": {
                        "Code": "ZI",
                        "Name": "AVIS"
                    },
                    "PickUpLocation": {
                        "PolicyRef": "ZISFOC001",
                        "LocationCode": "SFO",
                        "ExtendedLocationCode": "C001",
                        "Distance": "11.65",
                        "Direction": "N",
                        "UOM": "MI",
                        "Latitude": "37.7878",
                        "Longitude": "-122.413"
                    },
                    "ReturnLocation": {
                        "PolicyRef": "ZISFOC001",
                        "LocationCode": "SFO",
                        "ExtendedLocationCode": "C001",
                        "Distance": "11.65",
                        "Direction": "N",
                        "UOM": "MI",
                        "Latitude": "37.7878",
                        "Longitude": "-122.413"
                    },
                    "VehRentalRate": {
                        "AvailabilityStatus": "S",
                        "RateCode": "2K",
                        "RatePlanReturned": "W",
                        "RatePlanChangeIndicator": "true",
                        "GuaranteeInd": "G",
                        "Vehicle": {
                            "VehType": "MVAR",
                            "SeatBeltsAndBagsInfo": {
                                "SeatBelts": {
                                    "Quantity": 7
                                },
                                "BagsInfo": {
                                    "Bags": [
                                        {
                                            "Quantity": 2,
                                            "Size": "Large"
                                        },
                                        {
                                            "Quantity": 4,
                                            "Size": "Small"
                                        }
                                    ]
                                }
                            }
                        },
                        "VehicleCharges": {
                            "VehicleCharge": [
                                {
                                    "Amount": "1010.00",
                                    "CurrencyCode": "USD",
                                    "ChargeType": "BaseRateTotal",
                                    "MileageAllowance": "1050",
                                    "ExtraMileageCharge": ".25",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "144.29",
                                    "ChargeType": "ExtraDay",
                                    "MileageAllowance": "150",
                                    "ExtraMileageCharge": ".25",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "101.01",
                                    "ChargeType": "ExtraHour",
                                    "MileageAllowance": "75",
                                    "ExtraMileageCharge": ".25",
                                    "UOM": "MI"
                                },
                                {
                                    "Amount": "1267.94",
                                    "ChargeType": "ApproximateTotalPrice",
                                    "MileageAllowance": "1200",
                                    "ExtraMileageCharge": ".25",
                                    "UOM": "MI"
                                }
                            ]
                        },
                        "Commission": {},
                        "CarExtraCharges": {},
                        "GuaranteePrepaid": {}
                    }
                }
            ]
        },
        "VehLocPolicyInfos": {
            "VehLocPolicyinfo": [
                    "PolicyRef": "ZESFOS028",
                    "LocationName": "SFOS28  BURLINGAME PUTNAM",
                    "LocationCode": "SFO",
                    "ExtendedLocationCode": "S028",
                    "LocationOwner": "C",
                    "CounterLocation": "N",
                    "LocationType": "PickUp",
                    "VendorDetails": {
                        "Code": "ZE",
                        "Name": "HERTZ"
                    },
                    "LocationInfo": {
                        "Latitude": "37.5775",
                        "Longitude": "-122.3408",
                        "Address": {
                            "AddressLine1": "1815 OLD BAYSHORE HWY",
                            "AddressLine2": "INSIDE THE BURLINGAME PUTNAM DEALERSHIP",
                            "CityName": {
                                "value": "BURLINGAME"
                            },
                            "StateProv": {
                                "StateCode": "CA"
                            },
                            "PostalCode": "94010-0000",
                            "CountryName": {
                                "Code": "US",
                                "value": "United States"
                            }
                        }
                    },
                    "OperationSchedule": {
                        "StartDate": "2019-03-12",
                        "OperationTimes": {
                            "OperationTime": [
                                {
                                    "start": "0730",
                                    "end": "1800",
                                    "DayOfTheWeek": "Tuesday"
                                }
                            ]
                        }
                    }
                },
                {
                    "PolicyRef": "ZESFOS028",
                    "LocationName": "SFOS28  BURLINGAME PUTNAM",
                    "LocationCode": "SFO",
                    "ExtendedLocationCode": "S028",
                    "LocationOwner": "C",
                    "CounterLocation": "N",
                    "LocationType": "DropOff",
                    "VendorDetails": {
                        "Code": "ZE",
                        "Name": "HERTZ"
                    },
                    "LocationInfo": {
                        "Address": {
                            "AddressLine1": "1815 OLD BAYSHORE HWY",
                            "AddressLine2": "INSIDE THE BURLINGAME PUTNAM DEALERSHIP",
                            "CityName": {
                                "value": "BURLINGAME"
                            },
                            "StateProv": {
                                "StateCode": "CA"
                            },
                            "PostalCode": "94010-0000",
                            "CountryName": {
                                "Code": "US",
                                "value": "United States"
                            }
                        }
                    },
                    "OperationSchedule": {
                        "StartDate": "2019-03-20",
                        "OperationTimes": {
                            "OperationTime": [
                                {
                                    "start": "0730",
                                    "end": "1800",
                                    "DayOfTheWeek": "Wednesday"
                                }
                            ]
                        }
                    }
                }
            ]
        }
    }
}

Guaranteed/Prepaid

Guarantee Prepaid is used when requesting a relatively new type of rate from car suppliers. These rates provide detailed information of refundable amounts during payment at the time of booking.

In addition to either AirportRef or GeoRef information, this request includes guaranteed prepaid rate indicators.

Request

{
  "GetVehAvailRQ": {
    "SearchCriteria": {
      "AirportRef": {
        "PickUpLocation": {
          "LocationCode": "SFO"
        },
        "ReturnLocation": {
          "LocationCode": "SFO"
        }
      },
      "RatePrefs": {
        "Commission": false
      },
      "PickUpTime": "07:30",
      "ReturnTime": "07:30",
      "PickUpDate": "2019-03-12",
      "ReturnDate": "2019-03-20",
      "LocPolicyRef": {
        "include": true
      },
     "VehPrefs": {
      "SeatBeltsAndBagsInfo": {
        "SeatBelts": {
          "Quantity": 5
        },
        "BagsInfo": {
          "Bags": {
            "Quantity": 2,
            "Size": "Large"
          }
        }
      }
    },
      "VendorPrefs": {
        "VendorPref": [
          {
            "Code": "ZE"
          },
          {
            "Code": "ZI"
          }
        ]
      }
    }
  }
}

Response

{
  "GetVehAvailRS": {
    "ApplicationResults": {
      "status": "Complete",
      "Success": [
        {
          "timeStamp": "2019-02-20T10:48:30.602-06:00"
        }
      ]
    },
    "VehAvailInfos": {
      "PickUpDate": "2019-03-12",
      "PickUpTime": "0730",
      "ReturnDate": "2019-03-20",
      "ReturnTime": "0730",
      "RentalDays": "8",
      "RentalHours": "0",
      "VehAvailInfo": [
          "Vendor": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "PickUpLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "RCUW8",
            "RatePlanReturned": "W",
            "PrepayDeposit": "G",
            "GuaranteeInd": "G",
            "SellGuaranteeReq": "G",
            "Vehicle": {
              "VehType": "LFAR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 7
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 2,
                      "Size": "Large"
                    },
                    {
                      "Quantity": 2,
                      "Size": "Small"
                    }
                  ]
                }
              }
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "659.56",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "94.32",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "47.16",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "1013.74",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {},
            "GuaranteePrepaid": {}
          }
        },
        {
          "Vendor": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "PickUpLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "DWKL",
            "RatePlanReturned": "W",
            "PrepayDeposit": "G",
            "GuaranteeInd": "G",
            "SellGuaranteeReq": "G",
            "Vehicle": {
              "VehType": "GFDR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 5
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 2,
                      "Size": "Large"
                    },
                    {
                      "Quantity": 2,
                      "Size": "Small"
                    }
                  ]
                }
              }
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "1183.00",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "525",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                },
                {
                  "Amount": "169.17",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "75",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                },
                {
                  "Amount": "84.59",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "37",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                },
                {
                  "Amount": "1770.47",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "600",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {},
            "GuaranteePrepaid": {}
          }
        }
      ]
    },
    "VehLocPolicyInfos": {
      "VehLocPolicyinfo": [
          "PolicyRef": "ZISFOSFO",
          "LocationName": "SAN FRANCISCO",
          "LocationCode": "SFO",
          "ExtendedLocationCode": "SFO",
          "LocationOwner": "C",
          "CounterLocation": "A",
          "LocationType": "PickUp",
          "VendorDetails": {
            "Code": "ZI",
            "Name": "AVIS"
          },
          "LocationInfo": {
            "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": "2019-03-12",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0000",
                  "end": "2359",
                  "DayOfTheWeek": "Tuesday"
                }
              ]
            }
          }
        },
        {
          "PolicyRef": "ZISFOSFO",
          "LocationName": "SAN FRANCISCO",
          "LocationCode": "SFO",
          "ExtendedLocationCode": "SFO",
          "LocationOwner": "C",
          "CounterLocation": "A",
          "LocationType": "DropOff",
          "VendorDetails": {
            "Code": "ZI",
            "Name": "AVIS"
          },
          "LocationInfo": {
            "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": "2019-03-20",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0000",
                  "end": "2359",
                  "DayOfTheWeek": "Wednesday"
                }
              ]
            }
          }
        }
      ]
    }
  }
}

Passenger and Bags

A passenger and bag request is used to search for specific passenger and bag vehicle capacities. This request type utilizes the AirportRef request structure, with VehPrefs specified to return passenger and bag information.

Request

{
  "GetVehAvailRQ": {
    "SearchCriteria": {
      "AirportRef": {
        "PickUpLocation": {
          "LocationCode": "SFO"
        },
        "ReturnLocation": {
          "LocationCode": "SFO"
        }
      },
      "RatePrefs": {
        "Commission": false
      },
      "PickUpTime": "07:30",
      "ReturnTime": "07:30",
      "PickUpDate": "2019-03-12",
      "ReturnDate": "2019-03-20",
      "LocPolicyRef": {
        "include": true
      },
     "VehPrefs": {
      "SeatBeltsAndBagsInfo": {
        "SeatBelts": {
          "Quantity": 5
        },
        "BagsInfo": {
          "Bags": {
            "Quantity": 2,
            "Size": "Large"
          }
        }
      }
    },
      "VendorPrefs": {
        "VendorPref": [
          {
            "Code": "ZE"
          },
          {
            "Code": "ZI"
          }
        ]
      }
    }
  }
}

Response

{
  "GetVehAvailRS": {
    "ApplicationResults": {
      "status": "Complete",
      "Success": [
        {
          "timeStamp": "2019-02-20T10:54:04.979-06:00"
        }
      ]
    },
    "VehAvailInfos": {
      "PickUpDate": "2019-03-12",
      "PickUpTime": "0730",
      "ReturnDate": "2019-03-20",
      "ReturnTime": "0730",
      "RentalDays": "8",
      "RentalHours": "0",
      "VehAvailInfo": [
          "Vendor": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "PickUpLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "RCUW8",
            "RatePlanReturned": "W",
            "PrepayDeposit": "G",
            "GuaranteeInd": "G",
            "SellGuaranteeReq": "G",
            "Vehicle": {
              "VehType": "LFAR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 7
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 2,
                      "Size": "Large"
                    },
                    {
                      "Quantity": 2,
                      "Size": "Small"
                    }
                  ]
                }
              }
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "659.56",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "94.32",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "47.16",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "1013.74",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {},
            "GuaranteePrepaid": {}
          }
        },
        {
          "Vendor": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "PickUpLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "DWKL",
            "RatePlanReturned": "W",
            "PrepayDeposit": "G",
            "GuaranteeInd": "G",
            "SellGuaranteeReq": "G",
            "Vehicle": {
              "VehType": "GFDR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 5
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 2,
                      "Size": "Large"
                    },
                    {
                      "Quantity": 2,
                      "Size": "Small"
                    }
                  ]
                }
              }
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "1183.00",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "525",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                },
                {
                  "Amount": "169.17",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "75",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                },
                {
                  "Amount": "84.59",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "37",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                },
                {
                  "Amount": "1770.47",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "600",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {},
            "GuaranteePrepaid": {}
          }
        }
      ]
    },
    "VehLocPolicyInfos": {
      "VehLocPolicyinfo": [
          "PolicyRef": "ZISFOSFO",
          "LocationName": "SAN FRANCISCO",
          "LocationCode": "SFO",
          "ExtendedLocationCode": "SFO",
          "LocationOwner": "C",
          "CounterLocation": "A",
          "LocationType": "PickUp",
          "VendorDetails": {
            "Code": "ZI",
            "Name": "AVIS"
          },
          "LocationInfo": {
            "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": "2019-03-12",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0000",
                  "end": "2359",
                  "DayOfTheWeek": "Tuesday"
                }
              ]
            }
          }
        },
        {
          "PolicyRef": "ZISFOSFO",
          "LocationName": "SAN FRANCISCO",
          "LocationCode": "SFO",
          "ExtendedLocationCode": "SFO",
          "LocationOwner": "C",
          "CounterLocation": "A",
          "LocationType": "DropOff",
          "VendorDetails": {
            "Code": "ZI",
            "Name": "AVIS"
          },
          "LocationInfo": {
            "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": "2019-03-20",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0000",
                  "end": "2359",
                  "DayOfTheWeek": "Wednesday"
                }
              ]
            }
          }
        }
      ]
    }
  }
}

Car Extras/Special Equipment

Car Extra (CarExtrasPrefs) is used to request special equipment such as child seats, bicycle racks, and more.

Some suppliers do not support this field. Most will support up to 4 repeats of the Car Extra, with a few supporting a maximum value of up to 10.

Most suppliers will support common Car Extras, such as special equipment like CST (Child Seat), and also includes services like NAV (Navigation). Less common items, such as TOL (Toll Road Tags), PAI (Insurance Codes), and surcharges such as A18 (Driver Age 18 Surcharge), aren’t as widely supported. For more information on what is supported, refer to the designated supplier contact.

When making a request, these fields are edited against the car supplier car rental location policy. For Shop requests, only codes valid for that car supplier location are sent to that specific car supplier.

Note: Car suppliers can make their own custom codes. For example, some countries allow surcharges on overage drivers, so a car supplier may add the surcharge A75 (Renter Age 75) during shopping.

Refer to the Car Extras Code Matrix for more information.

Request

{
  "GetVehAvailRQ": {
    "SearchCriteria": {
      "GeoRef": {
        "PickUpLocRef": {
          "GeoCode": {
            "Latitude": 37.6213,
            "Longitude": -122.379
          }
        },
        "MaxLocations": 5,
        "Radius": 50,
        "UOM": "MI",
        "Direction": "SE"
      },
      "RatePrefs": {
        "Commission": true,
        "RateAssured": true
      },
      "PickUpTime": "12:30",
      "ReturnTime": "12:30",
      "PickUpDate": "2019-03-12",
      "ReturnDate": "2019-03-20",
      "LocPolicyRef": {
        "include": true
      },
               "VendorPrefs": {
        "VendorPref": [
          {
            "Code": "ZE"
          },
          {
            "Code": "FX"
          }
        ]
      },    
      "CarExtrasPrefs": {
        "CarExtrasPref": [
          {
          "Type": "NAV"
          },
          {
          "Type": "TOL"
          },
          {
          "Type": "CST"
          }
          ]
        }
      }
                }
  }

Response

{
  "GetVehAvailRS": {
    "ApplicationResults": {
      "status": "Complete",
      "Success": [
        {
          "timeStamp": "2019-02-20T13:47:12.414-06:00"
        }
      ]
    },
    "VehAvailInfos": {
      "PickUpDate": "2019-03-12",
      "PickUpTime": "0730",
      "ReturnDate": "2019-03-20",
      "ReturnTime": "0730",
      "RentalDays": "8",
      "RentalHours": "0",
      "VehAvailInfo": [
          "Vendor": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "PickUpLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "RCUW8",
            "RatePlanReturned": "W",
            "PrepayDeposit": "G",
            "GuaranteeInd": "G",
            "SellGuaranteeReq": "G",
            "Vehicle": {
              "VehType": "LFAR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 7
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 2,
                      "Size": "Large"
                    },
                    {
                      "Quantity": 2,
                      "Size": "Small"
                    }
                  ]
                }
              }
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "659.56",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "94.32",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "47.16",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "1013.74",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {},
            "GuaranteePrepaid": {}
          }
        },
        {
          "Vendor": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "PickUpLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ZESFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "DWKL",
            "RatePlanReturned": "W",
            "PrepayDeposit": "G",
            "GuaranteeInd": "G",
            "SellGuaranteeReq": "G",
            "Vehicle": {
              "VehType": "GFDR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 5
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 2,
                      "Size": "Large"
                    },
                    {
                      "Quantity": 2,
                      "Size": "Small"
                    }
                  ]
                }
              }
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "1183.00",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "525",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                },
                {
                  "Amount": "169.17",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "75",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                },
                {
                  "Amount": "84.59",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "37",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                },
                {
                  "Amount": "1770.47",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "600",
                  "ExtraMileageCharge": ".75",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {},
            "GuaranteePrepaid": {}
          }
        }
      ]
    },
    "VehLocPolicyInfos": {
      "VehLocPolicyinfo": [
          "PolicyRef": "ZISFOSFO",
          "LocationName": "SAN FRANCISCO",
          "LocationCode": "SFO",
          "ExtendedLocationCode": "SFO",
          "LocationOwner": "C",
          "CounterLocation": "A",
          "LocationType": "PickUp",
          "VendorDetails": {
            "Code": "ZI",
            "Name": "AVIS"
          },
          "LocationInfo": {
            "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": "2019-03-12",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0000",
                  "end": "2359",
                  "DayOfTheWeek": "Tuesday"
                }
              ]
            }
          }
        },
        {
          "PolicyRef": "ZISFOSFO",
          "LocationName": "SAN FRANCISCO",
          "LocationCode": "SFO",
          "ExtendedLocationCode": "SFO",
          "LocationOwner": "C",
          "CounterLocation": "A",
          "LocationType": "DropOff",
          "VendorDetails": {
            "Code": "ZI",
            "Name": "AVIS"
          },
          "LocationInfo": {
            "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": "2019-03-20",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0000",
                  "end": "2359",
                  "DayOfTheWeek": "Wednesday"
                }
              ]
            }
          }
        }
      ]
    }
  }
}

Car Rate Preference

The RatePrefs request type is used to filter search results by preferred car rate types. This request contains basic rental location information, such AirportRef or GeoRef, vendor rate codes, rate categories, and rate plans.

Request

{
  "GetVehAvailRQ": {
    "SearchCriteria": {
      "GeoRef": {
        "PickUpLocRef": {
          "GeoCode": {
            "Latitude": 37.6213,
            "Longitude": -122.379
          }
        },
        "MaxLocations": 5,
        "Radius": 50,
        "UOM": "MI",
        "Direction": "SE"
      },
      "RatePrefs": {
        "RateRule": [
          {
           "RateCode": "HOTW",
           "VendorCode": "ZI"
          }
        ],
        "Commission": false
      },
      "PickUpTime": "07:30",
      "ReturnTime": "07:30",
      "PickUpDate": "2019-03-12",
      "ReturnDate": "2019-03-20",
      "LocPolicyRef": {
        "include": true
      },
      "VendorPrefs": {
        "VendorPref": [
          {
            "Code": "ZE"
          },
          {
            "Code": "ZI"
          }
        ]
      }
    }
  }
}

Response

{
  "GetVehAvailRS": {
    "ApplicationResults": {
      "status": "Complete",
      "Success": [
        {
          "timeStamp": "2019-02-20T11:09:53.900-06:00"
        }
      ]
    },
    "VehAvailInfos": {
      "PickUpDate": "2019-03-12",
      "PickUpTime": "0730",
      "ReturnDate": "2019-03-20",
      "ReturnTime": "0730",
      "RentalDays": "8",
      "RentalHours": "0",
      "VehAvailInfo": [
          "Vendor": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "PickUpLocation": {
            "PolicyRef": "ZESFOS024",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "S024",
            "Distance": "1.33",
            "Direction": "S",
            "UOM": "MI",
            "Latitude": "37.6028",
            "Longitude": "-122.372"
          },
          "ReturnLocation": {
            "PolicyRef": "ZESFOS024",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "S024",
            "Distance": "1.33",
            "Direction": "S",
            "UOM": "MI",
            "Latitude": "37.6028",
            "Longitude": "-122.372"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "OAUW8",
            "RatePlanReturned": "W",
            "GuaranteeInd": "G",
            "Vehicle": {
              "VehType": "ECAR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 4
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 1,
                      "Size": "Large"
                    },
                    {
                      "Quantity": 1,
                      "Size": "Small"
                    }
                  ]
                }
              }
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "320.01",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "64.00",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "32.00",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "440.82",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {},
            "GuaranteePrepaid": {}
          }
        },
        {
          "Vendor": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "PickUpLocation": {
            "PolicyRef": "ZESFOC041",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "C041",
            "Distance": "2.47",
            "Direction": "NW",
            "UOM": "MI",
            "Latitude": "37.65",
            "Longitude": "-122.4059"
          },
          "ReturnLocation": {
            "PolicyRef": "ZESFOC041",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "C041",
            "Distance": "2.47",
            "Direction": "NW",
            "UOM": "MI",
            "Latitude": "37.65",
            "Longitude": "-122.4059"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "OAUW8",
            "RatePlanReturned": "W",
            "GuaranteeInd": "G",
            "Vehicle": {
              "VehType": "ECAR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 4
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 1,
                      "Size": "Large"
                    },
                    {
                      "Quantity": 1,
                      "Size": "Small"
                    }
                  ]
                }
              }
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "231.58",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "46.32",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "23.16",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "312.44",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {},
            "GuaranteePrepaid": {}
          }
        }
      ]
    },
    "VehLocPolicyInfos": {
      "VehLocPolicyinfo": [
          "PolicyRef": "ZESFOS028",
          "LocationName": "SFOS28  BURLINGAME PUTNAM",
          "LocationCode": "SFO",
          "ExtendedLocationCode": "S028",
          "LocationOwner": "C",
          "CounterLocation": "N",
          "LocationType": "PickUp",
          "VendorDetails": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "LocationInfo": {
            "Latitude": "37.5775",
            "Longitude": "-122.3408",
            "Address": {
              "AddressLine1": "1815 OLD BAYSHORE HWY",
              "AddressLine2": "INSIDE THE BURLINGAME PUTNAM DEALERSHIP",
              "CityName": {
                "value": "BURLINGAME"
              },
              "StateProv": {
                "StateCode": "CA"
              },
              "PostalCode": "94010-0000",
              "CountryName": {
                "Code": "US",
                "value": "United States"
              }
            }
          },
          "OperationSchedule": {
            "StartDate": "2019-03-12",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0730",
                  "end": "1800",
                  "DayOfTheWeek": "Tuesday"
                }
              ]
            }
          }
        },
        {
          "PolicyRef": "ZESFOS028",
          "LocationName": "SFOS28  BURLINGAME PUTNAM",
          "LocationCode": "SFO",
          "ExtendedLocationCode": "S028",
          "LocationOwner": "C",
          "CounterLocation": "N",
          "LocationType": "DropOff",
          "VendorDetails": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "LocationInfo": {
            "Address": {
              "AddressLine1": "1815 OLD BAYSHORE HWY",
              "AddressLine2": "INSIDE THE BURLINGAME PUTNAM DEALERSHIP",
              "CityName": {
                "value": "BURLINGAME"
              },
              "StateProv": {
                "StateCode": "CA"
              },
              "PostalCode": "94010-0000",
              "CountryName": {
                "Code": "US",
                "value": "United States"
              }
            }
          },
          "OperationSchedule": {
            "StartDate": "2019-03-20",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0730",
                  "end": "1800",
                  "DayOfTheWeek": "Wednesday"
                }
              ]
            }
          }
        }
      ]
    }
  }
}

Car Sort By Price

The car sort by price request type is used to filter search results by preferred car rate types. This request contains basic rental location information, vendor, pick-up/drop-off airport or non-airport location, dates needed, and drop-off time with the SortBy field set to Price.

Request

{
  "GetVehAvailRQ": {
    "SearchCriteria": {
      "PickUpDate": "2019-03-12",
      "PickUpTime": "07:30",
      "ReturnDate": "2019-03-26",
      "ReturnTime": "07:30",
      "SortBy": "Price",
      "SortOrder": "DESC",
      "RentalLocRef": {
        "PickUpLocation": {
          "ExtendedLocationCode": "DFW",
          "LocationCode": "DFW"
        },
        "ReturnLocation": {
          "ExtendedLocationCode": "DFW",
          "LocationCode": "DFW"
        }
      },
      "ImageRef": {
        "Image": {
          "Type": "ORIGINAL"
        }
      },
      "LocPolicyRef": {
        "include": true
      },
      "RatePrefs": {
        "Commission": false,
        "RateAssured": false
      },
      "CarExtrasPrefs": {
        "CarExtrasPref": [
          {
            "Type": "NAV"
          }
        ]
      },
      "VendorPrefs": {
        "VendorPref": {
          "Code": "ZE"
        }
      }
    }
  }
}

Response

{
  "GetVehAvailRS": {
    "ApplicationResults": {
      "status": "Complete",
      "Success": [
        {
          "timeStamp": "2019-02-20T11:12:58.517-06:00"
        }
      ]
    },
    "VehAvailInfos": {
      "PickUpDate": "2019-03-12",
      "PickUpTime": "0730",
      "ReturnDate": "2019-03-26",
      "ReturnTime": "0730",
      "RentalDays": "14",
      "RentalHours": "0",
      "VehAvailInfo": [
          "Vendor": {
            "Code": "ZE",
            "Name": "HERTZ",
            "Logo": "http://vcmp.sgdcelab.sabre.com/image/upload/f_auto,q_auto:best,t_vcmp_logo/car/l/ze/ZE.png"
          },
          "PickUpLocation": {
            "PolicyRef": "ZEDFWDFW",
            "LocationCode": "DFW",
            "ExtendedLocationCode": "DFW",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ZEDFWDFW",
            "LocationCode": "DFW",
            "ExtendedLocationCode": "DFW",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "RCUW8",
            "RatePlanReturned": "W",
            "GuaranteeInd": "G",
            "Vehicle": {
              "VehType": "CCAR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 5
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 1,
                      "Size": "Large"
                    },
                    {
                      "Quantity": 1,
                      "Size": "Small"
                    }
                  ]
                }
              },
              "Images": {}
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "283.52",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "40.54",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "11.34",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "1164.36",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {
              "TotalAmount": "237.86",
              "CarExtra": [
                {
                  "BaseAmount": "237.86",
                  "Plan": "B",
                  "Code": "NAV",
                  "Status": "CNF"
                }
              ]
            },
            "GuaranteePrepaid": {}
          }
        },
        {
          "Vendor": {
            "Code": "ZE",
            "Name": "HERTZ",
            "Logo": "http://vcmp.sgdcelab.sabre.com/image/upload/f_auto,q_auto:best,t_vcmp_logo/car/l/ze/ZE.png"
          },
          "PickUpLocation": {
            "PolicyRef": "ZEDFWDFW",
            "LocationCode": "DFW",
            "ExtendedLocationCode": "DFW",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ZEDFWDFW",
            "LocationCode": "DFW",
            "ExtendedLocationCode": "DFW",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "RCHW8",
            "RatePlanReturned": "W",
            "GuaranteeInd": "G",
            "Vehicle": {
              "VehType": "SFAR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 5
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 3,
                      "Size": "Large"
                    },
                    {
                      "Quantity": 2,
                      "Size": "Small"
                    }
                  ]
                }
              },
              "Images": {
                "Image": [
                  {
                    "Url": "http://vcmp.dev.sabre.com/image/upload/f_auto,q_auto:best/car/i/58925/zetdo9p1v5p8evmy9t9o.jpg",
                    "Type": "ORIGINAL",
                    "Height": 128,
                    "Width": 220
                  }
                ]
              }
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "222.90",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "31.87",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "8.92",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "1009.44",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {
              "TotalAmount": "237.86",
              "CarExtra": [
                {
                  "BaseAmount": "237.86",
                  "Plan": "B",
                  "Code": "NAV",
                  "Status": "CNF"
                }
              ]
            },
            "GuaranteePrepaid": {}
          }
        }
      ]
    },
    "VehLocPolicyInfos": {
      "VehLocPolicyinfo": [
          "PolicyRef": "ZEDFWDFW",
          "LocationName": "DALLAS FORT WORTH INTL",
          "LocationCode": "DFW",
          "ExtendedLocationCode": "DFW",
          "LocationOwner": "C",
          "CounterLocation": "A",
          "LocationType": "PickUp",
          "VendorDetails": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "LocationInfo": {
            "Address": {
              "AddressLine1": "2424 EAST 38TH STREET",
              "CityName": {
                "value": "DALLAS"
              },
              "StateProv": {
                "StateCode": "TX"
              },
              "PostalCode": "752610000",
              "CountryName": {
                "Code": "US",
                "value": "United States"
              }
            }
          },
          "OperationSchedule": {
            "StartDate": "2019-03-12",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0000",
                  "end": "2359",
                  "DayOfTheWeek": "Tuesday"
                }
              ]
            }
          }
        },
        {
          "PolicyRef": "ZEDFWDFW",
          "LocationName": "DALLAS FORT WORTH INTL",
          "LocationCode": "DFW",
          "ExtendedLocationCode": "DFW",
          "LocationOwner": "C",
          "CounterLocation": "A",
          "LocationType": "DropOff",
          "VendorDetails": {
            "Code": "ZE",
            "Name": "HERTZ"
          },
          "LocationInfo": {
            "Address": {
              "AddressLine1": "2424 EAST 38TH STREET",
              "CityName": {
                "value": "DALLAS"
              },
              "StateProv": {
                "StateCode": "TX"
              },
              "PostalCode": "752610000",
              "CountryName": {
                "Code": "US",
                "value": "United States"
              }
            }
          },
          "OperationSchedule": {
            "StartDate": "2019-03-26",
            "OperationTimes": {
              "OperationTime": [
                {
                  "start": "0000",
                  "end": "2359",
                  "DayOfTheWeek": "Tuesday"
                }
              ]
            }
          }
        }
      ]
    }
  }
}

Car Image References

The ImageRef request type is used to return images associated with searched vehicles. It contains basic car rental vendor information, car type image references (ImageRef), pick-up/drop-off airport or non-airport location, dates needed, and pick-up/drop-off time.

Request

{
  "GetVehAvailRQ": {
    "SearchCriteria": {
      "AirportRef": {
        "PickUpLocation": {
          "LocationCode": "SFO"
        },
        "ReturnLocation": {
          "LocationCode": "SFO"
        }
      },
      "RatePrefs": {
      "GuaranteePrepaid": {
        "Type": "GPR"
        },
        "RateRule": [
          {
           "RateCode": "HOTW",
           "VendorCode": "ZI"
          }
        ],
        "CustLoyalty": [
        {
          "MembershipType": "CD",
          "MembershipCode": "ZE",
          "MembershipId": "05"
        },
        {
          "MembershipType": "IT",
           "MembershipCode": "ZA",
          "MembershipId": "TOURUSA"
        },
        {
          "MembershipType": "PC",
         "MembershipCode": "AL",
          "MembershipId": "1234567890"
        }
      ],
     
        "Commission": false,
        "RateAssured": false
      },
      "PickUpTime": "07:30",
      "ReturnTime": "07:30",
      "PickUpDate": "2019-03-12",
      "ReturnDate": "2019-03-20",
      "LocPolicyRef": {
        "include": false
      },
    "ImageRef": {
      "Image": [
        {
          "Type": "THUMBNAIL"
        },
        {
          "Type": "ORIGINAL"
        },
        {
          "Type": "SMALL"
        },
        {
          "Type": "MEDIUM"
        },
        {
          "Type": "LARGE"
        }
      ]
    },
     "VehPrefs":{
     "SeatBeltsAndBagsInfo": {
        "SeatBelts": {
          "Quantity": 5
        },
        "BagsInfo": {
          "Bags":  
           {
            "Quantity": 2,
            "Size": "Large"
           }
          }
      }
      },
      "VehPrefs": {
        "VehPref": {                                                        
          "VehType": [                                                          
              "SCAR",                                                            
              "ECAR",
              "LCAR"
          ]
        }                                                
        },                                

      "VendorPrefs": {
        "VendorPref": [
          {
            "Code": "ZE"
          },
          {
            "Code": "ZI"
          }
        ]
      }
    }
  }
}

Response

{
  "GetVehAvailRS": {
    "ApplicationResults": {
      "status": "Complete",
      "Success": [
        {
          "timeStamp": "2019-02-20T11:17:12.738-06:00"
        }
      ]
    },
    "VehAvailInfos": {
      "PickUpDate": "2019-03-12",
      "PickUpTime": "0730",
      "ReturnDate": "2019-03-20",
      "ReturnTime": "0730",
      "RentalDays": "8",
      "RentalHours": "0",
      "VehAvailInfo": [
          "Vendor": {
            "Code": "ZA",
            "Name": "PAYLESS"
          },
          "PickUpLocation": {
            "PolicyRef": "ZASFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ZASFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "WK",
            "RatePlanReturned": "W",
            "RatePlanChangeIndicator": "true",
            "GuaranteeInd": "G",
            "RateAssured": "*",
            "Vehicle": {
              "VehType": "ECAR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 5
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 3,
                      "Size": "Small"
                    }
                  ]
                }
              },
              "Images": {}
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "599.99",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "85.71",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "50.01",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "880.24",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {},
            "GuaranteePrepaid": {}
          }
        },
        {
          "Vendor": {
            "Code": "ZA",
            "Name": "PAYLESS"
          },
          "PickUpLocation": {
            "PolicyRef": "ZASFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "ReturnLocation": {
            "PolicyRef": "ZASFOSFO",
            "LocationCode": "SFO",
            "ExtendedLocationCode": "SFO",
            "Distance": "NA"
          },
          "VehRentalRate": {
            "AvailabilityStatus": "S",
            "RateCode": "WK",
            "RatePlanReturned": "W",
            "RatePlanChangeIndicator": "true",
            "GuaranteeInd": "G",
            "RateAssured": "*",
            "Vehicle": {
              "VehType": "SCAR",
              "SeatBeltsAndBagsInfo": {
                "SeatBelts": {
                  "Quantity": 5
                },
                "BagsInfo": {
                  "Bags": [
                    {
                      "Quantity": 3,
                      "Size": "Small"
                    }
                  ]
                }
              },
              "Images": {}
            },
            "VehicleCharges": {
              "VehicleCharge": [
                {
                  "Amount": "599.99",
                  "CurrencyCode": "USD",
                  "ChargeType": "BaseRateTotal",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "85.71",
                  "ChargeType": "ExtraDay",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "50.01",
                  "ChargeType": "ExtraHour",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                },
                {
                  "Amount": "880.77",
                  "ChargeType": "ApproximateTotalPrice",
                  "MileageAllowance": "UNL",
                  "ExtraMileageCharge": ".00",
                  "UOM": "MI"
                }
              ]
            },
            "Commission": {},
            "CarExtraCharges": {},
            "GuaranteePrepaid": {}
          }
        }
      ]
    }
  }
}