Endpoint Reference

Vehicles API

The Vehicles API returns vehicle inventory records from the dealer system. It can return all in-stock vehicles, optionally filtered by retail or wholesale type, or return a single vehicle by stock number. When requested, cost and expense detail can also be included for each vehicle.

Overview Endpoint Authentication Parameters Field Mapping Examples Sample Response

Method

GET

Returns one or more vehicle records from inventory.

Endpoint

/v1/vehicles.asp

Inventory lookup endpoint for vehicles.

Optional Filter

stknum

Pass a stock number to return a single vehicle record.

Overview

This endpoint is designed for inventory retrieval. By default it returns only vehicles that are currently in stock. If a stock number is supplied, the endpoint will return that specific vehicle regardless of inventory status. This supports both full inventory feed scenarios and single-vehicle lookup scenarios.

Flexible retrieval

Use this endpoint for bulk inventory integrations, filtered retail or wholesale views, or a single record lookup when a known stock number is available.

Cost detail is optional

When costs=y is supplied, the response includes a costs object with ACV, cost adjustment, and a nested vehiclehistory array. Each expense record may also include a vendor child object when a vendor is associated with that entry.

Endpoint

Property	Value
Method	GET
URL	https://api.carprolive.com/v1/vehicles.asp
Purpose	Returns vehicle inventory records, with optional cost detail.

Authentication

Requests to this endpoint use header-based authentication and require both a vendor key and an integration key.

Header	Required	Description
X-Vendor-Key	Yes	Vendor authentication key.
X-Integration-Key	Yes	Dealer integration key.

X-Vendor-Key: {YOUR-VENDOR-KEY}
X-Integration-Key: {YOUR-CLIENT-INTEGRATION-KEY}

Parameters

The Vehicles API supports optional query string parameters for inventory type filtering, cost detail, and stock number lookup.

Name	Type	Required	Description
rw	string	No	Retail/wholesale filter. R = Retail, W = Wholesale, A = All. Default is R.
costs	string	No	Pass y to include cost and vehicle history expense detail.
stknum	string	No	Optional stock number filter. When passed, the endpoint returns only that vehicle and ignores the default in-stock filter.

Field Mapping

The response is grouped into request metadata, vehicle records, and optional cost details. Vehicle status is derived from the inventory status field in the DMS.

Top-level groups

request, data, meta, and optionally costs with nested vehiclehistory.

Status mapping

status is derived from inventory status:
0 = incoming
1 = in-stock
2 = delivered

Field	Description
request.rw	Retail/wholesale filter passed in the request.
request.costs	Indicates whether cost detail was requested.
request.stknum	Stock number filter passed in the request, if any.
request.records	Total number of records returned.
stock_number	Vehicle stock number.
status	Vehicle inventory status (incoming, in-stock, delivered).
year	Vehicle model year.
make	Vehicle make.
model	Vehicle model.
vin	Vehicle VIN.
location	Inventory location.
gross_weight_rating	GVWR or related gross weight value.
retail_wholesale	Vehicle retail/wholesale designation.
costs.acv	Actual cash value.
costs.cost_adjust	Cost adjustment value.
costs.vehiclehistory	Expense history list for the vehicle.
vehiclehistory.vendor	Vendor linked to the specific expense entry, when present.

Example Requests

The examples below show common request patterns for inventory feeds, single vehicle lookups, and cost detail retrieval.

curl -X GET "https://api.carprolive.com/v1/vehicles.asp" \
-H "X-Vendor-Key: {YOUR-VENDOR-KEY}" \
-H "X-Integration-Key: {YOUR-CLIENT-INTEGRATION-KEY}"

https://api.carprolive.com/v1/vehicles.asp
https://api.carprolive.com/v1/vehicles.asp?rw=A
https://api.carprolive.com/v1/vehicles.asp?stknum=22-890
https://api.carprolive.com/v1/vehicles.asp?costs=y
https://api.carprolive.com/v1/vehicles.asp?costs=y&stknum=22-890

Sample Response

The sample below shows a single-vehicle response where a stock number was passed and cost detail was requested.

{
  "success": true,
  "request": {
    "rw": "R",
    "costs": true,
    "stknum": "22-890",
    "records": 1
  },
  "data": [
    {
      "stock_number": "22-890",
      "status": "in-stock",
      "year": 2018,
      "make": "GMC",
      "model": "SIERRA",
      "vin": "3GTU2PEJ7JG219539",
      "location": "1",
      "gross_weight_rating": "GVWR; 7200 lbs. (3266 kg) (Requires 4WD models.)",
      "options": "",
      "fuel": "GAS",
      "passengers": 5,
      "transmission": "AUTO",
      "car_truck": "CAR",
      "retail_wholesale": "RETAIL",
      "pack": 500,
      "damage": "",
      "defects": "",
      "features": "",
      "comments": "",
      "costs": {
        "acv": 37800,
        "cost_adjust": 189,
        "vehiclehistory": [
          {
            "rid": 1519334,
            "stock_number": "22-890",
            "vehiclehistory_vendor_id": 197,
            "company_link": 0,
            "qb_class": "",
            "amount": 189,
            "vendor": {
              "rid": 197,
              "name": "Vendor Name",
              "address": "123 Main St",
              "city": "Anytown",
              "state": "NH",
              "zip": "00000",
              "phone": "555-555-5555",
              "fax": "",
              "email": "vendor@example.com",
              "account_number": "",
              "gov_code": ""
            }
          }
        ]
      }
    }
  ],
  "meta": {
    "count": 1
  }
}