Response Structure

The root key in every response is:

message

Depending on the request, this key contains:

A single stock item object (detailed response)

Identification Fields

stock_no.name – Unique identifier of the stock item
stock_no.alternate_stock_no – Secondary or alternate stock number assigned to the item

Vehicle Fields

vehicle_item.main_image – URL of the vehicle’s primary displayed image
vehicle_item.vin – Vehicle Identification Number recorded for the unit
vehicle_item.current_mileage – Latest recorded mileage on the vehicle

Inventory & Status Fields

stock_no.inventory_stage – Current stage/status of the item within the inventory workflow
serial_no.status – Operational or availability status of the vehicle's serial number
stock_no.sales_status – Sales lifecycle status of the stock item (e.g., available, sold)

Title Fields

vehicle_title_history.title_status – Current legal title status of the vehicle
vehicle_title_history.title_type – Type/category of the vehicle’s title (e.g., clean, salvage)

Acquisition Fields

stock_no.acquisition_cost – Total cost incurred to acquire the vehicle
stock_no.acquisition_type – Method or category of acquisition (e.g., trade-in, purchase)
stock_no.acquisition_date – Date on which the vehicle was acquired

Metadata Fields

stock_no.company_branch – Company branch/location associated with this stock item
serial_no.company – Company linked to the serial number record
stock_no.modified – Timestamp of the most recent update to the stock item
stock_no.item – Item reference or master item identifier for the stock record

Example Response:

{
  "message": {
    "rowData": [
      {
        "stock_no.name": "string",
        "vehicle_item.main_image": "string or null",
        "stock_no.alternate_stock_no": "string or null",
        "vehicle_item.vin": "string",
        "stock_no.inventory_stage": "string",
        "serial_no.status": "string",
        "stock_no.sales_status": "string",
        "vehicle_title_history.title_status": "string",
        "vehicle_title_history.title_type": "string",
        "vehicle_item.current_mileage": "string or number",
        "stock_no.company_branch": "string or null",
        "stock_no.acquisition_cost": 0,
        "serial_no.company": "string",
        "stock_no.modified": "string",
        "stock_no.acquisition_type": "string",
        "stock_no.acquisition_date": "string or null",
        "stock_no.item": "string"
      }
    ],
    "user_info": {}
  }
}