Create Car

POST

/api/cars

const url = 'https://dashboard.dealerstudio.com.au/api/cars';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"car":{"rego":"XYZ123","rego_expiry":"31/12/2023","stocknum":"S12345","vin":"1HGBH41JXMN109186","dealership_id":42,"location_id":1,"odometer":12345,"dapprice":29990,"egcprice":31990,"make":"Toyota","model":"Corolla","badge":"Ascent Sport","series":"ZRE182R","year":2023,"body":"Hatch","colour":"White","redbook_code":"AUVVOLK2014AERF","nvic_code":"QOV14A","interior_colour":"Black","transmission":"automatic","subscription_plan_id":"12345","fuel":"Petrol","certified":true,"doors":5,"seats":4,"drive":"FWD","grey_market_import":true,"locked_fields":["vin","dapprice"],"dealercomments":"This car is in excellent condition.","features":["Air Conditioning","Bluetooth","Cruise Control"],"status":"in_stock","car_type":"new","item_type":"car","compliance_date":"01/01/2023","build_date":"01/01/2023","show_on_dealer_website":true,"images":["https://www.example.com/image1.jpg","https://www.example.com/image2.jpg"],"external_video_url":"https://www.youtube.com/watch?v=12345","custom_attributes":[{"name":"custom_attribute_1","value":"value_1"}]}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://dashboard.dealerstudio.com.au/api/cars \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "car": { "rego": "XYZ123", "rego_expiry": "31/12/2023", "stocknum": "S12345", "vin": "1HGBH41JXMN109186", "dealership_id": 42, "location_id": 1, "odometer": 12345, "dapprice": 29990, "egcprice": 31990, "make": "Toyota", "model": "Corolla", "badge": "Ascent Sport", "series": "ZRE182R", "year": 2023, "body": "Hatch", "colour": "White", "redbook_code": "AUVVOLK2014AERF", "nvic_code": "QOV14A", "interior_colour": "Black", "transmission": "automatic", "subscription_plan_id": "12345", "fuel": "Petrol", "certified": true, "doors": 5, "seats": 4, "drive": "FWD", "grey_market_import": true, "locked_fields": [ "vin", "dapprice" ], "dealercomments": "This car is in excellent condition.", "features": [ "Air Conditioning", "Bluetooth", "Cruise Control" ], "status": "in_stock", "car_type": "new", "item_type": "car", "compliance_date": "01/01/2023", "build_date": "01/01/2023", "show_on_dealer_website": true, "images": [ "https://www.example.com/image1.jpg", "https://www.example.com/image2.jpg" ], "external_video_url": "https://www.youtube.com/watch?v=12345", "custom_attributes": [ { "name": "custom_attribute_1", "value": "value_1" } ] } }'

The below two endpoints can be used to create and update cars.

Authorizations

Bearer

Request Body^required

application/json

object

rego

string

rego_expiry

string

stocknum

required

string

vin

string

dealership_id

required

integer

location_id

integer

odometer

integer

dapprice

integer

egcprice

integer

advertised_price

Optional. If we have both EGC and DAP prices on a car, this will specify which one to use

string

Allowed values: EGC DAP

make

required

string

model

required

string

badge

string

series

string

year

required

integer

body

string

colour

string

interior_colour

string

transmission

string

fuel

string

doors

integer

seats

integer

redbook_code

string

nvic_code

string

drive

string

dealercomments

string

features

Array<string>

status

string

Allowed values: in_stock sold coming_soon withdrawn deal_pending incomplete loaner

car_type

string

Allowed values: new demo used

item_type

string

Allowed values: car caravan truck bike bus machinery trailer

compliance_date

string

external_video_url

string

show_on_dealer_website

boolean

rego_state

string

Allowed values: QLD NSW VIC WA NT ACT TAS SA

load_to_autogate

boolean

grey_market_import

boolean

locked_fields

Array<string>

load_to_autotrader

boolean

load_to_drive

boolean

images

Array<string>

match_existing_car_by_stocknum

If supplied, will match the car against a vehicle with matching stocknum (if exists)

boolean

Example

{
  "car": {
    "rego": "XYZ123",
    "rego_expiry": "31/12/2023",
    "stocknum": "S12345",
    "vin": "1HGBH41JXMN109186",
    "dealership_id": 42,
    "location_id": 1,
    "odometer": 12345,
    "dapprice": 29990,
    "egcprice": 31990,
    "make": "Toyota",
    "model": "Corolla",
    "badge": "Ascent Sport",
    "series": "ZRE182R",
    "year": 2023,
    "body": "Hatch",
    "colour": "White",
    "redbook_code": "AUVVOLK2014AERF",
    "nvic_code": "QOV14A",
    "interior_colour": "Black",
    "transmission": "automatic",
    "subscription_plan_id": "12345",
    "fuel": "Petrol",
    "certified": true,
    "doors": 5,
    "seats": 4,
    "drive": "FWD",
    "grey_market_import": true,
    "locked_fields": [
      "vin",
      "dapprice"
    ],
    "dealercomments": "This car is in excellent condition.",
    "features": [
      "Air Conditioning",
      "Bluetooth",
      "Cruise Control"
    ],
    "status": "in_stock",
    "car_type": "new",
    "item_type": "car",
    "compliance_date": "01/01/2023",
    "build_date": "01/01/2023",
    "show_on_dealer_website": true,
    "images": [
      "https://www.example.com/image1.jpg",
      "https://www.example.com/image2.jpg"
    ],
    "external_video_url": "https://www.youtube.com/watch?v=12345",
    "custom_attributes": [
      {
        "name": "custom_attribute_1",
        "value": "value_1"
      }
    ]
  }
}

Create Car

Authorizations

Request Body^required

Example

Responses

200

422

Create Car

Authorizations

Request Body required

Example

Responses

200

422

Request Body^required