Skip to main content
POST
/
searches
Create a new Search
curl --request POST \
  --url https://commerce.driv.ly/api/searches \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "src_5j3ks8d2hj3s",
  "lead": "Lead ID",
  "makes": [
    "Toyota",
    "Honda"
  ],
  "trims": [
    "SE",
    "EX"
  ],
  "models": [
    "Camry",
    "Civic"
  ],
  "vehicles": [
    "Vehicle ID"
  ],
  "bodyStyles": [
    "Sedan",
    "SUV"
  ],
  "minimumYear": 2015,
  "maximumYear": 2021,
  "drivetrains": [
    "FWD",
    "AWD"
  ],
  "maximumPrice": 30000,
  "vehicleSpecs": [
    "Vehicle Spec ID"
  ],
  "minimumRating": 4,
  "transmissions": [
    "Automatic",
    "Manual"
  ],
  "maximumOdometer": 50000
}'
{
  "data": {
    "id": "src_5j3ks8d2hj3s",
    "lead": "Lead ID",
    "makes": [
      "Toyota",
      "Honda"
    ],
    "trims": [
      "SE",
      "EX"
    ],
    "models": [
      "Camry",
      "Civic"
    ],
    "vehicles": [
      "Vehicle ID"
    ],
    "bodyStyles": [
      "Sedan",
      "SUV"
    ],
    "minimumYear": 2015,
    "maximumYear": 2021,
    "drivetrains": [
      "FWD",
      "AWD"
    ],
    "maximumPrice": 30000,
    "vehicleSpecs": [
      "Vehicle Spec ID"
    ],
    "minimumRating": 4,
    "transmissions": [
      "Automatic",
      "Manual"
    ],
    "maximumOdometer": 50000
  },
  "success": true
}

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Body

application/json
​
lead
required

Lead performs vehicle- Search

​
id
string

Search is uniquely identified by id

​
minimumYear
integer

Search has Minimum Year

​
minimumRating
number

Search has Minimum Rating

Required range: 0 <= x <= 5Must be a multiple of 0.1
​
maximumYear
integer

Search has Maximum Year

​
maximumPrice
integer

Search has Maximum Price

​
maximumOdometer
number

Search has Maximum Odometer reading

Required range: x >= 0
​
vehicleSpecs
(string | Vehicle Spec · object)[]

Search has Vehicle Spec

​
vehicles
(string | Vehicle · object)[]

Search found Vehicle

​
models
string[]

Search has Model

​
transmissions
string[]

Search has Transmission

​
drivetrains
string[]

Search has Drivetrain

​
makes
string[]

Search has Make

​
bodyStyles
string[]

Search has Body Style

​
trims
string[]

Search has Trim

Response

Search Created

​
data
object
Examples:
{
  "id": "src_5j3ks8d2hj3s",
  "lead": "Lead ID",
  "makes": ["Toyota", "Honda"],
  "trims": ["SE", "EX"],
  "models": ["Camry", "Civic"],
  "vehicles": ["Vehicle ID"],
  "bodyStyles": ["Sedan", "SUV"],
  "minimumYear": 2015,
  "maximumYear": 2021,
  "drivetrains": ["FWD", "AWD"],
  "maximumPrice": 30000,
  "vehicleSpecs": ["Vehicle Spec ID"],
  "minimumRating": 4,
  "transmissions": ["Automatic", "Manual"],
  "maximumOdometer": 50000
}
​
success
boolean