Offers

Available offers & incentives

get

Returns the available offers & incentives.

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

vidstring · alphanumericRequired

The unique external indentifier for the user's session.

Example: 47de026c-e52f-afc1-9214-063740bbce4d

sidstring · alphanumericOptional

The unique external indentifier for the user's current session.

Example: 47de026c-e52f-afc1-9214-063740bbce4d

quote_idstringOptional

The identifier of the quote.

Example: i42rncw873gdwkerd

Header parameters

x-dm-access-keystringRequired

The unique identifier of your dealer. Refer to Console > Dealers to get or setup your dealer access key.

x-api-keystringRequired

Your app's client ID.

Example: 47de026c-e52f-afc1-9214-063740bbce4d

Responses

200

Returns offers & incentives.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

get

/v1/dr/offers

HTTPcURLJavaScriptPython

GET /v1/dr/offers?vid=text HTTP/1.1
Host: api.dealermesh.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-dm-access-key: text
x-api-key: text
Accept: */*

{
  "vid": "123e4567-e89b-12d3-a456-426614174000",
  "vin": "1GTHK24U85E335250",
  "quote_id": "f70c7f6f0ad7569a600bc8aa349b8f0b.d172375d-9fb1-9622-8ae3-adfe2843afba",
  "deal_type": "lease",
  "credit_tier": 1,
  "credit_score": 799,
  "lease": {
    "consumer": {
      "cash": [],
      "specials": []
    },
    "dealer": {
      "cash": [],
      "specials": []
    }
  },
  "finance": {
    "consumer": {
      "cash": [],
      "specials": []
    },
    "dealer": {
      "cash": [],
      "specials": []
    }
  },
  "cash": {
    "consumer": {
      "cash": [],
      "specials": []
    },
    "dealer": {
      "cash": [],
      "specials": []
    }
  }
}