brand_id, vehicle_class_id from step 3 on, the selected additional_charges from step 4 on, and the driver's customer_age (or customer_birthdate) once you know it.currency and rate_type_id (or rate_code) on every call: a call without them is priced in the defaults, and confirm saves the booking in them.currency other than your default only when your Car Rental settings allow reservations in other currencies and list it in Chargeable Currencies.reservation_attempt_uuid, your own identifier for the visitor's session, on every step.GET /car-rental/reservations/dates?brand_id=1 returns what you need for the first form: pick-up and return locations, their opening hours, default and minimum dates, rental period limits and the age ranges you can send later as customer_age.POST /car-rental/reservations/dates with pick_up_date, pick_up_time, return_date, return_time, pick_up_location, return_location and brand_id validates them against your opening hours and rental rules.availability.selectable true and availability.quantity greater than 0.GET /car-rental/reservations/additional-charges with the booking context and the chosen vehicle_class_id returns the extras, insurances and fees that can be added, with their prices.mandatory true are always included.selected true, are added by HQ on steps 4, 6 and 8 even when you leave them out of additional_charges[].includes_selected_by_default_additional_charges=false (the string false) on those steps and list in additional_charges[] every charge the visitor kept.{id} for an only_one charge, and a key of its dropdown_options ({id}_{quantity}) for a multiple charge.distance_package_rates true is a mileage package: send a key of its distance_package ({id}_{distance}, such as 12_100) instead.{id}, no package is matched and the charge is priced at zero.POST /car-rental/reservations/additional-charges with the booking context and additional_charges[] returns the full price breakdown.data.total holds the total, the amount due and the security deposit, ready for your summary.selected_additional_charges in this response as the final selection.coupon_code; separate several codes with commas.manual_discount, with manual_discount_is_percentage=1 for a percentage, needs the role permission Can add Manual Discount? and is meant for internal tools, not for a public website.GET /car-rental/reservations/fields/customer returns the fields of your customer form, in order, with their label, type and required flag.contact_category_id, the contact category your customers are saved in.success envelope.POST /car-rental/reservations/customer with the booking context and the form values saves the customer and checks the driver against the age and driver's license rules of the vehicle class.first_name, last_name and birthdate by name, and every other field as field_<id> (see Custom fields and item types).contact_entity=person as well, since your website customers are people.data.customer.id: it is the customer_id of the booking.contact_id, a new contact is created on every call, even when a contact with the same email exists.contact_id, or identify the visitor with external_contact_type and external_contact_id from your own system.ignore_empty_fields=1 to keep the ones you do not send.POST /files/upload as multipart/form-data attaches the license image to the customer:filename is required and becomes the file's label.item_type is contacts. followed by the contact_category_id from step 5.item_id is the customer ID from step 6.field_id is the id of the license field in step 5.POST /files/upload.POST /car-rental/reservations/confirm with the booking context, the same additional_charges[] and coupon_code, and customer_id creates the reservation.manual_discount on step 4, send it again with manual_discount_is_percentage: leaving them out saves the booking without the discount.Idempotency-Key header, so that a retry after a timeout does not create a second booking (see Rate limits and idempotency).data.reservation.id.skip_confirmation_email=1 when your website sends its own.skip_confirmation_email applies only to this call: when your settings send the confirmation only once the booking is open, HQ still sends it when the booking is opened later.return_payment_link=1, payment_method_id and payment_external_redirect, the page the customer returns to after paying.data.transaction.payment_link.POST /car-rental/reservations/{reservation_id}/update changes a booking and prices it again.| Change | Send |
|---|---|
| Dates | pick_up_date with pick_up_time, return_date with return_time. A date without its time is ignored. |
| Locations | pick_up_location and return_location, or custom with pick_up_location_custom and return_location_custom. A pick-up location of another branch also needs a vehicle_class_id of that branch. |
| Vehicle class | vehicle_class_id. Add free_upgrade=1 to give the customer the new class at the price of the class they booked. The class must be available and belong to the booking's branch. |
| Extras | additional_charges[] with the full new selection: it replaces the current one, so leave a charge out to remove it. |
| Customer | customer_id of the other contact, in a call of its own. |
| Coupon | add_discount=1 with coupon_code, or remove_discount=1 with coupon_code. When the reservation has a manual discount and the API user's role can add one, resend manual_discount and manual_discount_is_percentage with add_discount=1: leaving them out removes it. |
additional_drivers with the full list of their contact IDs.POST /car-rental/reservations/{reservation_id}/update for the statuses that allow each change.selected_additional_charges and applicable_discounts in the response."success": false, usually with HTTP 200: errors holds the messages per field and errors.error_message all of them, to show the customer (see Errors).Idempotency-Key, so send a new key once the request is fixed.Idempotency-Key already used returns HTTP 422, with the ID of the reservation the first request created in errors.idempotency_value.Idempotency-Key.