Query parameters

• customerId array[string]

  You will only be able to filter using your own customer ids

• stockId array[string]
• vrm array[string]
• externalStockId array[string]
• externalVendorId array[string]
• deleted boolean
• pageNumber integer(int32)

  Default value is 1.

• pageSize integer(int32)

  Default value is 100.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • stockItems array[object] Required
    Hide stockItems attributes Show stockItems attributes object

    • id string Required
    • publicReference string Required

      Forms part of the url for the advert

    • customerId string Required

      Our customer ID that has been assigned to you. Depending on account setup, you may have multiple customer account IDs assigned to you.

    • lifecycleState string Required

      The status of the vehicle

      Values are FORECOURT, SALE_IN_PROGRESS, SOLD, WASTEBIN, or DELETED.

    • externalStockId string

      A vehicle identifier in the calling system

    • externalVendorId string

      A seller identifier in the calling system

    • vrm string
    • vin string
    • createDate string(date-time) Required
    • availableUntil string(date-time)

      We will not attempt to sell the vehicle past this point in time. If an availableUntil is specified, auction time must end before or at this point. Any ongoing negotiations for provisional vehicles will also be abandoned past this point.

    • advert object
      Hide advert attributes Show advert attributes object

      • state string Required

        Values are ACTIVE or INACTIVE.

      • auction object
        Hide auction attributes Show auction attributes object

        • type string Required

          Values are BID, BUY_NOW, SEALED_BID, or PHYSICAL.

        • startDate string(date-time)

          The date and time that you would like the auction to start

        • endDate string(date-time)

          The date and time that you would like the auction to end

  • paginator object Required
    Hide paginator attributes Show paginator attributes object

    • currentPage integer(int32) Required
    • resultsPerPage integer(int32) Required
    • totalResults integer(int32) Required
    • lastPage integer(int32) Required
• 400 application/json

  Bad Request

  One of:

  BadRequestErrorInfo object ErrorInfo object

  Hide attributes Show attributes

  • errorCode string Required
  • errorMessage string
  • errors array[object]
    Hide errors attributes Show errors attributes object

    • message string Required
    • key string

  Hide attributes Show attributes

  • errorCode string Required
  • errorMessage 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
• 429 application/json

  Too Many Requests

  Hide response attributes Show response attributes object

  • errorCode string Required
  • errorMessage string
• 500 application/json

  Internal Server Error

  Hide response attributes Show response attributes object

  • errorCode string Required
  • errorMessage string
• 502 application/json

  Bad Gateway

  Hide response attributes Show response attributes object

  • errorCode string Required
  • errorMessage string