Skip to main content
GET
/
trades
/
{customer}
/
{vehicle}
Retrieve a Trade
curl --request GET \
  --url https://commerce.driv.ly/api/trades/{customer}/{vehicle}
{
  "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

Response

Trade Found

data
object

Customer offers Vehicle for trade

Examples:
{
"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
boolean
I