Available fields for Automotive Ads inventory catalogs

Name

Required?

Description

Can users filter by this attribute?

vehicle_id

type: string

Yes

Max characters: 100

Unique ID for item. Can be a variant for a vehicle. If there are multiple instances of the same ID, we ignore all instances. You can also use the VIN for both vehicle_id and vin. Example: 1FADP5AU6DL536022

Yes

title

type: string

Yes

Max characters: 500

Recommend 40 or less for full title display. Full name of vehicle. This is relevant and specific to each vehicle and it should contain what is set in year, make, model, trim. Example: $299 per month for the EndoHatch GE

Yes

description

type: string

Yes

Max characters: 5000

Short text describing the vehicle. Don't include promotional text or any links. Don't enter text in all capital letters. Use line breaks to format your description. Example: Used 2017 Volvo XC90 in great condition, available now.

Yes

url

type: url

Yes

Link to the external site where you can view the vehicle listing. HTTP format required.

No

ios_url

type: url

No

Link to app landing page. If it is filled and user has the app installed, we will jump to this URL first. Otherwise, we will fall back to web url.

No

android_url

type: url

No

Link to app landing page. If it is filled and user has the app installed, we will jump to this URL first. Otherwise, we will fall back to web url

No

make

type: string

Yes

Max 100 characters

Make or brand of the vehicle. Example: Endomoto

Yes

model

type: string

Yes

Max 100 characters

Model of the vehicle. Example: EndoHatch

Yes

year

type: int

Yes

Year the vehicle was launched in yyyy format. Example: 2015

Yes

mileage.value

type: int

Yes

For used vehicles, current mileage of the vehicle in kilometers (kms) or miles (MI). For new vehicles, use zero (0). For Marketplace, vehicles must have over 500 miles/kms. Example: '1500'. Value greater than or equal to 0.

Yes

mileage.unit

type: string

Yes

Mileage units: MI (miles) or KM (kilometers)

No

image_link

type: string

Yes

Max items: Image must be at least 500x500px, but we recommend a 4:3 aspect ratio for best performance. Ideal image size is 800x600.

No

transmission

Type: string

No

Transmission type of the vehicle: Automatic or Manual.

Yes

body_style

Type: enum

Yes

Body style of the vehicle: CONVERTIBLE, COUPE, HATCHBACK, MINIVAN, TRUCK, SUV, SEDAN, VAN, WAGON, CROSSOVER, SMALL_CAR, or OTHER.

Yes

drivetrain

Type: enum

No

Vehicle drivetrain. Supported values: 4X2, 4X4, AWD, FWD, RWD, Other.

Yes

vin

Type: string

No

Max characters: 17. Vehicle ID number (VIN) of the vehicle. You can also use the VIN for both vehicle_id and vin. Note: The VIN must be exactly 17 characters and it isn't required for pre-1983 vehicles. Boats have less digits and some vehicles (such as trailers) don't need VINs. Example: 1FADP5AU6DL536022

Yes

price

Type: string

Yes

Cost and currency of the vehicle. Format the price as the cost, followed by the ISO currency code, with a space between cost and currency. Default currency is USD. Example: 18000 USD, 32000 USD

Yes

exterior_color

type: string

Yes

Max 100 characters

Vehicle color. Example: Black, White, Blue, Red

Yes

state_of_vehicle

type: string

Yes

Current state of the vehicle. Supported values: New, Used, or CPO (certified pre-owned).

Yes

fuel_type

type:string

No

Vehicle fuel type. Supported values: DIESEL, ELECTRIC, FLEX, GASOLINE, HYBRID, OTHER.

Yes

condition

type: string

No

Condition of the vehicle. Supported values: EXCELLENT, GOOD, FAIR, POOR, OTHER.

Yes

sale_price

type: string

No

Sale price or special price. Format the price as the cost, followed by the ISO currency code, with a space between cost and currency. Example: 16000 USD

Yes

availability

type: enum

No

Vehicle availability: available or not available. We don't show vehicles that are unavailable in the ad.

Yes

vehicle_type

type: string

No

Type of vehicle. Expected values: car_truck (default if not supplied), boat, commercial, motorcycle, powersport, rv_camper, trailer, or other.

Yes

trim

type: string

No

Max characters: 50

Trim of the vehicle. Example: 5DR HB SE

Yes

interior_color

type: string

No

Max characters: 100

Vehicle interior color.

Yes

date_first_on_lot

type: string

No

Date when this vehicle first arrived at the dealer lot. Used to indicate inventory age. Use the yyyy-mm-dd format. Example: 2018-09-05

Yes

days_on_lot

type: int

No

Number of days the vehicle has been on the lot. Should be incremented daily. Value greater than or equal to 0. Example: 62

Yes

custom_number_0

custom_number_1

custom_number_2

custom_number_3

custom_number_4

type: string

No

Up to five custom fields for any additional number-related information you want to filter items by when you create sets. This field allows you to filter by number ranges (is greater than and is less than) when you create a set. For example, you could use this field to indicate the year an item was produced, and then filter a certain year range into a set.

This field supports whole numbers between 0 and 4294967295. It doesn't support negative numbers, decimal numbers or commas, such as -2, 5.5 or 10,000. Example: 2022

Yes

Name

Description

Required?

Address format style 1: full address (do not use both styles)

address

type: string

Complete dealership physical address, formatted as:{addr 1: [STREET ADDRESS], city: [CITY], region: [STATE, COUNTY, REGION OR PROVINCE], country: [COUNTRY]. The postal code is optional. Example: {addr1: '550 Auto Center Dr', city: 'Watsonville', region: 'CA', postal_code: '96075', country: 'US'}

Yes

Address format style 2: multiple headers (do not use both styles)

address.addr1

type:string

Your dealer address (street and number). Example: 123 Foxglove Rd

Yes

address.city

type: string

City where the dealership is located. Example: Palo Alto

Yes

address.region

type: string

State, county, region, or province where the dealership is located. Example: California

Yes

address.country

type: string

Country where the dealership is located. Example: United States

Yes

latitude

type: float

Latitude of the dealership location. Example: 37.484100

Yes

longitude

type: float

Longitude of the dealership location. Example: -122.148252

Yes

address.postal_code

type: string

Postal code for dealership (outside the U.S. or zip code within the U.S.) .Example: 75008 (Paris, France) or 94025 (Menlo Park)

No

Additional optional dealer identifiers

dealer_id

type: string

Max characters: 100

Alphanumeric ID of the dealership.

No

dealer_name

type: string

Max characters: 100

Name of the dealership.

No

dealer_phone

type: string

Phone number of the dealership. Requirements: Must display the Call button on a Marketplace listing.Must be a valid phone number format. Must include the country code. Example: +1 3603453333, 001 (360)345-3333

No

stock_number

type: string

Dealership's own designation of the car on their lot. The stock number is a way for the dealer to inventory specific vehicles. Example: N8990

No