Plans

get

By passing specific parameters, retrieve the available protection plans on the vehicle.

Authorizations

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

categorystring · enumOptional

The category of the plan.

Example: vscPossible values:

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

Available plans.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

get

/v1/plans

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

{
  "plans": []
}