openapi: 3.2.0 info: title: Rental Cars Car Availability API version: 2.0.0 description: '## Car Locations V2 The Car Locations suite allows a user to retrieve rental car locations.' x-short-description: 'Combined ABG Rental Cars API package: vehicle availability & rates, reservations, location search, and terms & conditions.' servers: - url: https://stage.abgapiservices.com description: Stage Environment security: - ABG-Access-Token: [] tags: - name: Car Availability description: Car Availability API paths: /cars/catalog/v2/vehicles: get: tags: - Car Availability parameters: - $ref: '#/components/parameters/brand' - name: pickup_date description: ISO 8601 date and time of pickup. schema: type: string in: query required: true x-example: '2022-06-21T10:00:00' - name: pickup_location description: Rental car pickup location code. schema: type: string in: query required: true x-example: LHR - name: age description: Driver’s age. This might influence the rates. Will be superseded by date of birth found in the profile provided in “membership_code”. schema: type: number in: query required: false - name: date_of_birth description: Driver’s date of birth. This might influence the rates. Will be superseded by “age” parameter or date of birth found in the profile provided in “membership_code”. schema: format: date type: string in: query required: false x-example: '1991-12-31T00:00:00.000Z' - name: membership_code description: The brand membership program code. This can be an Avis wizard number, Budget customer number, or Payless number. schema: type: string in: query required: false - name: dropoff_date description: ISO 8601 date and time of dropoff. schema: type: string in: query required: true x-example: '2022-06-28T10:00:00' - name: dropoff_location description: Rental car dropoff location code. schema: type: string in: query required: true x-example: LHR - name: country_code description: 2-character ISO 3166 customer country code. schema: maxLength: 2 minLength: 2 type: string in: query required: true x-example: GB - name: discount_code description: The rental vehicle brand discount code. This field can be an Avis Worldwide Discount (AWD), Budget Car Discount (BCD), or a Payless Discount Number (PDN) code. schema: type: string in: query required: false x-example: R566100 - name: coupon_code description: The promotional coupon code number to be applied to the reservation rate. schema: type: string in: query required: false x-example: MUZZ014 - name: iata_number description: International Air Transport Association (IATA) number. This is an identifier used by travel agents that allows the rental car company to pay the agent a commission for the rental. schema: type: string in: query required: false x-example: 0104724P - name: requested_rate_currency description: Specifies the ISO currency code in which the rate is fetched. This will be Secondary currency and rate currency will be the primary by default. schema: type: string in: query required: false x-example: USD - name: transaction_id description: In the instance a request has failed, transaction identifiers allow you to quickly identify the failed request. The following request transaction identifier may be used by your application to identify a request. We recommend that you use this identifier in every request. schema: type: string in: query required: false x-example: '23492034738' - $ref: '#/components/parameters/client_id' - name: partner_membership_code description: Customer's partner membership code associated with partner membership program. schema: type: string in: query - name: vehicle_sipp_codes description: This field contains comma-separated sipp_codes used for vehicle filtering. sipp code refers to Standard Interline Passenger Procedure (SIPP) code of the vehicle. A compact 4 door manual air conditioned car will have a SIPP Code CMDR. schema: type: string in: query - name: vehicle_class_codes description: This field contains comma-separated vehicle_class_codes used for vehicle filtering. schema: type: string in: query - name: inclusive description: Inclusive rate shop with coverages (Inclusive price) schema: type: boolean in: query - name: paperless description: Indicate that the car availability request is for retail paperless voucher to validate the location participates. schema: type: boolean in: query - name: central_billing_membership_code description: Corporate membership code for central billing account profile. schema: type: string in: query - name: rate_code description: The rental vehicle rate code used to determine the rate of the rental vehicle reservation schema: type: string in: query - name: rate_type description: The Rate type representing the Corporate vs Leisure rates schema: enum: - CORPORATE - LEISURE type: string in: query required: false - name: partner_membership_loyalty_level description: The partner membership loyalty level or status. schema: type: string in: query - name: last_name description: Last name of the user. schema: type: string in: query responses: '200': content: application/json: schema: $ref: '#/components/schemas/best_buy_response' example: status: request_time: '2022-03-04T11:06:46Z' success: - code: '200' message: Success details: The vehicle availability was successfully retrieved. transaction: transaction_id: b7c55f3a-a96f-46ac-a0de-180d59455261 product: brand: Avis vehicles: - category: name: Group A - Fiat 500 or similar make: Fiat model: 500 sipp_code: MBMR vehicle_class_code: A vehicle_class_name: Mini Manual vehicle_transmission: Manual image_url: https://www.Avis.com/content/dam/cars/l/2015/fiat/2015-fiat-500-sport-hatchback-black.png small_image_url: https://www.Avis.com/content/dam/cars/s/2015/fiat/2015-fiat-500-sport-hatchback-black.png features: air_conditioned: true capacity: doors: '3' seats: '4' luggage_capacity: small_suitcase: '1' rate_totals: rate: currency: GBP rate_code: 7I coupon_applied: false discount: code: R566100 pay_later: rate_code: 7I vehicle_total: 220.28 reservation_total: 264.33 pay_now: rate_code: 2X vehicle_total: 200.26 reservation_total: 240.32 reservation: pickup_location: location: code: LHR name: London Heathrow Airport T234 telephone: (44) 3445446000 airport_location: true address: address_line_1: Central Heathrow Loc address_line_2: Northrop Rd city: London postal_code: TW6 2QA country_code: GB dropoff_location: location: code: LHR name: London Heathrow Airport T234 telephone: (44) 3445446000 airport_location: true address: address_line_1: Central Heathrow Loc address_line_2: Northrop Rd city: London postal_code: TW6 2QA country_code: GB description: Car Availability Best Buy Response '400': content: application/json: schema: $ref: '#/components/schemas/availability_error_response' example: status: request_time: '2019-01-04T15:15:30Z' request_errors: 1 errors: - code: '400' message: Bad Request reason: invalid_request details: Missing required field 'brand' - code: '14528' message: Bad Request reason: Invalid rate_code. details: Rate Code entered is invalid. - code: '14184' message: Bad Request reason: Last name and customer id combination is invalid. details: 'Last name does not match the wizard number ' - code: '1112' message: Bad Request reason: Invalid coupon_code and IATA number combination. details: 'This coupon requires an IATA / ARC number. Please enter your number below or remove the coupon from this reservation. ' - code: '13213' message: Bad Request reason: Country Code is invalid details: Please enter a valid Country Code. - code: '14442' message: Bad Request reason: RENTAL DURATION LESS THAN MINIMUM details: RENTAL DURATION LESS THAN MINIMUM - code: '1103' message: Bad Request reason: Invalid Country/Coupon Code details: This station does not participate. Valid at corporate/participating licensees in the U.S. (excluding Alaska, Hawaii and the New York Metro), Canada, Australia, New Zealand, France, Puerto Rico, United Kingdom and U.S. Virgin Islands. - code: '14372' message: Bad Request reason: Invalid coupon_code details: The Coupon Number entered is invalid. - code: '14374' message: Bad Request reason: coupon_code is invalid for the given time frame. details: The Coupon Number entered does not meet the minimum days requirement. Please check the terms and conditions or remove to continue this reservation. - code: '19076' message: Bad Request reason: loyalty_code/membership_code details: Membership Number entered is invalid. - code: '235' message: Bad Request reason: loyalty_code and loyalty_company_id are required parameters for the selection of Frequent Travel Program. details: If you have selected a Frequent Traveler Program, than you must enter a Membership Number - code: '14075' message: Bad Request reason: rate_code requires a valid discount_code in the request. details: ' The rate code you entered requires a discount number. Please go back and enter your discount number or remove the rate code you entered.' - code: '1798' message: Bad Request reason: Invalid discount_code. details: Invalid AWD - code: '14022' message: Bad Request reason: Invalid vehicle_class_code details: Requested Car Group is invalid. - code: '12012' message: Bad Request reason: Invalid city details: MSGCD_E_WIZ_CITY_NAME_REQUIRED - code: '14105' message: Bad Request reason: Invalid rate_code. details: Invalid Vehicle rate code and class code combination for the provided brand. - code: '208' message: Bad Request reason: Invalid membership_code. details: Invalid Wizard number for the customer. - code: '205' message: Bad Request reason: Invalid dropoff_location. details: Invalid Drop off location - code: '203' message: Bad Request reason: Invalid pickup_location. details: Invalid Pick up location - code: '231' message: Bad Request reason: Invalid pickup_date. details: You selected a date/time prior to the current time - code: '232' message: Bad Request reason: dropoff_date is prior to pickup_date. details: Return Date cannot be prior or same to the Pick-Up Date - code: '237' message: Bad Request reason: Invalid flight carrier_name. details: Please select valid Airline - code: '239' message: Bad Request reason: Invalid filght carrier_code. details: Please enter a valid flight number. Flight Number format is a maximum 4 numbers. Please omit letters from your flight number - code: '234' message: Bad Request reason: Invalid loyalty_code. details: If you have entered a Membership Number, then you must select a Frequent Traveler Program. - code: '209' message: Bad Request reason: Invalid coupon_code. details: Please enter a valid Coupon Number. - code: '216' message: Bad Request reason: Invalid discount_code. details: The discount number is invalid for the given . - code: '1122' message: Bad Request reason: coupon_code is invalid for the given time frame. details: Coupon requires a minimum length of 3 days. Please select a rate to continue (coupon will be removed). - code: '300100' message: Bad Request reason: PrePayReservationCurrency must be required details: PrePayReservationCurrency must be required - code: '300101' message: Bad Request reason: PrePayReservationAmount must be required details: PrePayReservationAmount must be required - code: '300111' message: Bad Request reason: Prepay information details are required for the Prepay type. details: Prepay Information must be required. - code: '900909' message: Bad Request reason: cvv is invalid for the provided Credit Card. details: cvv is invalid for the provided Credit Card. - code: '215' message: Bad Request reason: Invalid email. details: Invalid email address - code: '19001' message: Bad Request reason: country_code,state_name and postal_code combination is invalid. details: Invalid zip code. - code: '14126' message: Bad Request reason: dropoff_date and pickup_date combination is invalid. details: Pick-up Date can not be after Return Date. - code: '14441' message: Bad Request reason: Bad Request details: Bad Request - code: '1112' message: Bad Request reason: Invalid coupon_code and IATA number combination. details: This coupon requires an IATA / ARC number. Please enter your number below or remove the coupon from this reservation. - code: '14299' message: Bad Request reason: Bad Request details: Invalid insurance details - code: '14129' message: Bad Request reason: Invalid pickup_date. details: pickup_date is less than the current date. - code: '219' message: Bad Request reason: Missing partner_country_code. details: Country of residence is required. - code: '19074' message: Bad Request reason: Invalid rate_code and vehicle_class_code combination for the provided brand. details: ' Rate Code entered is invalid.' - code: '1109' message: Bad Request reason: Coupon is applicable only for certain discount types. details: 'This coupon requires one of the following discount number types: {0}.' - code: '1203' message: Bad Request reason: Invalid coupon and discount combination. details: This coupon {0} may only be used with a specific AWD number (see offer terms). Please enter this AWD number to continue or select from available cars to continue without the coupon. - code: '1124' message: Bad Request reason: Invalid coupon and brand combination. details: This coupon may only be used on W G car groups. Please select from one of these groups or select a different one to proceed without the coupon. - code: '22224' message: Bad Request reason: A One-Way Rental between given pickup_location and dropoff_location is not available details: A One-Way Rental between these 2 locations cannot be booked online. - code: '242' message: Bad Request reason: The Rental Location you have selected is closed during the hours requested details: The Rental Location you have selected is closed during the hours requested - code: '60010' message: Bad Request reason: Incorrect coupon_code. details: This type of coupon cannot be applied online. Paper coupons must be presented at the rental counter and may require proper credentials. Some location restrictions apply, please check complete coupon Terms & Conditions - code: '14261' message: Bad Request reason: The Rental Location you have selected is closed during the return hour requested. details: The Rental Location you have selected is closed during the return hour requested. - code: '1102' message: Bad Request reason: Invalid coupon_code. details: Input is not a valid coupon number. You may modify the coupon number under Rental Information on this page or select a vehicle to proceed with your reservation (coupon will be removed). - code: '319' message: Bad Request reason: Business exception. details: SYS_WIZ_NO_TSRS_AVAILABLE. - code: '221' message: Bad Request reason: Maximum number of days limit exceeded. details: Sorry, 330 days is the maximum number of days that can be reserved. description: 400 Bad Request is returned when the request could not be understood by the server. 400 includes missing required values, invalid data types, minimum/maximum values, ranges and format. '401': content: application/json: schema: $ref: '#/components/schemas/error_401' examples: un_authorized: value: status: request_time: '2022-03-07T12:00:30Z' request_errors: 1 errors: - code: '401' message: unauthorized reason: unauthorized_client details: Invalid Client Credentials transaction: system_id: C56a1700-43e1-11e9-95ce-e6a7a0e31bec description: 401 unauthorized error is a client-side error. Usually, this means the provided client credentials aren’t working or incorrect credentials. '403': content: application/json: schema: $ref: '#/components/schemas/error_403' examples: forbidden: value: status: request_time: '2022-03-07T12:00:30Z' request_errors: 1 errors: - code: '403' message: Forbidden reason: Forbidden details: Authentication was provided, but the authenticated user dosen't have access to requested resource transaction: system_id: C56a1700-43e1-11e9-95ce-e6a7a0e31bec description: 403 Forbidden is returned when the is not authorized to access the requested resource. '404': content: application/json: schema: $ref: '#/components/schemas/availability_error_response' example: status: request_time: '2019-01-04T15:15:30Z' request_errors: 1 errors: - code: '404' message: Resource Not Found reason: resource_failure details: Server cannot find the requested resource. This may be due to incorrect URI or a resource that is not available. - code: '223' message: Not Found reason: Invalid pickup_location. details: The pick-up location entered is Sold Out for the dates you have entered - code: '14381' message: Not Found reason: 'A One-Way Rental between given pickup_location and dropoff_location is not available ' details: 'A One-Way Rental between given pickup_location and dropoff_location is not available ' - code: '226' message: Not Found reason: Invalid dropoff_location. details: There are no locations available for your Return address. - code: '225' message: Not Found reason: Invalid pickup_location. details: There are no locations available for your Pick-up address. - code: '227' message: Not Found reason: Invalid pickup_location and dropoff_location. details: Sorry! No locations are available in address provided. - code: '500708' message: Not Found reason: No vehicles are available for the given filtering criteria details: Sorry! No vehicles are available for the given filtering criteria. description: 404 Not Found is returned when server cannot find the matching request URI (either due to no results, or because of a non-existent endpoint or resource). Server may also respond with this status code when there is 401 or 403, which the service wants to mask for security reasons. '415': content: application/json: schema: $ref: '#/components/schemas/availability_error_response' example: status: request_time: '2018-10-17T13:05:10Z' request_errors: 1 errors: - code: '415' message: Unsupported Media Type reason: Unsupported Media Type details: org.springframework.web.HttpMediaTypeNotSupportedException description: The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format. '500': content: application/json: schema: $ref: '#/components/schemas/availability_error_response' example: status: request_time: '2019-01-04T15:15:30Z' request_errors: 1 errors: - code: '40018' message: Service exception reason: Service exception details: Socket timeout from IMS Connect - code: '610' message: Service exception reason: System exception from e-com backend. details: System Exception occurred during location search.Please check the log for details. description: 500 Internal Server Error is returned when a system or application error has occurred. It generally indicates that something unexpected has gone wrong on the server. This is used for a standard server side exception for a persistent error on the server side. x-amf-mediaType: application/json operationId: CarAvailability summary: Best Buy x-operation-id-source: normalized x-operation-id-original: Car Availability /cars/catalog/v2/vehicles/rates: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/car_availability_rate_request' required: true tags: - Car Availability parameters: - $ref: '#/components/parameters/client_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/rate_request_response' description: Rate Request Success Response. '400': content: application/json: schema: $ref: '#/components/schemas/availability_error_response' example: status: request_time: '2019-01-04T15:15:30Z' request_errors: 1 errors: - code: '400' message: Bad Request reason: invalid_request details: Missing required field 'brand' - code: '14528' message: Bad Request reason: Invalid rate_code. details: Rate Code entered is invalid. - code: '14184' message: Bad Request reason: Last name and customer id combination is invalid. details: 'Last name does not match the wizard number ' - code: '1112' message: Bad Request reason: Invalid coupon_code and IATA number combination. details: 'This coupon requires an IATA / ARC number. Please enter your number below or remove the coupon from this reservation. ' - code: '13213' message: Bad Request reason: Country Code is invalid details: Please enter a valid Country Code. - code: '14442' message: Bad Request reason: RENTAL DURATION LESS THAN MINIMUM details: RENTAL DURATION LESS THAN MINIMUM - code: '1103' message: Bad Request reason: Invalid Country/Coupon Code details: This station does not participate. Valid at corporate/participating licensees in the U.S. (excluding Alaska, Hawaii and the New York Metro), Canada, Australia, New Zealand, France, Puerto Rico, United Kingdom and U.S. Virgin Islands. - code: '14372' message: Bad Request reason: Invalid coupon_code details: The Coupon Number entered is invalid. - code: '14374' message: Bad Request reason: coupon_code is invalid for the given time frame. details: The Coupon Number entered does not meet the minimum days requirement. Please check the terms and conditions or remove to continue this reservation. - code: '19076' message: Bad Request reason: loyalty_code/membership_code details: Membership Number entered is invalid. - code: '235' message: Bad Request reason: loyalty_code and loyalty_company_id are required parameters for the selection of Frequent Travel Program. details: If you have selected a Frequent Traveler Program, than you must enter a Membership Number - code: '14075' message: Bad Request reason: rate_code requires a valid discount_code in the request. details: ' The rate code you entered requires a discount number. Please go back and enter your discount number or remove the rate code you entered.' - code: '1798' message: Bad Request reason: Invalid discount_code. details: Invalid AWD - code: '14022' message: Bad Request reason: Invalid vehicle_class_code details: Requested Car Group is invalid. - code: '12012' message: Bad Request reason: Invalid city details: MSGCD_E_WIZ_CITY_NAME_REQUIRED - code: '14105' message: Bad Request reason: Invalid rate_code. details: Invalid Vehicle rate code and class code combination for the provided brand. - code: '208' message: Bad Request reason: Invalid membership_code. details: Invalid Wizard number for the customer. - code: '205' message: Bad Request reason: Invalid dropoff_location. details: Invalid Drop off location - code: '203' message: Bad Request reason: Invalid pickup_location. details: Invalid Pick up location - code: '231' message: Bad Request reason: Invalid pickup_date. details: You selected a date/time prior to the current time - code: '232' message: Bad Request reason: dropoff_date is prior to pickup_date. details: Return Date cannot be prior or same to the Pick-Up Date - code: '237' message: Bad Request reason: Invalid flight carrier_name. details: Please select valid Airline - code: '239' message: Bad Request reason: Invalid filght carrier_code. details: Please enter a valid flight number. Flight Number format is a maximum 4 numbers. Please omit letters from your flight number - code: '234' message: Bad Request reason: Invalid loyalty_code. details: If you have entered a Membership Number, then you must select a Frequent Traveler Program. - code: '209' message: Bad Request reason: Invalid coupon_code. details: Please enter a valid Coupon Number. - code: '216' message: Bad Request reason: Invalid discount_code. details: The discount number is invalid for the given . - code: '1122' message: Bad Request reason: coupon_code is invalid for the given time frame. details: Coupon requires a minimum length of 3 days. Please select a rate to continue (coupon will be removed). - code: '300100' message: Bad Request reason: PrePayReservationCurrency must be required details: PrePayReservationCurrency must be required - code: '300101' message: Bad Request reason: PrePayReservationAmount must be required details: PrePayReservationAmount must be required - code: '300111' message: Bad Request reason: Prepay information details are required for the Prepay type. details: Prepay Information must be required. - code: '900909' message: Bad Request reason: cvv is invalid for the provided Credit Card. details: cvv is invalid for the provided Credit Card. - code: '215' message: Bad Request reason: Invalid email. details: Invalid email address - code: '19001' message: Bad Request reason: country_code,state_name and postal_code combination is invalid. details: Invalid zip code. - code: '14126' message: Bad Request reason: dropoff_date and pickup_date combination is invalid. details: Pick-up Date can not be after Return Date. - code: '14441' message: Bad Request reason: Bad Request details: Bad Request - code: '1112' message: Bad Request reason: Invalid coupon_code and IATA number combination. details: This coupon requires an IATA / ARC number. Please enter your number below or remove the coupon from this reservation. - code: '14299' message: Bad Request reason: Bad Request details: Invalid insurance details - code: '14129' message: Bad Request reason: Invalid pickup_date. details: pickup_date is less than the current date. - code: '219' message: Bad Request reason: Missing partner_country_code. details: Country of residence is required. - code: '19074' message: Bad Request reason: Invalid rate_code and vehicle_class_code combination for the provided brand. details: ' Rate Code entered is invalid.' - code: '1109' message: Bad Request reason: Coupon is applicable only for certain discount types. details: 'This coupon requires one of the following discount number types: {0}.' - code: '1203' message: Bad Request reason: Invalid coupon and discount combination. details: This coupon {0} may only be used with a specific AWD number (see offer terms). Please enter this AWD number to continue or select from available cars to continue without the coupon. - code: '1124' message: Bad Request reason: Invalid coupon and brand combination. details: This coupon may only be used on W G car groups. Please select from one of these groups or select a different one to proceed without the coupon. - code: '22224' message: Bad Request reason: A One-Way Rental between given pickup_location and dropoff_location is not available details: A One-Way Rental between these 2 locations cannot be booked online. - code: '242' message: Bad Request reason: The Rental Location you have selected is closed during the hours requested details: The Rental Location you have selected is closed during the hours requested - code: '60010' message: Bad Request reason: Incorrect coupon_code. details: This type of coupon cannot be applied online. Paper coupons must be presented at the rental counter and may require proper credentials. Some location restrictions apply, please check complete coupon Terms & Conditions - code: '14261' message: Bad Request reason: The Rental Location you have selected is closed during the return hour requested. details: The Rental Location you have selected is closed during the return hour requested. - code: '1102' message: Bad Request reason: Invalid coupon_code. details: Input is not a valid coupon number. You may modify the coupon number under Rental Information on this page or select a vehicle to proceed with your reservation (coupon will be removed). - code: '319' message: Bad Request reason: Business exception. details: SYS_WIZ_NO_TSRS_AVAILABLE. - code: '221' message: Bad Request reason: Maximum number of days limit exceeded. details: Sorry, 330 days is the maximum number of days that can be reserved. description: 400 Bad Request is returned when the request could not be understood by the server. 400 includes missing required values, invalid data types, minimum/maximum values, ranges and format. x-amf-mediaType: application/json '401': content: application/json: schema: $ref: '#/components/schemas/error_401' examples: un_authorized: value: status: request_time: '2022-03-07T12:00:30Z' request_errors: 1 errors: - code: '401' message: unauthorized reason: unauthorized_client details: Invalid Client Credentials transaction: system_id: C56a1700-43e1-11e9-95ce-e6a7a0e31bec description: 401 unauthorized error is a client-side error. Usually, this means the provided client credentials aren’t working or incorrect credentials. '403': content: application/json: schema: $ref: '#/components/schemas/error_403' examples: forbidden: value: status: request_time: '2022-03-07T12:00:30Z' request_errors: 1 errors: - code: '403' message: Forbidden reason: Forbidden details: Authentication was provided, but the authenticated user dosen't have access to requested resource transaction: system_id: C56a1700-43e1-11e9-95ce-e6a7a0e31bec description: 403 Forbidden is returned when the is not authorized to access the requested resource. '404': content: application/json: schema: $ref: '#/components/schemas/availability_error_response' example: status: request_time: '2019-01-04T15:15:30Z' request_errors: 1 errors: - code: '404' message: Resource Not Found reason: resource_failure details: Server cannot find the requested resource. This may be due to incorrect URI or a resource that is not available. - code: '223' message: Not Found reason: Invalid pickup_location. details: The pick-up location entered is Sold Out for the dates you have entered - code: '14381' message: Not Found reason: 'A One-Way Rental between given pickup_location and dropoff_location is not available ' details: 'A One-Way Rental between given pickup_location and dropoff_location is not available ' - code: '226' message: Not Found reason: Invalid dropoff_location. details: There are no locations available for your Return address. - code: '225' message: Not Found reason: Invalid pickup_location. details: There are no locations available for your Pick-up address. - code: '227' message: Not Found reason: Invalid pickup_location and dropoff_location. details: Sorry! No locations are available in address provided. description: 404 Not Found is returned when server cannot find the matching request URI (either due to no results, or because of a non-existent endpoint or resource). Server may also respond with this status code when there is 401 or 403, which the service wants to mask for security reasons. x-amf-mediaType: application/json '415': content: application/json: schema: $ref: '#/components/schemas/availability_error_response' example: status: request_time: '2019-01-04T15:15:30Z' request_errors: 1 errors: - code: '415' message: Unsupported Media Type reason: Unsupported Media Type details: org.mule.module.apikit.exception.UnsupportedMediaTypeException description: The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format. '500': content: application/json: schema: $ref: '#/components/schemas/availability_error_response' example: status: request_time: '2019-01-04T15:15:30Z' request_errors: 1 errors: - code: '40018' message: Service exception reason: Service exception details: Socket timeout from IMS Connect - code: '610' message: Service exception reason: System exception from e-com backend. details: System Exception occurred during location search.Please check the log for details. description: 500 Internal Server Error is returned when a system or application error has occurred. It generally indicates that something unexpected has gone wrong on the server. This is used for a standard server side exception for a persistent error on the server side. summary: Rate request description: Rate Request API which supports ancillary products and insurances. operationId: postCarsCatalogV2VehiclesRates x-operation-id-source: derived components: schemas: availability_contact: title: Availability Contact description: The personal and contact information of the user you would like to associate to the user profile. If you would like to create a basic profile, you can provide the minimal contact information along with an indication of the desired brand. If you would like to create a preferred profile, you are required to provide many more parameters including driver license, payment information, and an election of several required options. If you do not provide this additional information, you will be unable to create a preferred profile. type: object properties: title: description: Title of the user. type: string first_name: description: First name of the user. type: string last_name: description: Last name of the user. type: string email: description: Email address of the user. type: string telephone: description: Telephone number of the user. type: string age: description: Driver’s age. This might influence the rates. Will be superseded by date of birth found in the profile provided in “membership_code”. type: number date_of_birth: format: date title: Date of Birth description: Driver’s date of birth. This might influence the rates. Will be superseded by “age” parameter or date of birth found in the profile provided in “membership_code”. type: string example: '1991-12-31' vehicle_capacity: title: Vehicle Capacity description: Rental vehicle passenger seat and luggage capacity information. type: object properties: doors: description: The number of vehicle doors. type: string example: '4' seats: description: The number of passenger seats in the rental vehicle. type: string example: '5' mpg: description: Miles per gallon (MPG) of the vehicle. type: string example: 27/35 luggage_capacity: $ref: '#/components/schemas/luggage_capacity' fuel_type: $ref: '#/components/schemas/fuel_type' disclaimer: title: Disclaimer description: This contains the addtional information required: - description type: object properties: type: title: Disclaimer Name description: Disclaimer name type: string description: title: Disclaimer Comment description: Disclaimer comment type: string requested_rate_currency: title: Requested Rate Currency description: Requested rate currency for secondary rates. The Secondary currency is driven by the request or through type: string example: USD fee: title: Fee description: Fees applied to the reservation. All available fees and surcharges are returned in the response. Some of these fees are included in the rate, and others are for information purposes only, as they may apply but are not included in the total tax amount. type: object properties: amount: description: The cost of fees applied. type: number name: description: The name of the type of fee(s) applied. type: string included_in_total: description: The flag to indicate whether the fees or charges are included in the Total Reservation cost. type: boolean example: amount: 13.26 name: Domestic Security Fee error_401: title: Error 401 description: UnAuthorized required: - request_time - errors - request_errors type: object properties: request_time: format: date-time description: The time stamp of the request type: string request_errors: description: The number of errors that occurred type: integer errors: title: Errors Details description: The following describes the elements that can appear in the response body of an error. type: array items: $ref: '#/components/schemas/error' availability_vehicle_category: title: Availability Vehicle Category description: Identifying information and details about the rental vehicle. type: object properties: name: title: Name description: The name of the vehicle. type: string example: Volvo XC 60 make: title: Make description: Make of the vehicle. type: string example: Volvo model: title: Make Model description: Model of the vehicle. type: string example: XC60 sipp_code: $ref: '#/components/schemas/sipp_code' vehicle_status: $ref: '#/components/schemas/vehicle_status' vehicle_class_code: $ref: '#/components/schemas/vehicle_class_code' vehicle_class_name: title: Vehicle Class Name description: The name of the vehicle class. type: string example: Economy vehicle_transmission: $ref: '#/components/schemas/transmission' image_url: $ref: '#/components/schemas/url' small_image_url: $ref: '#/components/schemas/url' transaction: title: Request Transaction description: In the instance a request has failed, transaction identifiers allow you to quickly identify the failed request. The following request transaction identifier may be used by your application to identify a request. We recommend that you use this identifier in every request. type: object properties: transaction_id: $ref: '#/components/schemas/transaction_id' system_id: title: Internal Correlation Identifier description: A unique identifier generated internally by the application to identify the payload and troubleshoot. type: string example: i9332ffa-5250-11e9-8647-d663bd873d78 example: transaction_id: test56 rate_request_response: title: Rate Request Response description: The following demonstrates an example of a successful request for this endpoint. required: - status - transaction - product - reservation type: object properties: status: $ref: '#/components/schemas/success_status' transaction: $ref: '#/components/schemas/transaction' product: $ref: '#/components/schemas/product' reservation: $ref: '#/components/schemas/reservation_availability' example: status: request_time: '2022-03-05T09:25:06Z' success: - code: '200' message: Success details: The vehicle rate was successfully retrieved. transaction: transaction_id: 4106aab1-0b97-4fec-8291-b84b36d299cc product: brand: Avis reservation: distance: unlimited_distance: true distance_unit: Mile pickup_location: location: code: LHR name: London Heathrow Airport T234 telephone: (44) 3445446000 airport_location: true address: address_line_1: Central Heathrow Loc address_line_2: Northrop Rd city: London postal_code: TW6 2QA country_code: GB dropoff_location: location: code: LHR name: London Heathrow Airport T234 telephone: (44) 3445446000 airport_location: true address: address_line_1: Central Heathrow Loc address_line_2: Northrop Rd city: London postal_code: TW6 2QA country_code: GB rate_totals: rate: currency: GBP rate_code: IC amount: 183.34 discount: code: R566100 membership: code: B0876Z taxes_fees: taxes: - type: Local Tax amount: 11.61 included_in_total: true fees: - amount: 58.04 name: Airport/City/Other Surcharge included_in_total: true totals: vehicle_total: 183.34 taxes_fees_total: 69.65 reservation_total: 252.99 insurance: - code: TP name: Theft Protection currency: GBP amount: 0 excess_amount: 0 selection_note: ACCEPTED selected: true tax_included: true - code: CDW name: Collision Damage Waver currency: GBP amount: 0 excess_amount: 0 selection_note: ACCEPTED selected: true tax_included: true - code: PAI name: Personal Accident Insurance currency: GBP amount: 0 selection_note: DEFAULT selected: false tax_included: false extras: - code: ADD quantity: 0 type: COUNTER_PROD currency: GBP amount: 65.31 description: Additional Driver tax_included: true - code: CSS quantity: 0 type: SPEC_EQUIP currency: GBP amount: 60.27 description: Child Safety Seat tax_included: false - code: GPS quantity: 0 type: COUNTER_PROD currency: GBP amount: 65.31 description: GPS Unit tax_included: false - code: INC quantity: 0 type: COUNTER_PROD currency: GBP amount: 8.98 description: 2.1 Amp Car Adapter tax_included: false - code: IXB quantity: 0 type: COUNTER_PROD currency: GBP amount: 75 description: Group 0 Isofix Child Seat Base tax_included: false - code: NSF quantity: 0 type: COUNTER_PROD currency: GBP amount: 60 description: No Show Fee tax_included: false - code: PAC quantity: 0 type: COUNTER_PROD currency: GBP amount: 8.98 description: Mobile Phone Adapter tax_included: false - code: RSN quantity: 0 type: COUNTER_PROD currency: GBP amount: 25.13 description: Roadside Saftey Net tax_included: false - code: TPR quantity: 0 type: COUNTER_PROD currency: GBP amount: 45.22 description: Travel Partner tax_included: false - code: WFI quantity: 0 type: COUNTER_PROD currency: GBP amount: 65.31 description: WiFi tax_included: false disclaimers: - description: FUEL POLICY IS FULL TO FULL - description: 15 UKL/DY LATE FEE MAY APPLY availability_error_response: title: Availability Error Response description: A container for the error details required: - request_time - errors - request_errors type: object properties: request_time: format: date-time description: The time stamp of the request type: string request_errors: description: The number of errors that occurred type: integer errors: title: Errors Details description: The following describes the elements that can appear in the response body of an error. type: array items: $ref: '#/components/schemas/error' insurance_name: title: Insurance Name description: Name of the insurance coverage code/type. enum: - Additional Liability Insurance - Collision Damage Waiver - Loss Damage Waiver - Personal Accident Insurance - Additional Protection Insurance - Personal Effects Protection - Super Collision Damage Waiver - Super Personal Accident Insurance - Super Theft Protection - Theft Protection - Package Protection type: string example: Collision Damage Waiver vehicle_class_code: title: Vehicle Class Code description: The vehicle class code used to identify individual cars and trucks according to size, axle numbers and type. type: string example: A, AB, XA quote_id: title: Quote Identifier description: A unique identifier representing a specific rate quote. This ID is required for re-shop and booking requests to retain the originally quoted rate. type: string example: abc123xyz-456def789-ghijk012 rental_experience: title: Rentalexperience description: Defines the rental experience type and associated details. required: - type type: object properties: type: description: Indicates the type of rental experience. Controlled vocabulary for consistency across APIs. type: string example: AvisFirst benefits: description: Collection of benefits and premium services included with the rental experience. type: array items: type: string example: - Curbside vehicle delivery by a personal concierge. - 2025 model year vehicles with low mileage. - Chat with your personal concierge for any in-trip issues. - Skip the pump — pay only for fuel used, at market price. - Curbside drop-off with your concierge. code: description: Avis First location code, returned only when type = AvisFirst. Matches vendor location code format type: string central_billing_membership: title: Brand Membership description: Central billing account profile identification information. type: object properties: code: description: Corporate membership code for central billing account profile. type: string example: M21R322 transmission: title: Vehicle Transmission description: The transmission of the vehicle. enum: - Automatic - Manual type: string example: Automatic rate_code: title: Vehicle Rate Code description: The rental vehicle rate code used to determine the rate of the rental vehicle reservation type: string example: G3 sipp_code: title: Sipp Code description: Standard Interline Passenger Procedure (SIPP) code of the vehicle. A compact 4 door manual air conditioned car will have a SIPP Code CMDR. maxLength: 4 minLength: 4 pattern: ^[A-Z]{4}$ type: string example: CMDR brand: title: Brand description: ABG supported brand names like Avis, Budget, or Payless enum: - Avis - Budget - Payless type: string example: Avis totals: title: Reservation Totals description: The total reservation rate, taxes and fees for the entirety of the reservation. type: object properties: reservation_total: description: Total cost of the reservation. type: number taxes_fees_total: description: Total cost of the combined taxes and fees for the reservation. type: number taxes_total: description: Total cost of taxes. type: number vehicle_total: description: Total cost of the rental vehicle. type: number fees_total: description: Total cost of fees. type: number extras_total: description: Total cost of the specified ancillary products (such as GPS). type: number insurance_total: description: Total cost of the specified rental insurance coverage. type: number discount_total: description: Total discount to be applied to the total cost in reservation_total. type: number example: 7 netvoucher_total: description: Total Net Voucher Amount type: number example: reservation_total: 58.41 taxes_fees_total: 40.2 taxes_total: 99.39 vehicle_total: 15.16 fees_total: 34.98 extras_total: 77.68 insurance_total: 90.37 discount_total: 74.95 availability_rate_request: title: Availability Rate Request description: The reservation rate qualifiers that determine the rate of the reservation in the localized currency. required: - rate_code - country_code type: object properties: rate_code: $ref: '#/components/schemas/rate_code' currency: $ref: '#/components/schemas/currency' country_code: description: 2-character ISO 3166 customer country code. maxLength: 2 minLength: 2 type: string loyalty: $ref: '#/components/schemas/availability_loyalty' discount: $ref: '#/components/schemas/discount' membership: $ref: '#/components/schemas/availability_membership' coupon: $ref: '#/components/schemas/coupon' central_billing_membership: $ref: '#/components/schemas/central_billing_membership' quote_id: $ref: '#/components/schemas/quote_id' rate_guarantee_blob: $ref: '#/components/schemas/rate_guarantee_blob' insurance: title: Rental Insurance Coverage description: The insurance coverage to be applied to the entirety of the reservation. Types of insurance includes Cover The Car (CDW), Cover My Liability (ALI), Cover Myself (PAI), and Cover My Belongings (PEP), Package (PKG). If insurance coverage is specified in the request, taxes are included in the total cost (in total_owed). Any preselected insurance coverage specified by a user within their wizard profile should be passed in the request. For example, if the user has selected Cover My Belongings (PEP) in their profile, then pass PEP. type: object properties: code: $ref: '#/components/schemas/insurance_code' name: $ref: '#/components/schemas/insurance_name' amount: description: The daily cost of the specified insurance coverage. type: number excess_amount: description: The insurance excess amount available as a part of the coverage. type: number currency: $ref: '#/components/schemas/currency' total_owed: description: Total owed of the specified insurance coverage for the entirety of the reservation. type: number secondary_amount: description: The daily cost of the specified insurance coverage. type: number secondary_excess_amount: description: The insurance excess amount available as a part of the coverage. type: number secondary_currency: $ref: '#/components/schemas/currency' secondary_total_owed: description: Total owed of the specified insurance coverage for the entirety of the reservation. type: number included_in_rate: description: Indicates whether price of Insurance product is included in reservation_total. type: boolean example: true selection_note: $ref: '#/components/schemas/insurance_selection_note' selected: description: Indicates whether insurance coverage has been selected by the user for the reservation. If the specified insurance coverage is accepted, a value of ACCEPTED will be returned in selection_note. type: boolean example: true tax_included: description: Indicates whether taxes are included in the cost (in total_owed). type: boolean example: true vehicle_status: title: Vehicle Status description: Vehicle Status Information. enum: - OnRequest - Available type: string example: Available distance: title: Reservation Distance Limitations description: Information about rental vehicle reservation distance options and limitations. If a reservation includes limited distance, then the distance covered is returned in distance_covered and the rate if the distance is exceeded is returned in distance_overage. required: - unlimited_distance - distance_unit type: object properties: unlimited_distance: description: Indicates whether the reservation distance is unlimited. type: boolean example: true distance_covered: description: The free distance covered for the duration of the rental period. type: number example: 500 distance_unit: description: The unit of distance. type: string example: miles distance_overage: description: The cost per distance unit if the free distance in distance_covered is exceeded. type: number example: 0.15 discount_code: title: Discount Code description: The rental vehicle brand discount code. This field can be an Avis Worldwide Discount (AWD), Budget Car Discount (BCD), or a Payless Discount Number (PDN) code. type: string example: R566100 insurance_selection_note: title: Insurance Selection Note description: Indicates whether rental vehicle insurance coverage is included by DEFAULT (as applicable in select countries), or whether additional coverage specified by the user has been ACCEPTED, or DECLINED. There may be some countries that include the cost of insurance by DEFAULT. If a value of DEFAULT is returned, then the value in total_owed will be 0. If the user specifies additional insurance coverage, then the value in this field will be returned as ACCEPTED or DECLINED. enum: - DEFAULT - ACCEPTED - DECLINED type: string example: DEFAULT tax: title: Tax description: Taxes applied to the reservation in the localized currency. type: object properties: type: description: The type of taxation to be applied. type: string amount: description: The cost of taxes for the reservation. type: number included_in_total: description: The flag to indicate whether the fees or charges are included in the Total Reservation cost. type: boolean availability_rate_response: title: Availability Rate Response description: The reservation qualifiers that determine the rate of the reservation in the localized currency. required: - rate_code type: object properties: rate_code: $ref: '#/components/schemas/rate_code' country_code: description: 2-character ISO 3166 customer country code. maxLength: 2 minLength: 2 type: string loyalty: $ref: '#/components/schemas/availability_loyalty' discount: $ref: '#/components/schemas/discount' membership: $ref: '#/components/schemas/availability_membership' coupon: $ref: '#/components/schemas/coupon' currency: $ref: '#/components/schemas/currency' days: description: The number of days of the reservation. type: number hours: description: The number of hours of the reservation (after days). type: number amount: description: The reservation rate of the rental vehicle. type: number coupon_applied: description: Indicates that a coupon discount was successfully applied for the reservation. type: boolean coupon_discount_amount: description: The amount of the coupon discount applied to the cost of the reservation. type: number taxes_fees: $ref: '#/components/schemas/taxes_fees' under_age_fee_applied: title: Under Age Fee description: This field indicates the young driver fee applicability to the vehicle rate. This field is applicable only for Best Buy API. type: boolean rate_type: $ref: '#/components/schemas/rate_type' quote_id: $ref: '#/components/schemas/quote_id' coupon_type: title: Coupon Type description: The type of coupon that corresponds to the coupon code. enum: - MoneyOff - GasOff - DaysOff - Upgrade type: string example: Upgrade product: title: Product Brand description: The rental car product brand name information for the reservation. required: - brand type: object properties: brand: $ref: '#/components/schemas/brand' iata_number: $ref: '#/components/schemas/iata_number' availability_loyalty: title: Availability Loyalty Program description: The Frequent Traveler Program (FTP) to be applied to the reservation. This entitles the user the opportunity to earn miles or points with ABG partners, such as airlines, hotels and other select companies. For example, the Lufthansa Miles & More Rewards Program. Surcharges may apply. type: object properties: company_id: description: The Frequent Traveler Program identifier of the airline, hotel, or other select company. type: string example: AD code: description: The unique Frequent Traveler Program (FTP) number of the traveler. type: string example: M21R322 example: company_id: some text code: some text reservation_rate_request: title: Reservation Rate Request description: Reservation information for the rental vehicle reservation, including the pickup, dropoff, and vehicle class. required: - pickup_date - pickup_location - dropoff_location - dropoff_date - vehicle_sipp_code type: object properties: email_notification: description: Indicates the email notifications for create, modify and cancel can be sent or suppressed for a user. type: boolean example: true pickup_date: description: ISO 8601 date and time of pickup. type: string example: '2017-11-15T18:00:00.000Z' pickup_location: description: Rental car pickup location code. type: string example: EWR dropoff_date: description: ISO 8601 date and time of dropoff. type: string example: '2017-11-15T18:00:00.000Z' dropoff_location: description: Rental car dropoff location and address information. type: string confirmation: $ref: '#/components/schemas/availability_confirmation' special_fields: $ref: '#/components/schemas/availability_special_fields' vehicle_sipp_code: description: '' type: string vehicle_status: $ref: '#/components/schemas/vehicle_status' rental_experience: $ref: '#/components/schemas/rental_experience' availability_confirmation: title: Availability Confirmation description: Basic confirmation details for the rental vehicle reservation. required: - number type: object properties: number: description: The confirmation number of the reservation. type: string example: 09369988GB2 pickup_date: description: ISO 8601 date and time of pickup. type: string example: '2017-11-15T18:00:00' dropoff_date: description: ISO 8601 date and time of dropoff. type: string example: '2017-11-17T18:00:00' availability_special_fields: title: Special Fields description: Additional information for the rental vehicle reservation. type: object properties: cost_control: description: Also known as CCI. This field is used to store cost control information from a travel order, purchase order number or company reference. type: string company_name: description: Name of renter’s company or employer. type: string remark: description: This field is used to indicate additional information or special requests applicable to the rental. maxLength: 25 type: string member_code: description: Partner's member code. maxLength: 20 type: string transaction_id: title: Transaction Identifier description: The transaction identifier used to identify and troubleshoot a given request. type: string example: 391117cf-4470-4353-8b51-f00c3c098943 discount: title: Brand Discounts description: The rental vehicle brand rewards program code (also known as discount code) to be applied to the rate of the reservation. type: object properties: code: $ref: '#/components/schemas/discount_code' example: R566100 dropoff_location: title: Dropoff Location description: Rental car dropoff location and address information. required: - address type: object properties: location: $ref: '#/components/schemas/location' address: $ref: '#/components/schemas/address' error: title: Error description: The following describes the elements that can appear in the response body of an error. required: - code - details - message - reason properties: code: description: The error code value type: string message: description: The HTTP status code message type: string reason: description: The reason the request has failed type: string details: description: Description of the error type: string vehicle_best_buy: title: Rental Vehicle Best Buy description: Identifying information about the vehicle, including vehicle category (make/model), features, luggage capacity and the total cost. required: - capacity - category - features - rate_totals type: object properties: category: $ref: '#/components/schemas/availability_vehicle_category' rental_experience: $ref: '#/components/schemas/rental_experience' features: $ref: '#/components/schemas/vehicle_features' capacity: $ref: '#/components/schemas/vehicle_capacity' rate_totals: $ref: '#/components/schemas/availability_rate_totals_response' secondary_rate_totals: $ref: '#/components/schemas/availability_rate_totals_response' distance: $ref: '#/components/schemas/distance' taxes_fees: title: Rental Taxes and Fees description: All available rental taxes and fees applied to the reservation. type: object properties: taxes: title: Rental Taxes description: Taxes applied to the reservation in the localized currency. type: array items: $ref: '#/components/schemas/tax' fees: title: Fees description: Fees applied to the reservation. All available fees and surcharges are returned in the response. Some of these fees are included in the rate, and others are for information purposes only, as they may apply but are not included in the total tax amount. type: array items: $ref: '#/components/schemas/fee' coupon: title: Coupon Codes description: A promotional coupon that can be applied to a reservation for discounts, upgrades, free days, or other promotional offers. required: - code type: object properties: code: description: The coupon code to be applied to the reservation rate. type: string example: MUZZ014 type: $ref: '#/components/schemas/coupon_type' quantity: title: Quantity description: The number of coupon codes to apply to the reservation. type: number example: 1 coupon_applied: title: Coupon Applied Flag description: Indicates that a coupon code is valid and was successfully applied for the reservation. type: boolean example: false coupon_amount: description: The amount of the coupon discount applied to the cost of the reservation. type: number example: 0 secondary_coupon_amount: description: The secondary amount of the coupon discount applied to the cost of the reservation. type: number example: 0 coupon_extras: $ref: '#/components/schemas/extras' description: description: Description of the coupon code that was specified in the request. type: string example: code: some text type: Upgrade quantity: 13.21 coupon_applied: true coupon_amount: 90.01 coupon_extras: - - type: Upgrade code: XMR quantity: 24.64 amount: 6.1 total_owed: 68.22 - type: DaysOff code: BBS quantity: 10.33 amount: 12.95 total_owed: 46.59 - - type: DaysOff code: ADR quantity: 17.09 amount: 38.26 total_owed: 98.75 - type: Upgrade code: SNW quantity: 24.2 amount: 53.96 total_owed: 3.34 description: some text pay_total: title: Pay Total description: The total reservation rate, taxes and fees for the entirety of the reservation. This object is applicable only for Best Buy API. type: object properties: extras_total: description: Total cost of the specified ancillary products (such as GPS). type: number fees_total: description: Total cost of fees. type: number original_reservation_total: description: Original total cost of the reservation. type: number taxes_fees_total: description: Total cost of the combined taxes and fees for the reservation. type: number vehicle_total: description: Total cost of the rental vehicle. type: number taxes_total: description: Total cost of taxes. type: number reservation_total: description: Total cost of the reservation. type: number insurance_total: description: Total cost of the specified rental insurance coverage. type: number example: 7 original_vehicle_total: description: Original total cost of the rental vehicle. type: number netvoucher_total: description: Total Net Voucher Amount type: number rate_code: $ref: '#/components/schemas/rate_code' additionalProperties: true fuel_type: title: Fuel Type description: Indicates the vehicle fuel type. enum: - Diesel - Petrol - Hybrid - Electric type: string example: diesel success_status: title: Success Status description: Success Status object required: - request_time - success type: object properties: request_time: format: date-time description: The time stamp of the request type: string success: description: Success Details type: array items: $ref: '#/components/schemas/success_detail' rate_totals_request: title: Rate Totals Request description: The fees, rates, and discounts applied to the reservation, with a breakdown of the reservation total. required: - rate type: object properties: requested_rate_currency: $ref: '#/components/schemas/requested_rate_currency' rate: $ref: '#/components/schemas/availability_rate_request' totals: $ref: '#/components/schemas/totals' pickup_location: title: Pickup Location description: Rental car pickup location and address information. required: - address type: object properties: location: $ref: '#/components/schemas/location' address: $ref: '#/components/schemas/address' availability_customer: title: Availability Customer description: Information about the rental car customer. Only one customer can be specified in the request. properties: contact: $ref: '#/components/schemas/availability_contact' driver: $ref: '#/components/schemas/driver' address: $ref: '#/components/schemas/address' product_code: title: Product Code description: The rental ancillary code used to identify and add rental vehicle equipment and features to the reservation (such as GPS). enum: - CEL - BKR - LGR - SKR - HIT - CIS - CSS - CBS - SNC - GPS - STR - CFS - DVD - FPD - TRO - CLB - SAT - SBR - AET - WFI - CNP - TOL - STD - HDL - TLR - CCP - ACD - RSN - BXL - BXM - BXS - MPG - SNW - TPR - RSP - ATC - VTD - ATP - WTC - GWB - VRD - ADD - VSS - ADR - APD - TAB - KTM - MMP - BTH - BBS - STA - STB - STC - AFO - AFS - AYD - BAT - BKF - BLK - BOB - BOX - CCO - CHD - CHG - CON - CSB - CSD - CST - DCF - DEC - DIE - DIS - DRO - ELI - ESP - EXT - FP1 - FRZ - FSK - FUD - FUE - FUF - GDW - GEL - GP2 - GPC - GPO - GPW - HOL - INC - IP4 - IP5 - IVM - IXB - KEY - LD0 - LDP - LOG - LTV - MAD - MAP - MAT - MEQ - MLA - MPD - MSC - MVP - NAV - NET - NSF - PAC - PCF - PKT - PKY - PPC - PWC - RLI - RS+ - SCH - SAF - SCS - SCV - SEC - SGU - SIM - SKI - SNT - SPP - SSS - SWT - TCT - TEF - TGD - TGT - TIN - TIP - TIS - TRL - TWW - UAS - UCA - UCH - UPL - USA - USB - UTA - UTD - VHF - WF2 - WLF - WSP - WWF - YAD - FTR - STK - XMR - MCF - MPF - EPU - ESC - CBF - PAT - GTL - EVP - CBD - VCD - OOH type: string example: GPS term: title: Term description: Term required: - method - endpoint - type type: object properties: type: description: Type enum: - location - rental - reservation type: string method: description: '' enum: - GET type: string endpoint: description: End Point to call to get the terms and condition. Host name will be chnaged based on environment type: string example: https://test.abgapiservices.com/terms/v2/location/avis/US/EWR/en_US example: type: reservation method: GET endpoint: https://test.abgapiservices.com/terms/v2/location/avis/US/EWR/en_US availability_extra: title: Availability Extra description: The ancillary products, special equipment, and other extras selected as part of reservation. type: object properties: type: $ref: '#/components/schemas/product_type' description: description: Product description. This field is supported in BB and Featured BB API. type: string code: $ref: '#/components/schemas/product_code' quantity: description: 'The number of ancillary products to add to the reservation. For example, if a value of 2 is specified for quantity, and a code of CSS, then two child safety seats will be added to the reservation. The products that allow multiple quantity is: ADD/ADR, CBS/CSS, CIS, GPS, SAT, XMR, WFI, TAB, RSN, ATP with a maximum quantity of 3 each. All other products are maximum of 1.' default: 1 minimum: 0 type: number amount: description: The price of the ancillary product. type: number example: 19.99 currency: $ref: '#/components/schemas/currency' tax_amount: description: The tax of the ancillary product. type: number total_owed: description: The total price of the ancillary product for the entirety of the reservation period. type: number example: 19.99 secondary_amount: description: The price of the ancillary product. type: number example: 19.99 secondary_currency: $ref: '#/components/schemas/currency' secondary_tax_amount: description: The tax of the ancillary product. type: number secondary_total_owed: description: The total price of the ancillary product for the entirety of the reservation period. type: number example: 19.99 included_in_rate: description: Indicates whether price of Extra product is included in reservation_total. type: boolean example: true max_allowed_quantity: description: This field is applicable only for BB and featured BB APIs. Refers to maximum counter products that are allowed per reservation. type: number pickup_type: description: Indicates whether the counter product should be picked at counter, installed on the device or no pick up required. enum: - NO_PICKUP_REQUIRED - COUNTER_PICKUP - INSTALLED_ON_VEHICLE type: string tax_included: description: Indicates whether taxes are included in the cost (in total_owed). type: boolean address: title: Customer Address description: Address information that you would like to associate to the user that is requesting the rental vehicle reservation, including geographic coordinates (if applicable). required: - country_code type: object properties: address_line_1: description: Address (line 1) of the user. type: string example: 1534 Meadow Drive address_line_2: description: Address (line 2) of the user. type: string example: 2nd Floor address_line_3: description: Address (line 3) of the user. type: string example: Suite 235 city: description: City name of the user. type: string example: Boston state_name: description: State name of the user (if applicable). type: string example: Massachusetts postal_code: description: Numeric or alphanumeric postal code of the user, which varies by country (02128 or CT3). type: string example: W16PR country_code: description: 2-letter ISO 3166 country code of the user. maxLength: 2 minLength: 2 type: string example: US lat: description: Geographic latitude of the location. type: string example: '40.690022' long: description: Geographic longitude of the location. type: string example: '-74.187506' best_buy_response: title: Car Availability Best Buy Response description: The following demonstrates an example of a successful request for this endpoint. required: - status - transaction - product - reservation - vehicles type: object properties: status: $ref: '#/components/schemas/success_status' transaction: $ref: '#/components/schemas/transaction' product: $ref: '#/components/schemas/product' vehicles: title: Rental Vehicle Information description: Identifying information about the vehicle, including vehicle category (make/model) features, luggage capacity and the total cost. type: array items: $ref: '#/components/schemas/vehicle_best_buy' reservation: $ref: '#/components/schemas/bb_reservation_response' example: status: request_time: '2018-10-25T12:01:54Z' success: - code: '200' message: Success details: The vehicle availability was successfully retrieved. transaction: transaction_id: '12313' product: brand: Avis vehicles: - category: name: Group A - Ford Fiesta or similar make: Ford model: Fiesta sipp_code: CDAD vehicle_class_code: A vehicle_class_name: Economy vehicle_transmission: Automatic mpg: 27/35 image_url: https://www.avis.com/content/dam/cars/l/2019/chevrolet/2019-chevrolet-cruze-premier-sedan-white.png features: bluetooth_equipped: false smoke_free: true air_conditioned: false connected_car: false capacity: doors: '4' seats: '5' luggage_capacity: large_suitcase: '1' rate_totals: rate: currency: USD rate_code: DH coupon_applied: true under_age_fee_applied: true coupon_discount_amount: 25 pay_later: vehicle_total: 182 reservation_total: 212.2 original_vehicle_total: 217 original_reservation_total: 235.46 discount: code: R566100 coupon: code: MUZZ014 type: MoneyOff description: 25USD Off with Rental of CSS/Paperless Coupon quantity: 1 coupon_extras: - code: CSS type: COUNTER_PROD reservation: pickup_location: location: code: LHR name: Newark Liberty Intl Airport telephone: (1) 973-961-4300 hours: Sun-Sat 0:00 AM - 12:00 AM and 0:00 AM - 12:00 AM airport_location: true address: address_line_1: 28 Newark Airport city: Newark state_name: New Jersey postal_code: '07114' country_code: US lat: '40.690022' long: '-74.187506' dropoff_location: location: code: LHR name: London Heathrow Airport T234 telephone: (44) 3445446000 airport_location: true address: address_line_1: Central Heathrow Loc address_line_2: Northrop Rd address_line_3: Na city: London state_name: New Jersey postal_code: TW6 2QA country_code: GB terms: - type: location method: GET endpoint: https://docs.abgcarrental.com/location/avis/UK/UK/en/ - type: rental method: GET endpoint: https://docs.abgcarrental.com/rental/avis/UK/en/?rentalCountry=UK disclaimers: - type: Underage Surcharge description: Under Age restrictions and fees apply. Please review location terms and conditions or contact location to confirm rental policies and fees. url: title: URL description: HTTP/HTTPS endpoint. pattern: ^https?://.* type: string example: https://www.avis.com/content/dam/cars/l/2017/ford/2017-ford-mustang-v6-coupe-black.png iata_number: title: IATA Number description: International Air Transport Association (IATA) number. This is an identifier used by travel agents that allows the rental car company to pay the agent a commission for the rental. type: string example: '91212019' error_403: title: Error 403 description: Forbidden required: - request_time - errors - request_errors type: object properties: request_time: format: date-time description: The time stamp of the request type: string request_errors: description: The number of errors that occurred type: integer errors: title: Errors Details description: The following describes the elements that can appear in the response body of an error. type: array items: $ref: '#/components/schemas/error' luggage_capacity: title: Luggage Capacity type: object properties: large_suitcase: description: The number of large suitcases that can be accommodated in the rental vehicle. type: string small_suitcase: description: The number of small suitcases that can be accommodated in the rental vehicle. type: string success_detail: title: Success Detail description: A container for the success/error details. required: - code - message - details properties: code: description: The HTTP status code value type: string message: description: The HTTP status code message type: string details: description: Description of the success status type: string extras: title: Rental Extras description: The ancillary products, special equipment, and other extras selected as part of reservation. type: array items: $ref: '#/components/schemas/availability_extra' availability_rate_totals_response: title: Availability Rate Totals description: The fees, rates, and discounts applied to the reservation, with a breakdown of the reservation total. required: - rate type: object properties: rate: $ref: '#/components/schemas/availability_rate_response' totals: $ref: '#/components/schemas/totals' pay_later: $ref: '#/components/schemas/pay_total' pay_now: $ref: '#/components/schemas/pay_total' currency: title: Currency description: Currency used for defining the amounts. type: string example: EUR bb_reservation_response: title: Best Buy Reservation description: Confirmation information for the rental vehicle reservation, including the rate, distance limitations, and rental extras (such as GPS). required: - pickup_location - dropoff_location type: object properties: distance: $ref: '#/components/schemas/distance' pickup_location: $ref: '#/components/schemas/pickup_location' dropoff_location: $ref: '#/components/schemas/dropoff_location' terms: description: Terms and Condition type: array items: $ref: '#/components/schemas/term' disclaimers: description: Disclaimers. type: array items: $ref: '#/components/schemas/disclaimer' brand: $ref: '#/components/schemas/brand' location: title: Rental Location description: Rental car address information of the product location. type: object properties: code: description: 3-5 character alphanumeric location or airport code. type: string example: BOS name: description: Name of the product location. type: string example: Boston Logan Intl Airport telephone: description: Phone number of the product location. type: string example: 617-568-6600 hours: description: Operating hours of the product location. type: string example: Sun-Sat 0:00 AM - 12:00 AM and 0:00 AM - 12:00 AM airport_location: description: Indicates whether the product location is an airport. type: boolean example: true insurance_code: title: Insurance Code description: 3-character code of the insurance coverage. enum: - ALI - CDW - LDW - PAI - LI - PEP - SCDW - SPAI - STP - TP - PKG type: string example: CDW car_availability_rate_request: title: Rate Request description: The following demonstrates an example of a successful request for this endpoint. required: - rate_totals - product - reservation type: object properties: transaction: $ref: '#/components/schemas/transaction' product: $ref: '#/components/schemas/product' reservation: $ref: '#/components/schemas/reservation_rate_request' rate_totals: $ref: '#/components/schemas/rate_totals_request' extras: $ref: '#/components/schemas/extras' customer: $ref: '#/components/schemas/availability_customer' insurance: description: '' type: array items: $ref: '#/components/schemas/insurance' example: transaction: transaction_id: '12313' product: brand: Avis reservation: pickup_date: '2022-06-21T10:00:00' pickup_location: LHR dropoff_date: '2022-06-28T10:00:00' dropoff_location: LHR vehicle_sipp_code: MBMR rate_totals: rate: country_code: GB rate_code: IC discount: code: R566100 membership: code: B0876Z coupon: code: MUZZ014 insurance: - code: CDW extras: - code: GPS quantity: 1 driver: title: Driver License description: The driver license information of the user, including license number, issuing country, and date of birth. type: object properties: license_number: description: Driver license number. type: string state_code: description: 2-letter state code. For US country, valid combination of country and state code. For non-US country, XX is valid value. type: string example: TX country_code: description: 2-letter ISO 3166 country code. maxLength: 2 minLength: 2 type: string example: GB license_verified: description: Indicates the authenticity of the passenger's driving license. type: boolean reservation_availability: title: Reservation Availability description: Confirmation information for the rental vehicle reservation, including the rate, distance limitations, and rental extras (such as GPS). required: - pickup_location - dropoff_location - rate_totals type: object properties: distance: $ref: '#/components/schemas/distance' pickup_location: $ref: '#/components/schemas/pickup_location' dropoff_location: $ref: '#/components/schemas/dropoff_location' insurance: description: Rental Insurance Coverage type: array items: $ref: '#/components/schemas/insurance' extras: $ref: '#/components/schemas/extras' terms: description: Terms and Condition type: array items: $ref: '#/components/schemas/term' disclaimers: description: Disclaimers type: array items: $ref: '#/components/schemas/disclaimer' brand: $ref: '#/components/schemas/brand' rate_totals: $ref: '#/components/schemas/availability_rate_totals_response' secondary_rate_totals: $ref: '#/components/schemas/availability_rate_totals_response' rental_experience: $ref: '#/components/schemas/rental_experience' rate_guarantee_blob: title: Rate Guarantee Binary Large Object description: A Rate Guarantee blob that represents the guaranteed rate associated with the booking. type: string example: Y| 365 B DFW12004020900DFW1200403090012004011204 75 1501050 150 75 7351 9800 68600 294000 9800 7351 2A GA 1 NNNNNNNNNYNNNNNNNYNYNNNNNNNNNNNNYYYNNNNNNNNNNNNN 130 30NNNNNNNN NNNNNNNNNNNNNNNN NNNNNNNNUSD 12 000NYNNNNNN availability_membership: title: Availability Membership description: The customer membership information. type: object properties: code: description: The membership program code, such as an Avis Wizard number, Budget customer number, or Payless Perks number. type: string example: W4S322 partner_membership_code: description: The customer's membership code for an associated partner program. type: string partner_membership_loyalty_level: description: The loyalty level or status in the partner membership program. type: string benefits_applied: description: Indicates whether the partner membership benefits are applied. type: string description: description: Details of the membership, acknowledging the benefits associated. type: string rate_type: title: Rate Type description: The Rate type representing the Corporate vs Leisure rates enum: - CORPORATE - LEISURE type: string vehicle_features: title: Vehicle Features description: Vehicle equipment and available features (such as bluetooth connectivity). properties: bluetooth_equipped: description: Indicates that the rental vehicle is equipped with bluetooth connectivity. type: boolean example: true smoke_free: description: Indicates that the rental vehicle is a smoke-free vehicle. type: boolean example: true air_conditioned: description: Indicates that the rental vehicle is air conditioned. type: boolean example: true connected_car: description: Indicates that the rental vehicle is equipped with Connected Car technology (which generally includes Internet access and a wireless local area network). type: boolean example: true product_type: title: Product Type description: The type of ancillary product specified in the request. If a code of child safety seat (CSS) is specified in the request, then a value of SPEC_EQUIP will be returned in the response. enum: - COUNTER_PROD - SPEC_EQUIP - UPSELL type: string example: COUNTER_PROD parameters: brand: name: brand description: The Avis, Budget, or Payless brand name. schema: enum: - Avis - Budget - Payless type: string in: query required: true client_id: name: client_id description: Your client identifier. schema: maxLength: 50 minLength: 8 type: string in: header required: true securitySchemes: ABG-Access-Token: type: oauth2 description: OAuth 2.0 client credentials flow used to authenticate all API requests in this package. flows: clientCredentials: tokenUrl: https://stage.abgapiservices.com/oauth/token/v2 scopes: {} x-api-owner: team: Partner API Team email: - EnterpriseAPISupport@avisbudget.com - partner-api@avisbudget.com