API Reference
- Addresses
- Attachments
- Calls
- Contacts
- Credit Applications
- Customers
- Deals
- Definitions
- DMV Fees
- Documents
- Fees
- Holidays
- Insurance Policies
- Insurance Quotes
- Leads
- Lead Events
- Listings
- Locations
- Logs
- Meetings
- Messages
- Pre-Approvals
- Sales Reps
- Searches
- Service Quotes
- Service Orders
- Taxes And Fees
- Templates
- CRM Trades
- Trades
- VDP Emails
- CRM Vehicles
- Vehicles
- Web Events
- Webhooks
Vehicles
Create a new Vehicle
Create a new Vehicle
POST
/
vehicles
Copy
curl --request POST \
--url https://commerce.driv.ly/api/vehicles \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"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
],
"updatedAt": "<string>",
"createdAt": "<string>"
}'
Copy
{
"doc": {
"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
],
"updatedAt": "<string>",
"createdAt": "<string>"
},
"message": "<string>"
}
Usage with the Drivly SDK
Usage with the Drivly SDK
Make sure you install our SDK first. You can find out how, and more here.
Copy
import { SDK } from '@drivly/commerce'
import type { vehicles } from '@drivly/commerce'
const sdk = new SDK(...)
const vehicles = await sdk.vehicles.create(data: vehicles): Promise<vehicles>
Authorizations
Query Parameters
number of levels to automatically populate relationships and uploads
retrieves document(s) in a specific locale
specifies a fallback locale if no locale value exists
Body
application/json
Response
200 - application/json
ok
The response is of type object
.
Copy
curl --request POST \
--url https://commerce.driv.ly/api/vehicles \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"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
],
"updatedAt": "<string>",
"createdAt": "<string>"
}'
Copy
{
"doc": {
"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
],
"updatedAt": "<string>",
"createdAt": "<string>"
},
"message": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.