Create a new Vehicle

curl --request POST \
  --url https://commerce.driv.ly/api/vehicles \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "vin": "<string>",
  "customer": 123,
  "status": [],
  "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
  ]
}
'

import requests

url = "https://commerce.driv.ly/api/vehicles"

payload = {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "vin": "<string>",
    "customer": 123,
    "status": [],
    "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]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    updatedAt: '<string>',
    createdAt: '<string>',
    name: '<string>',
    vin: '<string>',
    customer: 123,
    status: [],
    deals: [123],
    year: '<string>',
    make: '<string>',
    model: '<string>',
    trim: '<string>',
    style: '<string>',
    body: JSON.stringify('<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]
  })
};

fetch('https://commerce.driv.ly/api/vehicles', 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://commerce.driv.ly/api/vehicles",
  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([
    'updatedAt' => '<string>',
    'createdAt' => '<string>',
    'name' => '<string>',
    'vin' => '<string>',
    'customer' => 123,
    'status' => [
        
    ],
    '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
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://commerce.driv.ly/api/vehicles"

	payload := strings.NewReader("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"vin\": \"<string>\",\n  \"customer\": 123,\n  \"status\": [],\n  \"deals\": [\n    123\n  ],\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"style\": \"<string>\",\n  \"body\": \"<string>\",\n  \"drivetrain\": \"<string>\",\n  \"engine\": \"<string>\",\n  \"transmission\": \"<string>\",\n  \"interior\": \"<string>\",\n  \"exterior\": \"<string>\",\n  \"listings\": [\n    123\n  ],\n  \"serviceQuotes\": [\n    123\n  ],\n  \"tenant\": 123,\n  \"trades\": [\n    123\n  ],\n  \"createdBy\": 123,\n  \"transportServiceOrders\": \"<string>\",\n  \"transportServiceOrders2\": [\n    123\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	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://commerce.driv.ly/api/vehicles")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"vin\": \"<string>\",\n  \"customer\": 123,\n  \"status\": [],\n  \"deals\": [\n    123\n  ],\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"style\": \"<string>\",\n  \"body\": \"<string>\",\n  \"drivetrain\": \"<string>\",\n  \"engine\": \"<string>\",\n  \"transmission\": \"<string>\",\n  \"interior\": \"<string>\",\n  \"exterior\": \"<string>\",\n  \"listings\": [\n    123\n  ],\n  \"serviceQuotes\": [\n    123\n  ],\n  \"tenant\": 123,\n  \"trades\": [\n    123\n  ],\n  \"createdBy\": 123,\n  \"transportServiceOrders\": \"<string>\",\n  \"transportServiceOrders2\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://commerce.driv.ly/api/vehicles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"vin\": \"<string>\",\n  \"customer\": 123,\n  \"status\": [],\n  \"deals\": [\n    123\n  ],\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"style\": \"<string>\",\n  \"body\": \"<string>\",\n  \"drivetrain\": \"<string>\",\n  \"engine\": \"<string>\",\n  \"transmission\": \"<string>\",\n  \"interior\": \"<string>\",\n  \"exterior\": \"<string>\",\n  \"listings\": [\n    123\n  ],\n  \"serviceQuotes\": [\n    123\n  ],\n  \"tenant\": 123,\n  \"trades\": [\n    123\n  ],\n  \"createdBy\": 123,\n  \"transportServiceOrders\": \"<string>\",\n  \"transportServiceOrders2\": [\n    123\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "vin": "<string>",
    "customer": 123,
    "status": [],
    "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
    ]
  },
  "message": "<string>"
}

POST

vehicles

Create a new Vehicle

curl --request POST \
  --url https://commerce.driv.ly/api/vehicles \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "vin": "<string>",
  "customer": 123,
  "status": [],
  "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
  ]
}
'

import requests

url = "https://commerce.driv.ly/api/vehicles"

payload = {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "vin": "<string>",
    "customer": 123,
    "status": [],
    "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]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    updatedAt: '<string>',
    createdAt: '<string>',
    name: '<string>',
    vin: '<string>',
    customer: 123,
    status: [],
    deals: [123],
    year: '<string>',
    make: '<string>',
    model: '<string>',
    trim: '<string>',
    style: '<string>',
    body: JSON.stringify('<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]
  })
};

fetch('https://commerce.driv.ly/api/vehicles', 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://commerce.driv.ly/api/vehicles",
  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([
    'updatedAt' => '<string>',
    'createdAt' => '<string>',
    'name' => '<string>',
    'vin' => '<string>',
    'customer' => 123,
    'status' => [
        
    ],
    '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
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://commerce.driv.ly/api/vehicles"

	payload := strings.NewReader("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"vin\": \"<string>\",\n  \"customer\": 123,\n  \"status\": [],\n  \"deals\": [\n    123\n  ],\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"style\": \"<string>\",\n  \"body\": \"<string>\",\n  \"drivetrain\": \"<string>\",\n  \"engine\": \"<string>\",\n  \"transmission\": \"<string>\",\n  \"interior\": \"<string>\",\n  \"exterior\": \"<string>\",\n  \"listings\": [\n    123\n  ],\n  \"serviceQuotes\": [\n    123\n  ],\n  \"tenant\": 123,\n  \"trades\": [\n    123\n  ],\n  \"createdBy\": 123,\n  \"transportServiceOrders\": \"<string>\",\n  \"transportServiceOrders2\": [\n    123\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	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://commerce.driv.ly/api/vehicles")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"vin\": \"<string>\",\n  \"customer\": 123,\n  \"status\": [],\n  \"deals\": [\n    123\n  ],\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"style\": \"<string>\",\n  \"body\": \"<string>\",\n  \"drivetrain\": \"<string>\",\n  \"engine\": \"<string>\",\n  \"transmission\": \"<string>\",\n  \"interior\": \"<string>\",\n  \"exterior\": \"<string>\",\n  \"listings\": [\n    123\n  ],\n  \"serviceQuotes\": [\n    123\n  ],\n  \"tenant\": 123,\n  \"trades\": [\n    123\n  ],\n  \"createdBy\": 123,\n  \"transportServiceOrders\": \"<string>\",\n  \"transportServiceOrders2\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://commerce.driv.ly/api/vehicles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"updatedAt\": \"<string>\",\n  \"createdAt\": \"<string>\",\n  \"name\": \"<string>\",\n  \"vin\": \"<string>\",\n  \"customer\": 123,\n  \"status\": [],\n  \"deals\": [\n    123\n  ],\n  \"year\": \"<string>\",\n  \"make\": \"<string>\",\n  \"model\": \"<string>\",\n  \"trim\": \"<string>\",\n  \"style\": \"<string>\",\n  \"body\": \"<string>\",\n  \"drivetrain\": \"<string>\",\n  \"engine\": \"<string>\",\n  \"transmission\": \"<string>\",\n  \"interior\": \"<string>\",\n  \"exterior\": \"<string>\",\n  \"listings\": [\n    123\n  ],\n  \"serviceQuotes\": [\n    123\n  ],\n  \"tenant\": 123,\n  \"trades\": [\n    123\n  ],\n  \"createdBy\": 123,\n  \"transportServiceOrders\": \"<string>\",\n  \"transportServiceOrders2\": [\n    123\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "vin": "<string>",
    "customer": 123,
    "status": [],
    "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
    ]
  },
  "message": "<string>"
}

Usage with the Drivly SDK

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.create(data: vehicles): Promise<vehicles>

Authorizations

Authorization

string

header

required

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

Body

application/json

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

Response

200 - application/json

doc

Vehicle · object

required

Show child attributes

message

string

required

Commerce

API Reference

Create a new Vehicle

Authorizations

Query Parameters

Body

Response