Vehicles (Inventory)
A Vehicle instance resource represents a vehicle within your Organization. Once a Vehicle is created within autoZnetwork, it will be acessible through all products offered to your Organization.
The inventory list resource represents all of the vehicles that you have created on your account within autoZnetwork. You can POST to inventory to create a new vehicle or modify an existing vehicle.
Properties
Property | Type | Description |
---|---|---|
id | Integer | The ID of the Vehicle that is assigned to the Vehicle. |
active | Boolean | Identifies if the Vehicle is currently activated. |
status | String | Identifies the retail status of the Vehicle. |
title_status | String | Identifies the title status of the Vehicle. |
type | String | Identifies the vehicle as Used, New, or Certified. |
stock | String | The stock number of the Vehicle. |
vin | String | The VIN of the Vehicle. |
name | String | Associated name assigned by autoZnetwork for the Vehicle. |
slug | String | URL friendly identifier of the name of the Vehicle. |
price | Object | An array of prices for the vehicle. (selling, internet, retail) |
year | String | The year the Vehicle was manufactured. |
make | String | The manufacturer of the Vehicle (Free Text). |
model | String | The model of the Vehicle (Free Text). |
trim | String | The trim of the Vehicle (Free Text). |
body_style | String | The normalized Body Style of the Vehicle. |
exterior | Object | Object of exterior details for the vehicle. |
exterior.color | String | Friendly exterior color identifier. |
exterior.manufacturer_color | String | The exterior color provided by the manufacturer. |
interior | Object | Object of interior details for the vehicle. |
interior.type | String | The material/upholestry in the vehicle. |
interior.color | String | Friendly interior color identifier. |
interior.manufacturer_color | String | The interior color provided by the manufacturer. |
odometer | Object | Object of odometer for the vehicle. |
odometer.value | Integer | The number of miles or kilometers on the odometer. |
odometer.unit | String | The unit of measurement on the odometer. |
image | String | First image of the vehicle. |
owners | Integer | Number of owners of the Vehicle (Free Text). |
doors | Integer | Number of doors on the Vehicle (Free Text). |
seats | Integer | Number of seats in the Vehicle (Free Text). |
drivetrain | String | Drivetrain for the Vehicle (Free Text). |
transmission | Object | Transmission details for the Vehicle. |
transmission.name | String | Name of the transmission (Free Text). |
transmission.type | String | The type of transmission (Free Text). |
transmission.speed | Integer | Speed of the transmission (Free Text). |
engine.name | String | Name of the engine (Free Text). |
engine | Object | Engine details for the Vehicle. |
engine.name | String | Name of the engine (Free Text). |
engine.displacement | Float | The displacement of the engine (Free Text). |
engine.cylinders | Integer | The cylinders of the engine (Free Text). |
description | String | The description of the Vehicle. |
options | Array | Array of Options attached the Vehicle (Free Text). |
stocked_in_at | DateTime | DateTime the Vehicle was stocked into the DMS. |
sold_at | DateTime | DateTime the Vehicle was marked as sold. |
created_at | DateTime | DateTime the Vehicle was created. |
updated_at | DateTime | DateTime the Vehicle was last updated. |
Relationships
Relationship | Description |
---|---|
Organization | The Organization the Vehicle belongs to. |
Location | The Location assigned to the Vehicle. Must belong to the Organization. |
Images | The images attached to the vehicle (See Inventory Image CDN for advanced customization in your inventory request). |
List all the vehicles in inventory
GET https://api.autoznetwork.com/v1/inventory
AUTOZNETWORK_TOKEN="your API token"
AUTOZNETWORK_ORG_ID="your organization id"
curl https://api.autoznetwork.com/v1/inventory \
-H "Authorization: Bearer $AUTOZNETWORK_TOKEN" \
-H "X-AutozNetwork-Organization-Id: $AUTOZNETWORK_ORG_ID" \
-H 'Accept: application/json'
Add a vehicle to inventory
When adding images to a vehicle, autoZnetwork will queue the image processing asynchronously. The initial 201 response will not contain the images as we pull are processing in the background.
POST Request: https://api.autoznetwork.com/v1/inventory
AUTOZNETWORK_TOKEN="your API token"
AUTOZNETWORK_ORG_ID="your organization id"
AUTOZNETWORK_LOCATION_ID="your location id"
curl https://api.autoznetwork.com/v1/inventory \
-H "Authorization: Bearer $AUTOZNETWORK_TOKEN" \
-H "X-AutozNetwork-Organization-Id: $AUTOZNETWORK_ORG_ID" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"location_id": "\'$AUTOZNETWORK_LOCATION_ID'\",
"active": true,
"stock": "12345",
"vin": "123456789ABCDEFGH",
"url": "https://www.yourwebsite.com/vdp/12345",
"make": "Ford",
"model": "F-150",
"trim": "XLT SVT Raptor 4x4",
"miles": 5000,
"type": "Used",
"year": "2015",
"price": {
"selling": 19999,
"internet": 18999,
"msrp": 21999
},
"options": "Cruise Control,Bluetooth,Keyless Entry",
"images: "https://cdn.com/image.jpg,https://cdn.com/image2.jpg,https://cdn.com/image3.jpg"
}'
Parameters
Parameter | Type | Description |
---|---|---|
location_id | Integer | Required The Location identifier the Vehicles belongs to, accesible in your account profile. |
stock | String | Required The stock number of the Vehicle. |
vin | String | Required The vin of the Vehicle. |
make | String | The make of the Vehicle. |
model | String | The model of the Vehicle. |
trim | String | The trim of the Vehicle. |
price | Integer, Double, Array | The price of the Vehicle. If an integer or Double is passed autoZnetwork defaults to the "selling" price. |
miles | Integer | The miles of the Vehicle. |
type | String | The class of the Vehicle: New , Used , Certified . |
year | Integer | The year of the Vehicle. |
url | String | The URL of the Vehicle VDP on your website. |
body_style | String | The body style of the Vehicle: Truck , Coupe , Sedan , SUV , Convertible , Hatchback , Minivan-Van , Wagon , Limousine , RV , Motorcycle , Snowmobile , ATV-Quad , Trailer , PWC , Other . |
body_type | String | The body type of the Vehicle: TBD . |
fuel | String | The fuel used by the Vehicle: Biodiesel , Diesel , Electric , FFV-Ethanol , Gas , Hybrid-Electric , Other , CNG . |
exterior_color | String | The exterior color of the Vehicle: Black , Blue , Brown , Burgundy , Gold , Gray , Green , Orange , Purple , Red , Silver , Tan , Teal , White , Yellow , Khaki , Beige , Slate , Pewter , Charcoal . |
interior_color | String | The interior color of the Vehicle: Black , Blue , Brown , Burgundy , Gold , Gray , Green , Orange , Purple , Red , Silver , Tan , Teal , White , Yellow , Khaki , Beige , Slate , Pewter , Charcoal . |
interior_type | String | The interior type of the Vehicle: Leather , Cloth , Vinyl . |
title_status | String | The title status of the Vehicle: Clear , Salvage , Rebuilt , Parts Only . |
tonnage | String | The tonnage of the Vehicle: Quarter Ton , Half Ton , Three Quarter Ton , One Ton , One and a Half Ton , Two Ton . |
transmission_type | String | The transmission type of the Vehicle: Manual , Automatic . |
transmission_speed | String | The transmission speed of the Vehicle: 4 Speed , 5 Speed , 6 Speed , 7 Speed . |
drive_type | String | The drive type of the Vehicle: FWD , RWD , 4x4 , AWD . |
lifted | Boolean | Whether the Vehicle is lifted. |
lowered | Boolean | Whether the Vehicle is lowered. |
doors | Double | The amount of doors on the Vehicle. |
seats | Integer | The amount of seats in the Vehicle. |
engine_displacement | Double | The engine displacement of the Vehicle. |
engine_cylinders | Integer | The engine cylinders of the the Vehicle. |
options | String | Vehicle options separated by commas. |
images | String | Vehicle images URLs separated by commas. |
Response
{
"id": 5000,
"stock": "12345",
"vin": "ABCDEFG123456789",
"name": "2018 Ford F-150 XLT SVT Raptor 4x4",
"year": "2018",
"make": "Ford",
"model": "F-150",
"trim": "XLT SVT Raptor 4x4",
"price": {
"selling": 19999,
"internet": 18999,
"msrp": 21999
},
"created_at": "2020-07-29 16:08:30",
"updated_at": "2020-07-29 16:08:30",
"organization": {
"id": 11,
"name": "Your Awesome Dealership",
"createdAt": "2020-06-30 17:25:40",
"updatedAt": "2020-07-02 19:53:58"
},
}
Mark a vehicle as Sold
POST Request: https://api.autoznetwork.com/v1/inventory/{inventory_id}/sold
AUTOZNETWORK_TOKEN="your API token"
AUTOZNETWORK_ORG_ID="your organization id"
curl -X POST https://api.autoznetwork.com/v1/inventory/{inventory_id}/sold \
-H "Authorization: Bearer $AUTOZNETWORK_TOKEN" \
-H "X-AutozNetwork-Organization-Id: $AUTOZNETWORK_ORG_ID" \
-H 'Accept: application/json' \
Mark a vehicle as In Stock (Not Sold)
POST Request: https://api.autoznetwork.com/v1/inventory/{inventory_id}/in-stock
AUTOZNETWORK_TOKEN="your API token"
AUTOZNETWORK_ORG_ID="your organization id"
curl -X POST https://api.autoznetwork.com/v1/inventory/{inventory_id}/in-stock \
-H "Authorization: Bearer $AUTOZNETWORK_TOKEN" \
-H "X-AutozNetwork-Organization-Id: $AUTOZNETWORK_ORG_ID" \
-H 'Accept: application/json' \