General Concepts

ACCOUNTS API

Overview

The accounts API provides access to the dealership account information for dealers who have a relationship with Dealer.com.

API Uses

  • Get a list of all accounts
  • Get account information by DDC accountid

Available Resources

Resource Name Description
Account Information DDC dealer account information.

Account Information

This is where you can get Account API information.

Endpoints

  • Get all accounts
  • Get account by accountId

URL

To make a call, make an HTTPS get request
https://api.dealer.com/accounts/search?api_key={api_key}
https://api.dealer.com/api/accounts/id/{accountId}?api_key={api_key}

Parameters

For /accounts/search

Parameter Description Possible Values Default Value Type In Required
select Select the properties will get returned by the query address, ancestorId, contact, dealerCode, decendantId, franchise, name, parentId, timeZoneOffset, webAddress String Query No
start Initial position where the pagination will start Integer Query No
size size of each page Integer Query No
accountId Parent account ID own the vehicle String Query No
ancestorId Ancestor ID of the account String Query No
parentId Parent ID of the account String Query No
franchise Franchise String Query No
country Country where the account is located String Query No
state State where the account is located String Query No
dealerCode Filter by dealer code, which are external ids for account String Query No
dealerCodeType Filter by type of dealer code. For example 'aoa' is a type for audi dealerships String Query No
For /accounts/id/{accountId}
Parameter Description Possible Values Default Value Type In Required
select Select the properties will get returned by the query address, ancestorId, contact, dealerCode, decendantId, franchise, name, parentId, timeZoneOffset, webAddress String Query No
accountId Parent account ID own the vehicle String path Yes

Response Format

/accounts/id/{accountId} 

{
  "@type": "string",
  "accountId": "string",
  "address": {
    "city": "string",
    "country": "string",
    "firstLineAddress": "string",
    "postalCode": "string",
    "secondLineAddress": "string",
    "state": "string"
  },
  "ancestorIds": [
    "string"
  ],
  "contact": {
    "company": "string",
    "email": "string",
    "phone": "string"
  },
  "dealerCodes": [
    {
      "code": "string",
      "codeType": "string"
    }
  ],
  "decendantIds": [
    "string"
  ],
  "franchises": [
    "string"
  ],
  "links": [
    {
      "deprecation": "string",
      "href": "string",
      "hreflang": "string",
      "media": "string",
      "rel": "string",
      "templated": true,
      "title": "string",
      "type": "string"
    }
  ],
  "name": "string",
  "parentIds": [
    "string"
  ],
  "timeZoneOffset": 0,
  "webAddress": "string"
}
/accounts/search/ 
[
  {
    "@type": "string",
    "accountId": "string",
    "address": {
      "city": "string",
      "country": "string",
      "firstLineAddress": "string",
      "postalCode": "string",
      "secondLineAddress": "string",
      "state": "string"
    },
    "ancestorIds": [
      "string"
    ],
    "contact": {
      "company": "string",
      "email": "string",
      "phone": "string"
    },
    "dealerCodes": [
      {
        "code": "string",
        "codeType": "string"
      }
    ],
    "decendantIds": [
      "string"
    ],
    "franchises": [
      "string"
    ],
    "links": [
      {
        "deprecation": "string",
        "href": "string",
        "hreflang": "string",
        "media": "string",
        "rel": "string",
        "templated": true,
        "title": "string",
        "type": "string"
      }
    ],
    "name": "string",
    "parentIds": [
      "string"
    ],
    "timeZoneOffset": 0,
    "webAddress": "string"
  }
]

Sample Request

https://api.dealer.com/accounts/id/ddcdemo?select=address%20&select=ancestorId%20&select=contact%20&select=dealerCodes%20&select=decendantId%20
&select=franchise%20&select=name%20&select=parentId%20&select=timeZoneOffset%20&select=webAddress%20&api_key=abcdef1234

Response: 
{
    "accountId": "ddcdemo",
    "webAddress": "group.roimotors.com",
    "timeZoneOffset": -5,
    "address": {
        "state": "VT",
        "postalCode": "",
        "country": "US"
    },
    "contact": {
        "email": "sales@roimotors.com",
        "phone": "888-999-1919"
    },
    "decendantIds": [
        "crmmotors",
        "crmmotorsaudi",
        "crmmotorsbmw",
        "crmmotorschrysler",
        "crmmotorshyundai",
        "crmmotorskia",
        "crmmotorsvolvo",
        "ddcdemoacura",
        "ddcdemoaudi",
        "ddcdemobmw",
        "ddcdemodrsa",
        "ddcdemoford",
        "ddcdemohonda",
        "ddcdemohyundai",
        "ddcdemoinfiniti",
        "ddcdemojaguar",
        "ddcdemokia",
        "ddcdemolandrover",
        "ddcdemomazda",
        "ddcdemombz",
        "ddcdemomini",
        "ddcdemomitsubishi",
        "ddcdemoscion",
        "ddcdemosubaru",
        "ddcdemotoyota",
        "ddcdemoused",
        "ddcdemovolvo",
        "ddcdemovw",
        "gsmgroupdemo",
        "gsmsciondemo",
        "gsmtoyotademo",
        "johnquinn1",
        "jqauto",
        "jqmotors"
    ],
    "franchises": [
        "Audi",
        "BMW",
        "Buick",
        "CADILLAC",
        "Chevrolet",
        "Chrysler",
        "Dodge",
        "FIAT",
        "Ford",
        "GMC",
        "Genesis",
        "Honda",
        "Kia",
        "Lincoln",
        "Mercedes-Benz",
        "Nissan",
        "Porsche",
        "Toyota",
        "Volkswagen",
        "Volvo"
    ],
    "dealerCodes": [
        {
            "codeType": "driverside",
            "code": "8510"
        },
        {
            "codeType": "route-one",
            "code": "CA0CN"
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://accounts.inv.dealer.com/accounts/id/ddcdemo",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        }
    ],
    "@type": "acct_v1"
}

Account Model

Property Description Possible Values Type
@type acct_v1 string
accountId DDC Account ID ddcdemo string
address Contains city,country, firstLineAddress, postalCode, secondLineAddress, state 123 Main Street, Dallas, Texas 75244 string
ancestorIds string array
contact Contains company, email and phone string
dealerCodes Contains code and codeType 8510:driverside, CA0CN:route-one string
decendantIds crmmotors, crmmotorsaudi, crmmotorsbmw, crmmotorschrysler string array
franchises Franchises sold at Dealership Chrysler, Dodge, Jeep, Ram string array
links https://accounts-qa.inv-np.dealer.com/accounts/id/ddcdemo xml:OrderedMap
name Dealership Name Echo Park Thornton string
parentIds Parent IDs of DDC Account ID ddcdemogroup string array
timeZoneOffset -5 integer
webAddress Dealership website http://www.echopark.com string