Create a vehicle search
curl --request POST \
--url https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches \
--header 'Content-Type: application/json' \
--data '
{
"pickUpLocation": "sao-paulo-sp",
"dropOffLocation": "sao-paulo-sp",
"pickUpDate": "2026-11-02T10:00:00",
"dropOffDate": "2026-11-05T10:00:00"
}
'import requests
url = "https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches"
payload = {
"pickUpLocation": "sao-paulo-sp",
"dropOffLocation": "sao-paulo-sp",
"pickUpDate": "2026-11-02T10:00:00",
"dropOffDate": "2026-11-05T10:00:00"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pickUpLocation: 'sao-paulo-sp',
dropOffLocation: 'sao-paulo-sp',
pickUpDate: '2026-11-02T10:00:00',
dropOffDate: '2026-11-05T10:00:00'
})
};
fetch('https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pickUpLocation' => 'sao-paulo-sp',
'dropOffLocation' => 'sao-paulo-sp',
'pickUpDate' => '2026-11-02T10:00:00',
'dropOffDate' => '2026-11-05T10:00:00'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches"
payload := strings.NewReader("{\n \"pickUpLocation\": \"sao-paulo-sp\",\n \"dropOffLocation\": \"sao-paulo-sp\",\n \"pickUpDate\": \"2026-11-02T10:00:00\",\n \"dropOffDate\": \"2026-11-05T10:00:00\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches")
.header("Content-Type", "application/json")
.body("{\n \"pickUpLocation\": \"sao-paulo-sp\",\n \"dropOffLocation\": \"sao-paulo-sp\",\n \"pickUpDate\": \"2026-11-02T10:00:00\",\n \"dropOffDate\": \"2026-11-05T10:00:00\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pickUpLocation\": \"sao-paulo-sp\",\n \"dropOffLocation\": \"sao-paulo-sp\",\n \"pickUpDate\": \"2026-11-02T10:00:00\",\n \"dropOffDate\": \"2026-11-05T10:00:00\"\n}"
response = http.request(request)
puts response.read_body{
"id": "srch_Hb7Yk1DrMv3Lq8UsAe0Xj",
"searchParams": {
"pickUpLocation": "sao-paulo-sp",
"dropOffLocation": "sao-paulo-sp",
"pickUpDate": "2026-11-02T10:00:00",
"dropOffDate": "2026-11-05T10:00:00"
},
"type": "VEHICLE",
"status": "PROCESSING",
"warning": {
"code": "ALL_SUCCESS",
"message": "All suppliers answered."
},
"ttl": 1800,
"facets": {},
"createdAt": "2026-10-19T15:00:00.000Z"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "TRAVEL",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "pickUpLocation",
"message": "Invalid input: expected string, received undefined",
"code": "PICKUPLOCATION_REQUIRED"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "PROVIDER_UNAVAILABLE",
"origin": "TRAVEL",
"message": "Travel provider temporarily unavailable, please retry."
}Create a vehicle search
Starts a search for car rentals, from a pick-up place and time to a drop-off place and time.
POST
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
vehicle
/
searches
Create a vehicle search
curl --request POST \
--url https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches \
--header 'Content-Type: application/json' \
--data '
{
"pickUpLocation": "sao-paulo-sp",
"dropOffLocation": "sao-paulo-sp",
"pickUpDate": "2026-11-02T10:00:00",
"dropOffDate": "2026-11-05T10:00:00"
}
'import requests
url = "https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches"
payload = {
"pickUpLocation": "sao-paulo-sp",
"dropOffLocation": "sao-paulo-sp",
"pickUpDate": "2026-11-02T10:00:00",
"dropOffDate": "2026-11-05T10:00:00"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pickUpLocation: 'sao-paulo-sp',
dropOffLocation: 'sao-paulo-sp',
pickUpDate: '2026-11-02T10:00:00',
dropOffDate: '2026-11-05T10:00:00'
})
};
fetch('https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pickUpLocation' => 'sao-paulo-sp',
'dropOffLocation' => 'sao-paulo-sp',
'pickUpDate' => '2026-11-02T10:00:00',
'dropOffDate' => '2026-11-05T10:00:00'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches"
payload := strings.NewReader("{\n \"pickUpLocation\": \"sao-paulo-sp\",\n \"dropOffLocation\": \"sao-paulo-sp\",\n \"pickUpDate\": \"2026-11-02T10:00:00\",\n \"dropOffDate\": \"2026-11-05T10:00:00\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches")
.header("Content-Type", "application/json")
.body("{\n \"pickUpLocation\": \"sao-paulo-sp\",\n \"dropOffLocation\": \"sao-paulo-sp\",\n \"pickUpDate\": \"2026-11-02T10:00:00\",\n \"dropOffDate\": \"2026-11-05T10:00:00\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.travel.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/vehicle/searches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pickUpLocation\": \"sao-paulo-sp\",\n \"dropOffLocation\": \"sao-paulo-sp\",\n \"pickUpDate\": \"2026-11-02T10:00:00\",\n \"dropOffDate\": \"2026-11-05T10:00:00\"\n}"
response = http.request(request)
puts response.read_body{
"id": "srch_Hb7Yk1DrMv3Lq8UsAe0Xj",
"searchParams": {
"pickUpLocation": "sao-paulo-sp",
"dropOffLocation": "sao-paulo-sp",
"pickUpDate": "2026-11-02T10:00:00",
"dropOffDate": "2026-11-05T10:00:00"
},
"type": "VEHICLE",
"status": "PROCESSING",
"warning": {
"code": "ALL_SUCCESS",
"message": "All suppliers answered."
},
"ttl": 1800,
"facets": {},
"createdAt": "2026-10-19T15:00:00.000Z"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "TRAVEL",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "pickUpLocation",
"message": "Invalid input: expected string, received undefined",
"code": "PICKUPLOCATION_REQUIRED"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "PROVIDER_UNAVAILABLE",
"origin": "TRAVEL",
"message": "Travel provider temporarily unavailable, please retry."
}Searches are asynchronous: this answers
202 at once with the search in PROCESSING status while the travel suppliers answer in the background. Poll the search with its id until status is COMPLETED — or FAILED — to read the results. A vehicle search lasts 30 minutes (see ttl); after that, create it again. Creating the same search again while it lasts returns the same id, and only your organization can read the searches it created.
Find pickUpLocation and dropOffLocation with the locations endpoint. To book a result, open the item for its fare options, then create a trip with the item’s id as searchItemId and the chosen fare option’s id as fareId.
An error the travel provider reports about the request — an unknown place, say — is returned with its own status, code and message.Path Parameters
ID of your realm.
Format: UUID
ID of your organization.
Format: UUID
Body
application/json
Pick-up place: its id or its slug from the locations endpoint.
Minimum string length:
1Example:
"sao-paulo-sp"
Drop-off place: its id or its slug from the locations endpoint.
Minimum string length:
1Example:
"sao-paulo-sp"
Pick-up date and time, local to the pick-up place (YYYY-MM-DDTHH:mm:ss, no time-zone offset). Today or later, and before dropOffDate.
Minimum string length:
1Example:
"2026-11-02T10:00:00"
Drop-off date and time, local to the drop-off place (YYYY-MM-DDTHH:mm:ss, no time-zone offset), after pickUpDate.
Minimum string length:
1Example:
"2026-11-05T10:00:00"
Response
Successful response
A search just created for vehicle rentals. Results come later: poll the search.
ID of the search. The same search parameters, within the time the search lasts, return the same ID.
Example:
"srch_Hb7Yk1DrMv3Lq8UsAe0Xj"
What the search was made for.
Show child attributes
Show child attributes
Always VEHICLE.
Available options:
VEHICLE Example:
"VEHICLE"
PROCESSING right after creation. It becomes COMPLETED or FAILED on its own: poll the search.
Available options:
PROCESSING, FAILED, COMPLETED Example:
"PROCESSING"
How the search went across the suppliers. null while it is processing.
Show child attributes
Show child attributes
Seconds until the search expires.
Example:
1800
Facets to build filters from (price ranges, categories, rental companies, with their counts). null until the search completes.
Show child attributes
Show child attributes
When the search was created.
Example:
"2026-10-19T15:00:00.000Z"