Skip to content

Commit 3271d2c

Browse files
committed
Add documentation for startingPrice, highestPrice, etc.
1 parent 5d9b169 commit 3271d2c

File tree

1 file changed

+34
-7
lines changed

1 file changed

+34
-7
lines changed

source/includes/_events.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Field Key | Example Value | Field Format
102102
exteriorColor: "Crystal Black Pearl",
103103
finalPrice: 32000,
104104
fuelType: "Regular Unleaded",
105-
highestPrice: 34000,
105+
highestPrice: 34500,
106106
highwayFuelEconomy: 34,
107107
images: [
108108
"https://pictures.dealer.com/f/futuredemodealer/1182/0686eb936bd7a4905f751493cc28dcb9x.jpg"
@@ -120,6 +120,7 @@ Field Key | Example Value | Field Format
120120
"123",
121121
"321"
122122
],
123+
startingPrice: 34000,
123124
stockNumber: "00100060",
124125
transmission: "Variable",
125126
trim: "Touring 2WD",
@@ -129,10 +130,33 @@ Field Key | Example Value | Field Format
129130
}
130131
```
131132

132-
Field Key | Example Value | Field Format
133-
-------------- | -------------- | --------------
133+
Vehicle pricing is a particularly flexible piece of our system. With flexibility often comes complexity, so we provide several fields on the vehicle object to simplify and standardize the pricing information for the API consumer.
134+
135+
`startingPrice` is the first pricing value displayed on the vehicle. It is often the highest price displayed to the user. In some cases a dealer fee can increase the price later in the pricing stack.
136+
137+
`finalPrice` is the lowest price displayed on the vehicle not including conditional incentives. This is intended to be the price that the dealership is willing to sell the vehicle at, less any special offers that are only applicable to some customers.
138+
139+
`highestPrice` is the greater of all of the available pricing field values. It is typically the highest price shown to the user on the page, but in some cases can be higher than what is displayed to the user. This field is `deprecated` and may be removed at a later date with sufficient notice.
140+
141+
It is recommended that you use `startingPrice` for the most expensive price displayed to the user and `finalPrice` for the least expensive price displayed to the user.
142+
143+
You may notice one or more of these fields available in the vehicle object on some sites:
144+
145+
`askingPrice`
146+
`internetPrice`
147+
`msrp`
148+
`retailValue`
149+
`salePrice`
150+
`wholesalePrice`
151+
152+
All of the above fields are `deprecated`, meaning they may be removed from the API at a later date. New integrations should not use any of the above fields and should instead rely on `startingPrice` or `finalPrice` for the correct vehicle pricing information.
153+
154+
155+
Field Key | Example Value | Field Format | Status
156+
-------------- | -------------- | -------------- | --------------
134157
`accountId` | `futuredemodealer` | `String`
135158
`address` | `{"accountName": "ROI Motors", "city": "Burlington", "state": "VT", "postalCode": "05401", "country": "US"}` | `Object`
159+
`askingPrice` | `32000` | `Integer` | `Deprecated`
136160
`autodataCaId` | `CAD00CHT27CG0` | `String`
137161
`bodyStyle` | `Sedan` | `String`
138162
`certified` | `false` | `Boolean`
@@ -147,23 +171,26 @@ Field Key | Example Value | Field Format
147171
`exteriorColor` | `Platinum White Pearl` | `String`
148172
`finalPrice` | `32000` | `Integer`
149173
`fuelType` | `Regular Unleaded` | `String`
150-
`highestPrice` | `34000` | `Integer`
174+
`highestPrice` | `34500` | `Integer` | `Deprecated`
151175
`highwayFuelEconomy` | `38` | `Integer`
152176
`images` | `["https://pictures.dealer.com/1.jpg"]` | `Array`
153177
`interiorColor` | `Black` | `String`
154-
`internetPrice` | `33000` | `Integer`
178+
`internetPrice` | `33000` | `Integer` | `Deprecated`
155179
`inventoryType` | `new` | `String`
156180
`make` | `Honda` | `String`
157181
`model` | `Accord` | `String`
158182
`modelCode` | `RW1H9LKNW` | `String`
159-
`msrp` | `34000` | `Integer`
183+
`msrp` | `34000` | `Integer` | `Deprecated`
160184
`odometer` | `5` | `Integer`
161185
`optionCodes` | `["ABC", "123", "321"]` | `Array`
162-
`status` | `Live` | `String`
186+
`retailValue` | `32000` | `Integer` | `Deprecated`
187+
`salePrice` | `32000` | `Integer` | `Deprecated`
188+
`startingPrice` | `34000` | `Integer`
163189
`stockNumber` | `00180772` | `String`
164190
`transmission` | `Variable` | `String`
165191
`trim` | `EX` | `String`
166192
`uuid` | `ab119e0e0a0a00f944d6f3031cd34854` | `String`
193+
`wholesalePrice` | `32000` | `Integer` | `Deprecated`
167194
`vin` | `1HGCV1F42JA141468` | `String`
168195
`year` | `2018` | `Integer`
169196

0 commit comments

Comments
 (0)