Skip to main content
GET
/
vehicles
/
{id}
Get a single Vehicle by its id
curl --request GET \
  --url https://commerce.driv.ly/api/vehicles/{id} \
  --header 'Authorization: <api-key>'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "vin": "<string>",
  "customer": 123,
  "status": [
    "Bought at Auction"
  ],
  "deals": [
    123
  ],
  "year": "<string>",
  "make": "<string>",
  "model": "<string>",
  "trim": "<string>",
  "style": "<string>",
  "body": "<string>",
  "drivetrain": "<string>",
  "engine": "<string>",
  "transmission": "<string>",
  "interior": "<string>",
  "exterior": "<string>",
  "listings": [
    123
  ],
  "serviceQuotes": [
    123
  ],
  "tenant": 123,
  "trades": [
    123
  ],
  "createdBy": 123,
  "transportServiceOrders": "<string>",
  "transportServiceOrders2": [
    123
  ]
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { vehicles } from '@drivly/commerce'

const sdk = new SDK(...)

const vehicles = await sdk.vehicles.findOne(vehiclesId: string): Promise<vehicles>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Vehicle

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

​
sort
string

sort by field

​
where
Where clause · object

pass a where query to constrain returned documents (complex type, see documentation)

Example:
{
  "or": [
    { "color": { "equals": "mint" } },
    {
      "and": [
        { "color": { "equals": "white" } },
        { "featured": { "equals": false } }
      ]
    }
  ]
}
​
limit
number

limit the returned documents to a certain number

​
page
number

get a specific page of documents

Response

ok

​
updatedAt
string
required
​
createdAt
string
required
​
name
string | null
​
vin
string | null
​
customer
​
status
enum<string>[] | null
Available options:
Bought at Auction,
Inspected,
Transport to Inspection,
Transport to Customer,
Arbitration,
Bid Placed,
SOLD TO CUSTOMER,
Identified as potential option for customer,
Taken in on Trade,
Trade sold at Auction,
Trade sold Retail
​
deals
(number | Deal · object)[] | null
​
year
string | null
​
make
string | null
​
model
string | null
​
trim
string | null
​
style
string | null
​
body
string | null
​
drivetrain
string | null
​
engine
string | null
​
transmission
string | null
​
interior
string | null
​
exterior
string | null
​
listings
(number | Listing · object)[] | null
​
serviceQuotes
(number | ServiceQuote · object)[] | null
​
tenant
​
trades
(number | Trade · object)[] | null
​
createdBy
number
​
transportServiceOrders
string | null
​
transportServiceOrders2
(number | ServiceOrder · object)[] | null