Get by ID

GET /v1/listings/{listingId}

More information on listings is available here

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id string Required
    • stockId string Required

      Your stock ID. You can retrieve stock information from the Stock resource using this identifier

    • status string Required

      Values are IN_PROGRESS, PROVISIONAL, CANCELLED, SOLD, or NOT_SOLD.

    • auction object Required

      Additional properties are allowed.

      Hide auction attributes Show auction attributes object
    • negotiation object Required

      Negotiation information. Currently this will just be the asking price (if applicable)

      Additional properties are allowed.

      Hide negotiation attribute Show negotiation attribute object
      • askingPrice integer(int32)

        The amount that the seller is willing to accept for the vehicle.

        This applies mainly to PROVISIONAL vehicles. Those that have bids but have not met reserve. This is price the seller may be willing to drop to.

    • sale object

      Sales information. This will only be present for vehicles that have sold.

      Additional properties are allowed.

      Hide sale attributes Show sale attributes object
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
  • 403 application/json

    Forbidden

    Hide response attributes Show response attributes object
  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
  • 409 application/json

    Conflict

    Hide response attributes Show response attributes object
  • 502 application/json

    Bad Gateway

    Hide response attributes Show response attributes object
GET /v1/listings/{listingId}
curl \
 -X GET https://api.dealerauction.co.uk/v1/listings/{listingId}
Response examples (200)
{
  "id": "cf17d47a-3ba5-452d-a18f-f03225aa6c27",
  "stockId": "a10ab562-c0cd-4072-88eb-4115811f5aa1",
  "status": "IN_PROGRESS",
  "auction": {
    "created": "2023-04-19T11:07:18.883Z",
    "startTime": "2023-04-19T11:07:18.883Z",
    "endTime": "2023-04-19T11:07:18.883Z",
    "cancelTime": "2023-04-21T11:07:18.883Z",
    "bids": [
      {
        "value": 6000,
        "time": "2023-04-20T11:07:18.883Z"
      }
    ],
    "buyNowPrice": 10000,
    "reservePrice": 5000,
    "reserveMet": true,
    "currentPrice": 6000,
    "type": "BID"
  },
  "negotiation": {
    "askingPrice": 5000
  },
  "sale": {
    "buyer": {
      "tradingName": "Test Dealer Cars UK",
      "contacts": [
        {
          "type": "USER",
          "title": "Mr",
          "firstName": "Test",
          "lastName": "User",
          "email": "test.user@example.com",
          "mobileNumber": "07777777777",
          "landlineNumber": "01611111111"
        }
      ],
      "address": {
        "line1": "string",
        "line2": "string",
        "town": "string",
        "county": "string",
        "postcode": "string"
      }
    },
    "price": 5000
  }
}
Response examples (400)
{
  "errorCode": "INVALID_STOCK_ITEM",
  "errorMessage": "An error message",
  "errors": [
    {
      "message": "An error has occurred",
      "key": "string"
    }
  ]
}
Response examples (403)
{
  "errorCode": "SERVER_ERROR",
  "errorMessage": "An unexpected error has occurred"
}
Response examples (404)
{
  "errorCode": "SERVER_ERROR",
  "errorMessage": "An unexpected error has occurred"
}
Response examples (409)
{
  "errorCode": "STOCK_ALREADY_EXISTS",
  "vrm": "AB17ABC"
}
Response examples (502)
{
  "errorCode": "SERVER_ERROR",
  "errorMessage": "An unexpected error has occurred"
}