HQ Rental Software
Reservations
Copy Page
HQ Rental Software
Authorization
Introduction
Guides
Booking Engine
Reservation Creation Flow
Reservation Update Flow
Toll Integration
Toll Integration Flow
Car Rental
Comments
Show a list of all the comments for an item
Creates a new comment
Updates a comment
Delete comment
Get Reservation comments
Update Reservation comments
Deletes a comment
Currencies
Returns all the currencies
Emails
Show a list of all email templates
Trigger an email template
Send reservation confirmation email by id
Send reservation contract email by id
Show a list of all applicable email templates for a reservation
Trigger an email template for a reservation
Store a quote and sends an email
Addresses
Shows a list of addresses
Create address
Finds address by id
Updates address by id
Delete address
Fields
Show a list of all fields for specific item_type
Show details of specific field
Show details of specific field
Show a list of all fields applicable for the customers in the reservations process
Blocked Days
List all blocked days
Customer Credits
List all credit transactions
Create a customer credit
Delete a credit transaction
Update a customer credit
Daily Manifest
shows mine dashboard
Fines
List all fines
Create a fine
Retrieve a fine
Update a fine
Deletes a fine
Packages
Shows a list of available package items
find a package item
Shows a list of available packages
find a package
Quotes
Shows a list of the reservation quotes in the system
Find a quote that matches the given ID
Rate Types
List all rate types
Updates a rate type
Creates a rate type
Find a specific rate type
Deletes a rate type
Rates
List all rates
Updates a rate
Creates a rate
Find a specific rate
Deletes a rates
List all rates v2
Reservation Attempts
Shows a list of reservation attempts
Find the reservation attempts based on a given email
Extensions
Show a list of all the extensions for a reservation
Creates an extension for one reservation
Deletes an extension
External Charges
Show a list of all the external charges for a reservation
Creates an external charge for one reservation
Deletes an external charge for one reservation
Adjustments
Show a list of all the adjustments made to a reservation
Creates an adjustment for one reservation
Deletes and adjustment for one reservation
Payments
Show a list of all the payments for a reservation
Creates a payment for one reservation
Updates a payment for one reservation
Initiate a refund of security deposit
Charges a credit card from customer's reservation
Refunds
Show a list of all the refunds for a reservation
Creates a refund for a reservation
Updates a refund for a reservation
Deletes a refund for a reservation
Reservations
Updates the status of a reservation to Open
POST
Updates the status of a reservation to Cancel
POST
Updates the status of a reservation to Pending
POST
Updates the status of a reservation to Quote
POST
Updates the status of a reservation to No Show
POST
Returns the details and validations required for the dates step
GET
Validates the dates and return a list of available classes for that period with the respective prices for each vehicle class
POST
Updates the vehicle class of a reservation (Only Existing Bookings)
POST
Returns a list of applicable additional charges based on the selection of dates, brand and vehicle class
GET
Returns the price for the selection of charges and vehicle class
POST
Creates or updates a customer in the system
POST
Confirms and create the reservation in the system
POST
Updates a reservation
POST
shows a list of reservations
GET
show rental agreement of specific reservation
GET
Set date of sign
GET
Find a specific reservation
GET
Assign vehicle
POST
Detach vehicle
POST
Available Vehicles
GET
Upload primary driver signature
POST
Returns the available cars for a given location and reservation date range
GET
Vehicle Replacements
Shows all vehicle replacements from a reservation
Creates a reservation vehicle replacement
Updates a reservation vehicle replacement
Deletes vehicle replacements from a reservation
Reservation Agents
Shows a list of available agents
Assign primary agent
Assign return agent
Seasons
Shows a list of available seasons
Creates a season
Find a specific season
Updates a season
Deletes a season
Security Deposits
Shows a list of security deposits
Shows an specific security deposit
Webhooks
Register a webhook
Filters
Returns an example of the allowed filters to the API
Preferences
Show a list of all preferences per module
Contacts
List all contact categories
List a specific contact category
List all contacts of a specific contact category
Create a new contact in the application.
List a specific contact
Update a contact in the application.
Merge contacts
Fleets
Additional Charges
Shows a list of the additional charges
Returns a single additional charge
Features
Shows a list of features
Returns a single feature
Locations
Shows a list of locations
Blocked Periods
Shows a list of blocked periods for a vehicle
Create a blocked period for a vehicle
Update a blocked period for a vehicle
Deletes a blocked period
Branches
Shows a list of Vehicle Brands
Returns a single vehicle brand
Damages
Shows a list of vehicle damages
Create a damage for a vehicle
Show the details of a specific vehicle damage
Update a damage for a vehicle
Vehicles
Models
Shows a list of Vehicle Models
Returns a single vehicle model
Types
Shows a list of Vehicle Types
Returns a single vehicle type
Shows a list of vehicles
Show the details of a specific vehicle
Update Vehicle
Reserve vehicle
Cancel Reserve
Relocations
Shows a list of relocations
Create a relocation for a vehicle
Deletes a relocation
Telematics
Shows a list of the OBD history records of the vehicle
Shows a list of the OBD history records for all vehicles, receives a paramter with the last ID retrie ved and it returns all the records after that one
Shows a list of vehicle trips for the specified vehicle
Payment Gateways
Shows a list of credit cards for one customer
Delete payment gateway
Shows a list of payment methods
Finds payment method by ID
Returns payment method button
Returns payment method form
Finds payment transaction by UUID
shows a list of payment transactions
Create payment transaction
Refunds a payment transaction
Shows a list of stripe locations per gateway
Returns a connection token for a given location
Returns a connection token for stripe terminal
Sheets
Show a list of all items for specific sheet
Show details of sheet item
Update sheet item in the application
Create a new sheet item in the application
Show a list of all sheets
Show a list of all sheets
Files
Shows a list of files
upload file
Delete file
Reservations
Copy Page
Updates a reservation
POST
/car-rental/reservations/{id}/update
Run in Apidog
Run in Apidog
Request
Path Params
Generate Code
reservation_id
required
Reservation ID
id
string
Â
required
Query Params
Generate Code
pick_up_date
optional
Pick up date of the reservation. Format: yyyy-mm-dd
return_date
optional
Return date of the reservation. Format: yyyy-mm-dd
pick_up_time
optional
Pick up time of the reservation. Format: HH:ii
return_time
optional
Return time of the reservation. Format: HH:ii
flight_arrival_date_date
optional
Flight arrival date. Format: HH:ii
flight_arrival_date_time
optional
Flight arrival time. Format: HH:ii
flight_departure_date_date
optional
Flight departure date. Format: HH:ii
flight_departure_date_time
optional
Flight departure time. Format: HH:ii
flight_number
optional
Flight number
flight_departure_number
optional
Flight departure number
flight_departure_airline
optional
Flight departure airline
pick_up_location
optional
Pickup location
return_location
optional
Return location
vehicle_class_id
optional
Vehicle Class
customer_id
optional
Customer
primary_driver_id
optional
Primary Driver
additional_charges
array
[string]
optional
Additional charges
Allowed values:
id_quantity
id
add_discount
optional
Flag to set you are adding a discount coupon code
manual_discount
optional
Manual discount amount or percentage value
manual_discount_is_percentage
optional
Set to true if manual_discount is a percentage value
remove_discount
optional
Flag to set you are removing a discount coupon code
remove_all_discounts
optional
Flag to set you are removing all discounts
coupon_code
optional
Coupon code
additional_drivers
array
[integer]
optional
Additional drivers - id
currency
optional
Currency
free_upgrade
optional
Free Upgrade
first_name
optional
Customer First name
last_name
optional
Customer Last name
gender
optional
Customer Gender
email
optional
Customer Email
phone_number
optional
Customer Phone number
city
optional
Customer City
state
optional
Customer State
zip
optional
Customer Zip
street
optional
Customer Street Address
street2
optional
Customer Street Address 2
country
optional
Customer Country Code (ISO alpha-2)
nationality
optional
Customer Country Code (ISO alpha-2)
birthdate
optional
Customer Birthdate. Format: yyyy-mm-dd
Header Params
Generate Code
Authorization
string
Â
required
Default:
{{AUTHENTICATION_TOKEN}}
Responses
🟢
200
OK
successful operation
This response does not have a body.
Modified atÂ
2025-06-27 19:59:36
Previous
Confirms and create the reservation in the system
Next
shows a list of reservations