Get by ID

GET /v1/vehicle-documentation/{stockId}

Returns information on vehicle documentation that been submitted to us.

You cannot view the actual documentation, just some basic information relating to it.

Path parameters

stockId string Required

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- documents array[object] Required
  
  Hide documents attributes Show documents attributes object
  
  category string Required
  
  The type of document. Currently we only accept the V5 certificate
  
  Value is V5.
  
  publicUploadUrl string Required
  
  A public url that can be used by the seller to upload documentation
  
  uploaded boolean Required
400 application/json

Bad Request
Hide response attributes Show response attributes object
- errorCode string Required
- errorMessage string
- errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  key string
403 application/json

Forbidden
Hide response attributes Show response attributes object
- errorCode string Required
- errorMessage string
404 application/json

Not Found
Hide response attributes Show response attributes object
- errorCode string Required
- errorMessage string
409 application/json

Conflict
Hide response attributes Show response attributes object
- errorCode string Required
- vrm string
502 application/json

Bad Gateway
Hide response attributes Show response attributes object
- errorCode string Required
- errorMessage string

GET /v1/vehicle-documentation/{stockId}

curl \
 -X GET https://api.dealerauction.co.uk/v1/vehicle-documentation/{stockId}

Response examples (200)

{
  "documents": [
    {
      "category": "V5",
      "publicUploadUrl": "https://www.example.com/document-id",
      "uploaded": true
    }
  ]
}

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"
}