Update an existing Trade
curl --request PATCH \
--url https://commerce.driv.ly/api/trades/{customer}/{vehicle} \
--header 'Content-Type: application/json' \
--data '
{
"deal": "dea_1a2b3c4d5e6f",
"vehicle": {
"id": "veh_3k12j9qksdf0",
"vin": "1C4HJXEN5MW592818",
"year": 2021,
"make": "Jeep",
"trim": "Sport",
"spec": "Off-Road Package",
"model": "Wrangler",
"engine": "3.6L V6",
"seatCount": 5,
"doorCount": 4,
"bodyStyle": "SUV",
"drivetrain": "4WD",
"transmission": "Automatic",
"interiorColor": "Black",
"exteriorColor": "Red"
},
"customer": {
"id": "cus_k3j5s9qj3w0d",
"addresses": [
"123 Main St, Anytown, USA"
],
"phoneNumbers": [
"555-123-4567"
]
},
"odometer": 15000,
"creditApp": "cre_5j6k7l8m9n0o",
"netAllowance": 25000,
"grossAllowance": 26000
}
'import requests
url = "https://commerce.driv.ly/api/trades/{customer}/{vehicle}"
payload = {
"deal": "dea_1a2b3c4d5e6f",
"vehicle": {
"id": "veh_3k12j9qksdf0",
"vin": "1C4HJXEN5MW592818",
"year": 2021,
"make": "Jeep",
"trim": "Sport",
"spec": "Off-Road Package",
"model": "Wrangler",
"engine": "3.6L V6",
"seatCount": 5,
"doorCount": 4,
"bodyStyle": "SUV",
"drivetrain": "4WD",
"transmission": "Automatic",
"interiorColor": "Black",
"exteriorColor": "Red"
},
"customer": {
"id": "cus_k3j5s9qj3w0d",
"addresses": ["123 Main St, Anytown, USA"],
"phoneNumbers": ["555-123-4567"]
},
"odometer": 15000,
"creditApp": "cre_5j6k7l8m9n0o",
"netAllowance": 25000,
"grossAllowance": 26000
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
deal: 'dea_1a2b3c4d5e6f',
vehicle: {
id: 'veh_3k12j9qksdf0',
vin: '1C4HJXEN5MW592818',
year: 2021,
make: 'Jeep',
trim: 'Sport',
spec: 'Off-Road Package',
model: 'Wrangler',
engine: '3.6L V6',
seatCount: 5,
doorCount: 4,
bodyStyle: 'SUV',
drivetrain: '4WD',
transmission: 'Automatic',
interiorColor: 'Black',
exteriorColor: 'Red'
},
customer: {
id: 'cus_k3j5s9qj3w0d',
addresses: ['123 Main St, Anytown, USA'],
phoneNumbers: ['555-123-4567']
},
odometer: 15000,
creditApp: 'cre_5j6k7l8m9n0o',
netAllowance: 25000,
grossAllowance: 26000
})
};
fetch('https://commerce.driv.ly/api/trades/{customer}/{vehicle}', 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/trades/{customer}/{vehicle}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'deal' => 'dea_1a2b3c4d5e6f',
'vehicle' => [
'id' => 'veh_3k12j9qksdf0',
'vin' => '1C4HJXEN5MW592818',
'year' => 2021,
'make' => 'Jeep',
'trim' => 'Sport',
'spec' => 'Off-Road Package',
'model' => 'Wrangler',
'engine' => '3.6L V6',
'seatCount' => 5,
'doorCount' => 4,
'bodyStyle' => 'SUV',
'drivetrain' => '4WD',
'transmission' => 'Automatic',
'interiorColor' => 'Black',
'exteriorColor' => 'Red'
],
'customer' => [
'id' => 'cus_k3j5s9qj3w0d',
'addresses' => [
'123 Main St, Anytown, USA'
],
'phoneNumbers' => [
'555-123-4567'
]
],
'odometer' => 15000,
'creditApp' => 'cre_5j6k7l8m9n0o',
'netAllowance' => 25000,
'grossAllowance' => 26000
]),
CURLOPT_HTTPHEADER => [
"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/trades/{customer}/{vehicle}"
payload := strings.NewReader("{\n \"deal\": \"dea_1a2b3c4d5e6f\",\n \"vehicle\": {\n \"id\": \"veh_3k12j9qksdf0\",\n \"vin\": \"1C4HJXEN5MW592818\",\n \"year\": 2021,\n \"make\": \"Jeep\",\n \"trim\": \"Sport\",\n \"spec\": \"Off-Road Package\",\n \"model\": \"Wrangler\",\n \"engine\": \"3.6L V6\",\n \"seatCount\": 5,\n \"doorCount\": 4,\n \"bodyStyle\": \"SUV\",\n \"drivetrain\": \"4WD\",\n \"transmission\": \"Automatic\",\n \"interiorColor\": \"Black\",\n \"exteriorColor\": \"Red\"\n },\n \"customer\": {\n \"id\": \"cus_k3j5s9qj3w0d\",\n \"addresses\": [\n \"123 Main St, Anytown, USA\"\n ],\n \"phoneNumbers\": [\n \"555-123-4567\"\n ]\n },\n \"odometer\": 15000,\n \"creditApp\": \"cre_5j6k7l8m9n0o\",\n \"netAllowance\": 25000,\n \"grossAllowance\": 26000\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://commerce.driv.ly/api/trades/{customer}/{vehicle}")
.header("Content-Type", "application/json")
.body("{\n \"deal\": \"dea_1a2b3c4d5e6f\",\n \"vehicle\": {\n \"id\": \"veh_3k12j9qksdf0\",\n \"vin\": \"1C4HJXEN5MW592818\",\n \"year\": 2021,\n \"make\": \"Jeep\",\n \"trim\": \"Sport\",\n \"spec\": \"Off-Road Package\",\n \"model\": \"Wrangler\",\n \"engine\": \"3.6L V6\",\n \"seatCount\": 5,\n \"doorCount\": 4,\n \"bodyStyle\": \"SUV\",\n \"drivetrain\": \"4WD\",\n \"transmission\": \"Automatic\",\n \"interiorColor\": \"Black\",\n \"exteriorColor\": \"Red\"\n },\n \"customer\": {\n \"id\": \"cus_k3j5s9qj3w0d\",\n \"addresses\": [\n \"123 Main St, Anytown, USA\"\n ],\n \"phoneNumbers\": [\n \"555-123-4567\"\n ]\n },\n \"odometer\": 15000,\n \"creditApp\": \"cre_5j6k7l8m9n0o\",\n \"netAllowance\": 25000,\n \"grossAllowance\": 26000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce.driv.ly/api/trades/{customer}/{vehicle}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"deal\": \"dea_1a2b3c4d5e6f\",\n \"vehicle\": {\n \"id\": \"veh_3k12j9qksdf0\",\n \"vin\": \"1C4HJXEN5MW592818\",\n \"year\": 2021,\n \"make\": \"Jeep\",\n \"trim\": \"Sport\",\n \"spec\": \"Off-Road Package\",\n \"model\": \"Wrangler\",\n \"engine\": \"3.6L V6\",\n \"seatCount\": 5,\n \"doorCount\": 4,\n \"bodyStyle\": \"SUV\",\n \"drivetrain\": \"4WD\",\n \"transmission\": \"Automatic\",\n \"interiorColor\": \"Black\",\n \"exteriorColor\": \"Red\"\n },\n \"customer\": {\n \"id\": \"cus_k3j5s9qj3w0d\",\n \"addresses\": [\n \"123 Main St, Anytown, USA\"\n ],\n \"phoneNumbers\": [\n \"555-123-4567\"\n ]\n },\n \"odometer\": 15000,\n \"creditApp\": \"cre_5j6k7l8m9n0o\",\n \"netAllowance\": 25000,\n \"grossAllowance\": 26000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"deal": "dea_1a2b3c4d5e6f",
"vehicle": {
"id": "veh_3k12j9qksdf0",
"vin": "1C4HJXEN5MW592818",
"year": 2021,
"make": "Jeep",
"trim": "Sport",
"spec": "Off-Road Package",
"model": "Wrangler",
"engine": "3.6L V6",
"seatCount": 5,
"doorCount": 4,
"bodyStyle": "SUV",
"drivetrain": "4WD",
"transmission": "Automatic",
"interiorColor": "Black",
"exteriorColor": "Red"
},
"customer": {
"id": "cus_k3j5s9qj3w0d",
"addresses": [
"123 Main St, Anytown, USA"
],
"phoneNumbers": [
"555-123-4567"
]
},
"odometer": 15000,
"creditApp": "cre_5j6k7l8m9n0o",
"netAllowance": 25000,
"grossAllowance": 26000
},
"success": true
}{
"error": {
"code": 401,
"message": "Unauthorized"
},
"success": false
}{
"error": {
"code": 404,
"message": "Trade Not Found"
},
"success": false
}{
"error": {
"code": 429,
"message": "Too Many Requests"
},
"success": false
}Trades
Update an existing Trade
PATCH
/
trades
/
{customer}
/
{vehicle}
Update an existing Trade
curl --request PATCH \
--url https://commerce.driv.ly/api/trades/{customer}/{vehicle} \
--header 'Content-Type: application/json' \
--data '
{
"deal": "dea_1a2b3c4d5e6f",
"vehicle": {
"id": "veh_3k12j9qksdf0",
"vin": "1C4HJXEN5MW592818",
"year": 2021,
"make": "Jeep",
"trim": "Sport",
"spec": "Off-Road Package",
"model": "Wrangler",
"engine": "3.6L V6",
"seatCount": 5,
"doorCount": 4,
"bodyStyle": "SUV",
"drivetrain": "4WD",
"transmission": "Automatic",
"interiorColor": "Black",
"exteriorColor": "Red"
},
"customer": {
"id": "cus_k3j5s9qj3w0d",
"addresses": [
"123 Main St, Anytown, USA"
],
"phoneNumbers": [
"555-123-4567"
]
},
"odometer": 15000,
"creditApp": "cre_5j6k7l8m9n0o",
"netAllowance": 25000,
"grossAllowance": 26000
}
'import requests
url = "https://commerce.driv.ly/api/trades/{customer}/{vehicle}"
payload = {
"deal": "dea_1a2b3c4d5e6f",
"vehicle": {
"id": "veh_3k12j9qksdf0",
"vin": "1C4HJXEN5MW592818",
"year": 2021,
"make": "Jeep",
"trim": "Sport",
"spec": "Off-Road Package",
"model": "Wrangler",
"engine": "3.6L V6",
"seatCount": 5,
"doorCount": 4,
"bodyStyle": "SUV",
"drivetrain": "4WD",
"transmission": "Automatic",
"interiorColor": "Black",
"exteriorColor": "Red"
},
"customer": {
"id": "cus_k3j5s9qj3w0d",
"addresses": ["123 Main St, Anytown, USA"],
"phoneNumbers": ["555-123-4567"]
},
"odometer": 15000,
"creditApp": "cre_5j6k7l8m9n0o",
"netAllowance": 25000,
"grossAllowance": 26000
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
deal: 'dea_1a2b3c4d5e6f',
vehicle: {
id: 'veh_3k12j9qksdf0',
vin: '1C4HJXEN5MW592818',
year: 2021,
make: 'Jeep',
trim: 'Sport',
spec: 'Off-Road Package',
model: 'Wrangler',
engine: '3.6L V6',
seatCount: 5,
doorCount: 4,
bodyStyle: 'SUV',
drivetrain: '4WD',
transmission: 'Automatic',
interiorColor: 'Black',
exteriorColor: 'Red'
},
customer: {
id: 'cus_k3j5s9qj3w0d',
addresses: ['123 Main St, Anytown, USA'],
phoneNumbers: ['555-123-4567']
},
odometer: 15000,
creditApp: 'cre_5j6k7l8m9n0o',
netAllowance: 25000,
grossAllowance: 26000
})
};
fetch('https://commerce.driv.ly/api/trades/{customer}/{vehicle}', 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/trades/{customer}/{vehicle}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'deal' => 'dea_1a2b3c4d5e6f',
'vehicle' => [
'id' => 'veh_3k12j9qksdf0',
'vin' => '1C4HJXEN5MW592818',
'year' => 2021,
'make' => 'Jeep',
'trim' => 'Sport',
'spec' => 'Off-Road Package',
'model' => 'Wrangler',
'engine' => '3.6L V6',
'seatCount' => 5,
'doorCount' => 4,
'bodyStyle' => 'SUV',
'drivetrain' => '4WD',
'transmission' => 'Automatic',
'interiorColor' => 'Black',
'exteriorColor' => 'Red'
],
'customer' => [
'id' => 'cus_k3j5s9qj3w0d',
'addresses' => [
'123 Main St, Anytown, USA'
],
'phoneNumbers' => [
'555-123-4567'
]
],
'odometer' => 15000,
'creditApp' => 'cre_5j6k7l8m9n0o',
'netAllowance' => 25000,
'grossAllowance' => 26000
]),
CURLOPT_HTTPHEADER => [
"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/trades/{customer}/{vehicle}"
payload := strings.NewReader("{\n \"deal\": \"dea_1a2b3c4d5e6f\",\n \"vehicle\": {\n \"id\": \"veh_3k12j9qksdf0\",\n \"vin\": \"1C4HJXEN5MW592818\",\n \"year\": 2021,\n \"make\": \"Jeep\",\n \"trim\": \"Sport\",\n \"spec\": \"Off-Road Package\",\n \"model\": \"Wrangler\",\n \"engine\": \"3.6L V6\",\n \"seatCount\": 5,\n \"doorCount\": 4,\n \"bodyStyle\": \"SUV\",\n \"drivetrain\": \"4WD\",\n \"transmission\": \"Automatic\",\n \"interiorColor\": \"Black\",\n \"exteriorColor\": \"Red\"\n },\n \"customer\": {\n \"id\": \"cus_k3j5s9qj3w0d\",\n \"addresses\": [\n \"123 Main St, Anytown, USA\"\n ],\n \"phoneNumbers\": [\n \"555-123-4567\"\n ]\n },\n \"odometer\": 15000,\n \"creditApp\": \"cre_5j6k7l8m9n0o\",\n \"netAllowance\": 25000,\n \"grossAllowance\": 26000\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://commerce.driv.ly/api/trades/{customer}/{vehicle}")
.header("Content-Type", "application/json")
.body("{\n \"deal\": \"dea_1a2b3c4d5e6f\",\n \"vehicle\": {\n \"id\": \"veh_3k12j9qksdf0\",\n \"vin\": \"1C4HJXEN5MW592818\",\n \"year\": 2021,\n \"make\": \"Jeep\",\n \"trim\": \"Sport\",\n \"spec\": \"Off-Road Package\",\n \"model\": \"Wrangler\",\n \"engine\": \"3.6L V6\",\n \"seatCount\": 5,\n \"doorCount\": 4,\n \"bodyStyle\": \"SUV\",\n \"drivetrain\": \"4WD\",\n \"transmission\": \"Automatic\",\n \"interiorColor\": \"Black\",\n \"exteriorColor\": \"Red\"\n },\n \"customer\": {\n \"id\": \"cus_k3j5s9qj3w0d\",\n \"addresses\": [\n \"123 Main St, Anytown, USA\"\n ],\n \"phoneNumbers\": [\n \"555-123-4567\"\n ]\n },\n \"odometer\": 15000,\n \"creditApp\": \"cre_5j6k7l8m9n0o\",\n \"netAllowance\": 25000,\n \"grossAllowance\": 26000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce.driv.ly/api/trades/{customer}/{vehicle}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"deal\": \"dea_1a2b3c4d5e6f\",\n \"vehicle\": {\n \"id\": \"veh_3k12j9qksdf0\",\n \"vin\": \"1C4HJXEN5MW592818\",\n \"year\": 2021,\n \"make\": \"Jeep\",\n \"trim\": \"Sport\",\n \"spec\": \"Off-Road Package\",\n \"model\": \"Wrangler\",\n \"engine\": \"3.6L V6\",\n \"seatCount\": 5,\n \"doorCount\": 4,\n \"bodyStyle\": \"SUV\",\n \"drivetrain\": \"4WD\",\n \"transmission\": \"Automatic\",\n \"interiorColor\": \"Black\",\n \"exteriorColor\": \"Red\"\n },\n \"customer\": {\n \"id\": \"cus_k3j5s9qj3w0d\",\n \"addresses\": [\n \"123 Main St, Anytown, USA\"\n ],\n \"phoneNumbers\": [\n \"555-123-4567\"\n ]\n },\n \"odometer\": 15000,\n \"creditApp\": \"cre_5j6k7l8m9n0o\",\n \"netAllowance\": 25000,\n \"grossAllowance\": 26000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"deal": "dea_1a2b3c4d5e6f",
"vehicle": {
"id": "veh_3k12j9qksdf0",
"vin": "1C4HJXEN5MW592818",
"year": 2021,
"make": "Jeep",
"trim": "Sport",
"spec": "Off-Road Package",
"model": "Wrangler",
"engine": "3.6L V6",
"seatCount": 5,
"doorCount": 4,
"bodyStyle": "SUV",
"drivetrain": "4WD",
"transmission": "Automatic",
"interiorColor": "Black",
"exteriorColor": "Red"
},
"customer": {
"id": "cus_k3j5s9qj3w0d",
"addresses": [
"123 Main St, Anytown, USA"
],
"phoneNumbers": [
"555-123-4567"
]
},
"odometer": 15000,
"creditApp": "cre_5j6k7l8m9n0o",
"netAllowance": 25000,
"grossAllowance": 26000
},
"success": true
}{
"error": {
"code": 401,
"message": "Unauthorized"
},
"success": false
}{
"error": {
"code": 404,
"message": "Trade Not Found"
},
"success": false
}{
"error": {
"code": 429,
"message": "Too Many Requests"
},
"success": false
}Path Parameters
Trade is uniquely identified by Customer
Trade is uniquely identified by Vehicle
Query Parameters
The number of levels of related objects to include in the response
Body
application/json
Customer offers Vehicle for trade
Trade is uniquely identified by Customer
Trade is uniquely identified by Vehicle
Trade provides Net Allowance
Must be a multiple of
0.01Trade provides Gross Allowance
Must be a multiple of
0.01Odometer is read for Trade
Required range:
x >= 0Credit App has Trade
Trade provides assets for Deal
Response
Trade Updated
Customer offers Vehicle for trade
Show child attributes
Show child attributes
Example:
{
"deal": "dea_1a2b3c4d5e6f",
"vehicle": {
"id": "veh_3k12j9qksdf0",
"vin": "1C4HJXEN5MW592818",
"year": 2021,
"make": "Jeep",
"trim": "Sport",
"spec": "Off-Road Package",
"model": "Wrangler",
"engine": "3.6L V6",
"seatCount": 5,
"doorCount": 4,
"bodyStyle": "SUV",
"drivetrain": "4WD",
"transmission": "Automatic",
"interiorColor": "Black",
"exteriorColor": "Red"
},
"customer": {
"id": "cus_k3j5s9qj3w0d",
"addresses": ["123 Main St, Anytown, USA"],
"phoneNumbers": ["555-123-4567"]
},
"odometer": 15000,
"creditApp": "cre_5j6k7l8m9n0o",
"netAllowance": 25000,
"grossAllowance": 26000
}