Api documentation

Api documentation

Get Equipments List

Spec: Equipment
 
 
v3 v2
 
 

Response format

JSON Response

{
  "totalNumber": {integer},
  "totalPages": {integer},
  "results": [
    "id": {string},
    "niceId": {string},
    "modelYearId": {integer},
    "styleId": {integer},
    "price": {object},
    "name": {string},
    "attributeGroups": {object},
    "equipmentClass": {string},
    "equipmentAvailability": {string}
  ]
}
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 equipment ID Edmunds, Partners, Public
niceId The equipment ID in lowercase Edmunds, Partners, Public
modelYearId Model Year ID Edmunds, Partners, Public
styleId Style ID Edmunds, Partners, Public
price Equipment Price Details Edmunds, Partners, Public
name The equipment name Edmunds, Partners, Public
attributeGroups The name/value pairs describing the equipment Edmunds, Partners, Public
equipmentClass The class of equipment (see overview for possible values) Edmunds, Partners, Public
equipmentAvailability The availability of the equipment (see overview) Edmunds, Partners, Public

The properties within the price object are:

{
  "baseMSRP": {double},
  "baseInvoice": {double},
  "deliveryCharges": {double},
  "usedTmvRetail": {double},
  "usedPrivateParty": {double},
  "usedTradeIn": {double},
  "estimateTmv": {boolean}
}
Property Description Visibility
baseMSRP Base MSRP (vehicle’s price without options) Edmunds, Partners, Public
baseInvoice Base Invoice (invoice, which is the price the manufacturer sells the style to the dealership for) Edmunds, Partners, Public
usedTmvRetail Used Tmv Retail Edmunds, Partners, Public
usedPrivateParty Used Private Party Edmunds, Partners, Public
usedTradeIn Used Trade In Edmunds, Partners, Public
estimateTmv Estimate Tmv Edmunds, Partners, Public

The properties within the attributeGroups object are:

{
  ...
  "attributeGroups": {
    "{attributeGroupName}": {
      "id": {integer},
      "name": {string},
      "properties": {
        "{propertyName1}": {string},
        "{propertyName2}": {string},
        ...
      },
      "attributes": {
        "{propertyName1}": {
          "id": {integer},
          "name": {string},
          "value": {string}
        },
        "{propertyName2}": {
          "id": {integer},
          "name": {string},
          "value": {string}
        },
        ...
      }
    }
  }
}
...
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