Retrieve a vehicle

Updated:

GET/dms/{connection_id}/vehicle/{id}

Retrieves a single DmsVehicle by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Vehicle

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_inventorybooleanNoTrue for a dealer stock unit, false for a customer-owned or service vehicle
vinstringNoVehicle identification number, or serial number / HIN for non-road units
stock_numberstringNoDealer stock number
fleet_numberstringNoCustomer or fleet unit number
license_platestringNo
yearnumberNoModel year
makestringNo
modelstringNo
trimstringNoTrim, variant or series
model_codestringNoManufacturer model code
descriptionstringNoFree-text vehicle description
typeenumNoValues: CAR, TRUCK, VAN, SUV, MOTORCYCLE, BUS, RV, BOAT, TRAILER, EQUIPMENT, OTHER
body_stylestringNo
conditionenumNoValues: NEW, USED, DEMO, OTHER
is_certifiedbooleanNoCertified pre-owned
statusenumNoStock status; only set for inventory units Values: AVAILABLE, ON_ORDER, IN_TRANSIT, RESERVED, SOLD, UNAVAILABLE, OTHER
odometernumberNoCurrent odometer or meter reading
odometer_unitenumNoValues: MILES, KILOMETERS, HOURS, OTHER
exterior_colorstringNo
interior_colorstringNo
fuel_typeenumNoValues: GASOLINE, DIESEL, ELECTRIC, HYBRID, HYDROGEN, LPG, NATURAL_GAS, OTHER
transmissionstringNoTransmission description
currencystringNoISO 4217 currency code
price_amountnumberNoAsking or selling price of a stock unit
msrp_amountnumberNoManufacturer's suggested retail price
internet_price_amountnumberNoAdvertised internet price
cost_amountnumberNoDealer total cost of the unit
received_atstring (date-time)NoWhen the unit arrived in stock (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sold_atstring (date-time)NoWhen the unit was last sold (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
delivered_atstring (date-time)NoWhen the vehicle was delivered to its current owner (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
in_service_atstring (date-time)NoWarranty in-service date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
warranty_expires_atstring (date-time)NoFactory warranty expiry date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
last_service_atstring (date-time)NoLast service visit (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
contact_idstringNoOwner, as a CRM Contact, when the owner is an individual
company_idstringNoOwner, as a CRM Company, when the owner is a business or fleet
optionsDmsVehicleOption[]NoInstalled options and packages
options[].codestringNoOption or RPO code
options[].descriptionstringNo
options[].typeenumNoFactory-fitted or dealer-added Values: FACTORY, DEALER, OTHER
options[].price_amountnumberNoRetail price
options[].cost_amountnumberNoDealer cost
image_urlsstring[]NoPublic photo URLs
is_publishedbooleanNoUnit is published to the dealer website
is_activebooleanNo
metadataDmsMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field.
metadata[].valueobjectNoThe field's value, typed by format.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/dms/5de520f96e439b002043d8dc/vehicle/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?