Data Models

The objects, enums and ID lookups used in the Public Lead API.

Vehicle object

Elements of the vehicles array:

Field	Type	Required	Description
year	Integer	✅	Model year
make	String	✅	Make (Toyota, Tesla…)
model	String	✅	Model (Camry, Model S…)
type	String (enum)	✅	Vehicle type — table below
tariff	Integer	✅	Shipping price
deposit	Integer	✅	Down payment
vehicle_run	Boolean	⚠️ TODO verify	Whether the vehicle runs (sample has true)

Vehicle type enum

vehicle.type must be one of the following values:

Value	Meaning
ATV	ATV / quad bike
BOAT	Boat
CAR	Passenger car
MOTORCYCLE	Motorcycle
PICKUP	Pickup truck
SUV	SUV / crossover
VAN	Van

:::note Enum completeness The values above come from the source docs. The complete, up-to-date list must stay in sync with the backend enum — if a new type is added, get it from the backend team. :::

origin_state — state ID lookup

The origin_state field takes not a city/state name, but an integer ID from the Navigo database. Get the IDs from the Navigo states endpoint:

GET /api/v1/common/states/?size=60

Sample response:

[
  { "id": 5, "name": "California" },
  { "id": 12, "name": "New York" }
]

Then send the id of the desired state as origin_state:

{
  "origin_city": "Los Angeles",
  "origin_state": 5,
  "origin_zip": "90001"
}

:::warning TODO: verify — is the states endpoint public? Whether /api/v1/common/states/ is reachable with a public API key or JWT-only must be confirmed with the backend. If it is not public, we recommend providing providers with a static state-ID table (CSV / attachment). :::

state — lead status enum

The state field in the lead response:

Value	Meaning
LEAD	Newly created, not yet processed
QUOTE	Turned into a price quote
ORDER	Turned into an order