Api documentation

Api documentation

Spec: Model

Spec Model
 
 
v3 v2
 
 

Response format

JSON Response

  1. {
  2. "totalNumber": {integer},
  3. "totalPages": {integer},
  4. "results": [
  5. {
  6. "id": {string},
  7. "makeId": {integer},
  8. "makeName": {string},
  9. "makeNiceName": {string},
  10. "makeNiceId": {string},
  11. "name": {string},
  12. "niceName": {string},
  13. "adTargetId": {string},
  14. "niceId": {string},
  15. "modelLinkCode": {string},
  16. "make": {object},
  17. "modelYears": {list of objects},
  18. "attributeGroups": {object},
  19. "categories": {object},
  20. "categoryValues": {list of strings},
  21. "publicationStates": {list of strings}
  22. },
  23. ...
  24. ]
  25. }
Property Description Visibility
totalNumber Total number of results Edmunds, Partners, Public
totalPages Total number of pages based on pagesize query param Edmunds, Partners, Public
results Result list Edmunds, Partners, Public
id The Car Model Id Edmunds, Partners, Public
makeId The Car Make Id (e.g. 200000130) Edmunds, Partners, Public
makeName The Car Make Name (e.g. Mercedes-Benz) Edmunds, Partners, Public
makeNiceName The Car Make Nice Name d (e.g. mercedes-benz) Edmunds, Partners, Public
makeNiceId The Car Make Nice Id e (e.g. mercedesbenz) Edmunds, Partners, Public
name The Car Model Name (e.g. E-Class) Edmunds, Partners, Public
niceName The Car Model Nice Name (e.g. eclass) Edmunds, Partners, Public
adTargetId The Car Ad Target Id (e.g. eclass) Edmunds, Partners, Public
niceId The Car Model Nice Id (e.g. e-class) Edmunds, Partners, Public
make The Car Make Info Edmunds, Partners, Public
modelYears The Car Model Years Info Edmunds, Partners, Public
modelLinkCode The Car Model Link Code Edmunds, Partners, Public
attributeGroups The Car Attribute Groups Edmunds, Partners, Public
categories The Car Categories Edmunds, Partners, Public
categoryValues The Car Category Values Edmunds, Partners, Public
publicationStates The Car Publication States Edmunds, Partners, Public

The properties within the make object are:

  1. {
  2. "id": {integer},
  3. "href": {string}
  4. },
Property Description Visibility
id Make Id Edmunds, Partners, Public
href Link to v3 makes endpoint in order to get additional data Edmunds, Partners, Public

The properties within the modelYears object are:

  1. {
  2. "id": {integer},
  3. "name": {string},
  4. "year": {integer},
  5. "publicationStates": {list of strings},
  6. "href": {string}
  7. }
Property Description Visibility
id Model Year Id Edmunds, Partners, Public
name Model Year Name (e.g “2019”) Edmunds, Partners, Public
year Model Year (e.g. 2019) Edmunds, Partners, Public
publicationStates Model Year Publication States (e.g. USED) Edmunds, Partners, Public
href Link to v3 modelYears endpoint in order to get additional data Edmunds, Partners, Public

The properties within the categories and types objects are:

  1. {
  2. "{categoryName1}": [{string value1}, {string value2}, ...],
  3. "{categoryName2}": [{string value1}, {string value2}, ...],
  4. ...
  5. }
Property Description Visibility
categoryName Category Name (e.g. Market, Vehicle type) Edmunds, Partners, Public

The properties within the attributeGroups object are:

  1. {
  2. ...
  3. "attributeGroups": {
  4. "{attributeGroupName}": {
  5. "id": {integer},
  6. "name": {string},
  7. "properties": {
  8. "{propertyName1}": {string},
  9. "{propertyName2}": {string},
  10. ...
  11. },
  12. "attributes": {
  13. "{propertyName1}": {
  14. "id": {integer},
  15. "name": {string},
  16. "value": {string}
  17. },
  18. "{propertyName2}": {
  19. "id": {integer},
  20. "name": {string},
  21. "value": {string}
  22. },
  23. ...
  24. }
  25. }
  26. },
  27. ...
  28. }
Property Description Visibility
{attributeGroupName} Attribute Group Name Edmunds, Partners, Public
id Attribute Group Id Edmunds, Partners, Public
name Attribute Group Name Edmunds, Partners, Public
properties A Set of Properties of Attribute Group (key - value) Edmunds, Partners, Public
attributes A Detailed Set of Properties of Attribute Group (id, name, value) Edmunds, Partners, Public