Skip to main content
GET
/
crmVehicles
/
{id}
Get a single Crm Vehicle by its id
curl --request GET \
  --url https://commerce.driv.ly/api/crmVehicles/{id} \
  --header 'Authorization: <api-key>'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "vin": "<string>",
  "search": [
    123
  ],
  "favorite": [
    123
  ],
  "exteriorColor": "<string>",
  "status": "Needs Review",
  "reason": [
    "Wrong Color"
  ],
  "notes": "<string>",
  "salesPrice": "<string>",
  "year": 123,
  "make": "<string>",
  "model": "<string>",
  "trim": "<string>",
  "bodyStyle": "<string>",
  "mileage": 123,
  "condition": 123,
  "newOrUsed": "<string>",
  "auction": "<string>",
  "auctionDate": "<string>",
  "laneAndRun": "<string>",
  "pickupZip": "<string>",
  "estimatedTransportFee": "<string>",
  "adjMmr": "<string>",
  "minBid": "<string>",
  "buyNow": "<string>",
  "retailPrice": "<string>",
  "tmvUsedRetailTotalWithOptions": "<string>",
  "kbbRetailBook": "<string>",
  "bbTotalRetail": "<string>",
  "wholesaleVdp": "<string>",
  "retailVdp": "<string>",
  "conditionReport": "<string>",
  "updateRequested": "<string>",
  "createdBy": 123,
  "lastModifiedBy": 123,
  "vdpEmails": [
    123
  ],
  "likes": "<string>",
  "dislikes": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { crmVehicles } from '@drivly/commerce'

const sdk = new SDK(...)

const crmVehicles = await sdk.crmVehicles.findOne(crmVehiclesId: string): Promise<crmVehicles>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Crm 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
​
vin
string | null
​
search
(number | Search · object)[] | null
​
favorite
(number | Lead · object)[] | null
​
exteriorColor
string | null
​
status
enum<string> | null
Available options:
Needs Review,
Exclude,
To Send to Customer,
Sent to Customer,
Watching Price,
Customer Approved
​
reason
enum<string>[] | null
Available options:
Wrong Color,
Wrong Trim,
Out of price range,
Sold at Auction,
Salvage Title,
Damage on the Carfax,
Old,
Condition Report,
Mileage,
Test,
Manual transmission,
Features,
Waiting for Lower Price,
Duplicate,
MECHANICAL AND DIAGNOSTIC CODES,
Previous Canadian,
No Pictures
​
notes
string | null
​
salesPrice
string | null
​
year
number | null
​
make
string | null
​
model
string | null
​
trim
string | null
​
bodyStyle
string | null
​
mileage
number | null
​
condition
number | null
​
newOrUsed
string | null
​
auction
string | null
​
auctionDate
string | null
​
laneAndRun
string | null
​
pickupZip
string | null
​
estimatedTransportFee
string | null
​
adjMmr
string | null
​
minBid
string | null
​
buyNow
string | null
​
retailPrice
string | null
​
tmvUsedRetailTotalWithOptions
string | null
​
kbbRetailBook
string | null
​
bbTotalRetail
string | null
​
wholesaleVdp
string | null
​
retailVdp
string | null
​
conditionReport
string | null
​
updateRequested
string | null
​
createdBy
number
​
lastModifiedBy
number
​
vdpEmails
(number | VdpEmail · object)[] | null
​
likes
string | null
​
dislikes
string | null