Trade

Update

get

Retrieve the trade estimate for the ID.

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

trade_idstring · alphanumericRequired

The identifier of a trade estimate.

Example: 774fds45-e89b-12d3-a456-426614174000

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

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

The trade estimate.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

get

/v1/trade/{trade_id}

HTTPcURLJavaScriptPython

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

{
  "trade_id": "774fds45-e89b-12d3-a456-426614174000",
  "vehicle": {
    "photos": [
      {
        "category": "trade",
        "upload_link": "https://dmsh.io/f3u4rd3",
        "link": "https://uploads.dm.com/files/774fds45-e89b-12d3-a456-426614174000",
        "content_type": "image/jpeg",
        "file_name": "Front.jpg"
      }
    ],
    "vehicle_id": "12345456",
    "vin": "1GTHK24U85E335250",
    "name": "2023 Acura TLX Premium Sport Sedan",
    "year": 2023,
    "make_name": "Acura",
    "model_name": "TLX",
    "trim_name": "Premium Sport Sedan",
    "body": "Sedan",
    "engine": "I6 3.0L Twin Turbo",
    "drivetrain": "RWD",
    "fuel_type": "Gas",
    "doors": 4,
    "options": []
  },
  "vin": "1GTHK24U85E335250",
  "vehicle_id": "12345456",
  "mileage": 23430,
  "condition": "Excellent",
  "zip": "02215",
  "value": 23430,
  "value_low": 22670,
  "value_high": 24310,
  "payoff": 4000,
  "status": 2,
  "report_url": "https://kbb.com/report/12342432423"
}

Update

put

Update status and other details of the trade.

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

trade_idstring · alphanumericRequired

The identifier of a trade estimate.

Example: 774fds45-e89b-12d3-a456-426614174000

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

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

Body

application/json

payoffnumber · currencyOptional

The amount required to pay off the trade.

Default: 0Example: 4000

statusnumber · enumOptional

The status of the trade. 1 - Not applied. 2 - Applied. -1 - Deleted.

Example: 2Possible values:

vidstring · alphanumericRequired

Unique identifier that is passed by an external system.

Example: 123e4567-e89b-12d3-a456-426614174000

sidstring · alphanumericRequired

Unique session identifier that is passed by an external system.

Example: sese4567-e89b-12d3-a456-426614174000

Responses

200

The updated trade.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

put

/v1/trade/{trade_id}

HTTPcURLJavaScriptPython

PUT /v1/trade/{trade_id}?vid=text HTTP/1.1
Host: api.dealermesh.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-dm-access-key: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "payoff": 4000,
  "status": 2,
  "vid": "123e4567-e89b-12d3-a456-426614174000",
  "sid": "sese4567-e89b-12d3-a456-426614174000"
}

{
  "trade_id": "774fds45-e89b-12d3-a456-426614174000",
  "vehicle": {
    "photos": [
      {
        "category": "trade",
        "upload_link": "https://dmsh.io/f3u4rd3",
        "link": "https://uploads.dm.com/files/774fds45-e89b-12d3-a456-426614174000",
        "content_type": "image/jpeg",
        "file_name": "Front.jpg"
      }
    ],
    "vehicle_id": "12345456",
    "vin": "1GTHK24U85E335250",
    "name": "2023 Acura TLX Premium Sport Sedan",
    "year": 2023,
    "make_name": "Acura",
    "model_name": "TLX",
    "trim_name": "Premium Sport Sedan",
    "body": "Sedan",
    "engine": "I6 3.0L Twin Turbo",
    "drivetrain": "RWD",
    "fuel_type": "Gas",
    "doors": 4,
    "options": []
  },
  "vin": "1GTHK24U85E335250",
  "vehicle_id": "12345456",
  "mileage": 23430,
  "condition": "Excellent",
  "zip": "02215",
  "value": 23430,
  "value_low": 22670,
  "value_high": 24310,
  "payoff": 4000,
  "status": 2,
  "report_url": "https://kbb.com/report/12342432423"
}

Remove

delete

Remove the trade estimate for the ID.

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

trade_idstring · alphanumericRequired

The identifier of a trade estimate.

Example: 774fds45-e89b-12d3-a456-426614174000

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

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

Execution status.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

delete

/v1/trade/{trade_id}

HTTPcURLJavaScriptPython

DELETE /v1/trade/{trade_id}?vid=text HTTP/1.1
Host: api.dealermesh.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-dm-access-key: text
x-api-key: text
Accept: */*

{
  "success": true
}