PATCH
/
trades
/
{customer}
/
{vehicle}
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
}'
{
  "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
}

Path Parameters

​
customer
string
required

Trade is uniquely identified by Customer

​
vehicle
string
required

Trade is uniquely identified by Vehicle

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Body

application/json

Customer offers Vehicle for trade

​
customer

Trade is uniquely identified by Customer

​
vehicle

Trade is uniquely identified by Vehicle

​
netAllowance
number

Trade provides Net Allowance

Must be a multiple of 0.01
​
grossAllowance
number

Trade provides Gross Allowance

Must be a multiple of 0.01
​
odometer
number

Odometer is read for Trade

Required range: x > 0
​
creditApp

Credit App has Trade

​
deal

Trade provides assets for Deal

Response

200
application/json
Trade Updated
​
data
object

Customer offers Vehicle for trade

​
success
boolean
Retrieve a TradeGet Trade Payoff Balances