Skip to content

Vehicle Schema

Complete field reference for the vehicle payload.

Based on the CSN-DTO Vehicle standard. All fields marked Required must be present for the request to succeed.

Vehicle (root)

FieldTypeRequiredDescription
TypestringYesCar, Bike, Boat, Truck, Caravan, Construction, Agriculture
IdentifierGUID / numberYesUnique identifier for this vehicle item
ListingTypestringYesNew (no previous owner), Used (registered/previous owner), Showroom, Demo
SaleStatusstringYesFor Sale, In Stock, WITHDRAWN, Sold
SaleTypestringNoSale, Share, Rent, Auction
DescriptionstringNoVehicle comments/description. HTML is sanitized on ingest
SlugstringNoURL-friendly identifier for the listing
LastModifiedUtcDateTimeNoServer-generated if not provided (ISO 8601, UTC)
CreatedUtcDateTimeNoServer-generated if not provided (ISO 8601, UTC)

Identification

Array of TypeValue pairs identifying the vehicle.

FieldTypeRequiredDescription
TypestringYesStockNumber, VIN, HIN, Engine, Chassis, NetworkId
ValuestringYesThe identifier value

At least one entry with Type: "StockNumber" is required.

Specification

FieldTypeRequiredDescription
MakestringYesVehicle make, e.g. “Ford”
ModelstringYesVehicle model, e.g. “Ranger”
SeriesstringNoModel series, e.g. “P703”
SpecificationSourcestringNoData source: REDBOOK, Glasses, JATO, CUSTOM
SpecificationCodestringNoCode from the specification source
CountryCodestringNoISO two-char country code, e.g. AU, NZ
TitlestringNoFull specification title
FranchisestringNoFranchise brand (for multi-franchise dealers)
ReleaseDate.YearnumberNoModel release year

Specification Attributes

Array of SpecificationAttribute Name/Value pairs under Specification.Attributes:

NameTypeDescription
Badgestringe.g. “XLT”, “Touring”, “Ultimate”
EngineTypestringe.g. “Piston”, “Electric”, “Piston - Electric”
EngineSizenumberEngine capacity in cc
CylindersnumberNumber of cylinders
FuelTypestringe.g. “Diesel”, “Petrol”, “Petrol - Premium ULP”
Transmissionstringe.g. “Automatic”, “Manual”
GearsnumberNumber of gears
Drivestringe.g. “Four Wheel Drive”, “Front Wheel Drive”
BodyStylestringe.g. “SUV”, “Sedan”, “Ute”, “Dual Cab Ute”
DoorsnumberNumber of doors
SeatsnumberSeating capacity

Colours

Array of SimpleColour objects:

FieldTypeDescription
LocationstringExterior or Interior
GenericstringGeneric colour bucket: Black, Blue, Grey, White, Gold, Silver, Red, Yellow, Purple, Green, Brown
NamestringManufacturer or friendly colour name, e.g. “Diamond Black”

Media

FieldTypeDescription
Photos[].UrlstringPhoto URL. First photo becomes the main listing image
Photos[].ThumbUrlstringThumbnail URL
Photos[].OrdernumberDisplay order (0-based)

PriceList

Array of Price objects:

FieldTypeDescription
TypestringDAP (drive away), EGC (exc. govt. charges), RRP, WHS, IGC
CurrencystringISO currency code, e.g. AUD
AmountnumberPrice amount

Odometer

Array of OdometerReading objects:

FieldTypeDescription
ValuenumberOdometer reading value
UnitOfMeasurestringSI unit: KM, Miles, Hour

Registration

FieldTypeDescription
NumberstringRegistration plate number
ExpiresUtcDateTimeRegistration expiry (ISO 8601)

Dates

FieldTypeDescription
ComplianceDateSimpleDate{ Day, Month, Year } — compliance plate date
BuildDateSimpleDate{ Day, Month, Year } — date of manufacture

Certifications

FieldTypeDescription
Certifications[].Typestringe.g. COI (Certificate of Inspection)
Certifications[].NamestringCertification name

Also accepted as: Certification.CertificationType (shorthand).

Features

Object with categorised feature lists:

{
  "Safety & Security": ["ABS", "Airbag - Driver"],
  "Comfort & Convenience": ["Climate Control"],
  "Exterior": ["LED Headlamps"],
  "Seating": ["Heated Seats - 1st Row"],
  "Wheels & Tyres": ["18 Inch Alloy Wheels"]
}