Car Locations

Car Locations

Build a custom integration with our APIs

The following steps represent a typical application request flow. Each step details information that should be collected from the user (i.e. reservation holder) in your application, and passed to our APIs.

It is assumed that your application is designed to allow a user to select from pre-populated values (such as a drop-down menu), or to provide text input for a value.

Stage One – Pick a Location

This Stage represents the request flow of a user looking for rental car brand locations via keyword or geographic coordinates.

  1. Ask the user to select a rental car brand or multiple brands. Currently this is Avis, Budget or Payless.
  2. The user selects the "Avis" brand and supplies a location of "Boston". You may choose to design autocomplete functionality for this step.
  3. Call the Car Locations endpoint with the location keyword of "Boston" and the selected brand.  Brand can be a single brand, like "Avis".  Or multiple brands, like "Avis,Budget".  Omitting the brand parameter means "All Brands".
  4. The API will return a set of location objects that match the criteria provided.  We recommend your application display the top 3-4 location results to the user along with the brand name.
  5. The user selects Boston Logan International Airport ("BOS"). Obtain the location code from the response in preparation for Stage Two.

Stage Two – Get Pickup/Dropoff Details

  1. Ask the user to provide their country code of residence, rental car pickup/dropoff date and time.
  2. Ask the user to specify their brand membership code. This can be an Avis Wizard number, Budget customer number, or Payless number. These numbers are used to store a given customer's travel details and rental preferences.
  3. Ask the user to specify their rental car brand discount code. This can be an Avis Worldwide Discount (AWD), Budget Car Discount (BCD), or a Payless Discount Number (PDN) code.
  4. Ask the user to specify a promotional coupon code. This can be applied to a reservation for discounts, upgrades, free days, or other promotional offers.
  5. Prepare to pass the values to Stage Three. 

Stage Three – Get Vehicle Availability and a Basic Rate

  1. Call the Car Availability endpoint and pass the values specified by the user in Stage One and Two to obtain basic rate and availability.  The response of the endpoint is grouped by rental car category, features, capacity, basic rate and estimated total for each result.
  2. The rate in the response reflects any (valid) brand discount and coupon code values specified by the user. We recommend you display the vehicle category details and reservation total by the rental car category to the user.
  3. Once the user has made a selection, obtain the brand membership, brand discount, and coupon code values specified by the user from the response. Notify the user if any of the codes were applied successfully or were invalid.
  4. Obtain the Class Code and Rate Code from the vehicle selected by the user and prepare for Stage Four.

Stage Four – Get a Detailed Rate

  1. Call the Car Rate endpoint using all the values specified and collected in the previous three Stages.  This should include:
               - Pickup Date and Time
               - Pickup Location Code
               - Brand
               - Dropoff Date and Time
               - Dropoff Location Code
               - Country of Residence Code
               - Vehicle Class Code
               - Vehicle Rate Code
               - Brand Discount Code (if applicable)
               - Coupon Code (if applicable)
               - Brand Membership Code (if applicable)
               - Frequent Traveler Program Company and Code (if applicable)
  2. The response of the endpoint is grouped by distance limitations, pickup/dropoff location, insurance, totals, taxes and fees, insurance, or extras (such as GPS).
  3. Display the rate and any applicable discounts to the user. For example, if a coupon code was applied, display the description from the response, e.g., "25USD Off with Rental of CSS/Paperless Coupon".
  4. Ask the user if they would like to select rental car insurance or any extras (such as GPS) for their reservation. 
  5. If you have not already done so, ask the user to log-in or provide their contact and payment information. Notify the user if their payment information is invalid.
  6. Once the user has reviewed the details of their reservation, gather data for Stage Five to create the reservation.

Stage Five - Create a Reservation

  1. Call the Create Reservation endpoint to pass the user's contact information, pickup/dropoff location, and any additional reservation details from the prior Stages to book the rental car.  This endpoint will return a confirmation number if the reservation was created successfully.

Stage Six – Display a Summary

  1. Display the confirmation number and reservation details to the user.  When the user returns to your website at a later date, the View Reservation endpoint can be used to retrieve a reservation summary to display to  the user.