POST /cars/search

Use this endpoint to retrieve the available car rentals matching the search criteria.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

X-Affiliate-Id Integer Yes

Include here your Affiliate identifier number

Request body fields

Name Type Required Description
booker Object Yes

Defines the booker context.

booker.country String Yes

The booker country for showing the best price for that user and obeying laws regarding the display of taxes and fees.

filters Object No

Defines the filtering criteria for refining the request results. It allows you to specify various parameters to narrow down the available car rental options based on specific attributes.

filters.transmission_type String No

Filters the results based on the transmission type of the vehicle.

Possible values:

  • "manual"
  • "automatic"
filters.number_of_seats Integer No

Filters the results based on the number of seats in the vehicle. This allows you to specify a vehicle that can accommodate a specific number of passengers.

filters.supplier_ids[] Array No

Filters the results based on the supplier ID of the vehicle. This allows you to retrieve vehicles from specific suppliers. A maximum of 10 supplier IDs can be provided.

filters.car_categories[] Array No

Filters the result based on the selected car category

Possible values:

  • "compact_suvs"
  • "standard_suv"
  • "luxury_suvs"
  • "premium_convertible"
  • "standard_convertible"
  • "standard"
  • "midsize_suvs"
  • "intermediate"
  • "carriers_with_5_plus_2_seats"
  • "standard_van"
  • "suvs"
  • "luxury"
  • "compact_convertible"
  • "compact"
  • "full_size"
  • "carriers_with_6_seats"
  • "carriers_with_12_seats"
  • "carriers_with_8_seats"
  • "carriers_with_10_seats"
  • "carriers_with_7_seats"
  • "carriers_with_9_seats"
  • "carriers_with_11_seats"
  • "special"
  • "carriers_with_5_seats"
  • "full_size_van"
  • "economy"
  • "carriers_with_6_plus_1_seats"
  • "premium"
  • "mini_van"
  • "carriers"
  • "fullsize_suvs"
  • "unknown"
  • "convertible"
  • "pickups"
  • "mini"
  • "estate"
  • "intermediate_suv"
filters.air_conditioning Boolean No

Filters the results to include car rentals with or without air conditioning. Setting this value to true will only return vehicles with air conditioning, while false will exclude them.

filters.depot_location_type String No

Filters the results based on the type of depot location where the vehicle can be picked up or returned.

Possible values:

  • "shuttle_bus"
  • "trainstation"
  • "car_rental_centre"
  • "in_terminal"
  • "downtown"
  • "outside_terminal"
  • "airport_hotel"
  • "meet_greet"
filters.mileage_type String No

Filters the results based on the mileage type associated with the rental vehicle

Possible values:

  • "unlimited"
  • "limited"
maximum_results Integer No

The maximum number of results to return.

Default value: 100

page String No

Pagination token used to retrieve the next page of results. Obtained from next_page.

driver Object Yes

Defines the driver context.

driver.age Integer Yes

Driver age. Affect the availability and price of the products.

route Object Yes

Defines the route context.

route.pickup Object Yes

Pick up location and time.

route.pickup.location Object Yes

Pick up / drop off location.

route.pickup.datetime String Yes

Pick up / drop off datetime.

route.dropoff Object Yes

Drop off location and time.

route.dropoff.location Object Yes

Pick up / drop off location.

route.dropoff.datetime String Yes

Pick up / drop off datetime.

sort Object No

The sorting parameters for the response.

sort.direction String No

The direction you wish for your sort.by parameter to be sorted in.

Possible values:

  • "ascending"
  • "descending"
sort.by String No

The way to sort your results.

Possible values:

  • "price"
  • "review_score"
  • "distance"
payment Object No

Payment-related input filters that allow you to narrow down car search results based on the payment timing options.

payment.timings[] Array No

Filters the results to include only car rentals that offer the specified payment timings. Use this parameter to search for cars based on the timing of payment (e.g., payment upfront, partial payment, or payment at the depot).

Possible values:

  • "pay_local"
  • "pay_now"
  • "part_pay"
currency String Yes

A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling common/payments/currencies.

language String No

Effects on the selected language of the target website after redirection by provided url.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.