Dealership APITrade-In

Trade-In entity

Read customer trade-in records with vehicle condition scores, photos, valuation data, payoff amount, and lead summary.

#Endpoints

Trade-ins are customer-submitted vehicles attached to leads and inquiries.

GET/v1/trade-ins
GET/v1/trade-ins/{id}
Auth
Send the dealership API key in the x-api-key header.
Detail IDs
Detail routes use the UUID returned by the corresponding list endpoint.
Dates
Date fields and date filters use ISO 8601 timestamps.

#Filters and Limits

List endpoints share the same pagination envelope. Query booleans use true or false.

ParameterTypeRequiredNotes
limitnumberNoNumber of records to return. Defaults to 100. Maximum is 500.
offsetnumberNoNumber of records to skip. Defaults to 0.
searchstringNoOptional text search. Searchable fields are listed on each entity.
createdAfterdatetimeNoReturn records created at or after an ISO 8601 timestamp.
createdBeforedatetimeNoReturn records created at or before an ISO 8601 timestamp.
updatedAfterdatetimeNoReturn records updated at or after an ISO 8601 timestamp.
updatedBeforedatetimeNoReturn records updated at or before an ISO 8601 timestamp.
Entity filters
Common list filters plus search.
Search fields
vin, vehicleTitle, comments, lead name, and lead email.
JSON
{
  "data": [],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 0
  }
}

#Response

FieldTypeNullableNotes
iduuidNoTrade-in ID.
leadLeadSummaryNoLead that owns the trade-in.
vinstringYesSubmitted VIN.
vehicleTitlestringNoSubmitted vehicle title.
yearnumberNoVehicle year.
odometernumberNoOdometer reading.
photosurl[]NoSubmitted photo URLs.
issuesstring[]NoSubmitted issues.
valuationobjectNoValuation provider, status, amount, grade, and fetch timestamp.
payoffAmountnumberYesSubmitted payoff amount.
createdAtdatetimeNoCreation timestamp.
updatedAtdatetimeNoLast update timestamp.
Fields
Includes vehicle title, VIN, year, odometer, photos, condition scores, issues, comments, lead summary, valuation object, payoff amount, createdAt, and updatedAt.

#Example Request

Shell
curl "https://api.driverseat.io/v1/trade-ins?search=f-150" \
  -H "x-api-key: sk-driverseat-..."

#Errors

400
Invalid query parameter or resource ID. Common causes include a limit above 500, an invalid UUID, an invalid datetime, or an unsupported enum value.
401
The API key is missing, invalid, or revoked.
404
The requested trade-in does not exist or does not belong to the dealership authorized by the API key.