Skip to main content

Get auction details

GET 
/api/auction/:serviceCode

Retrieves all details of a specific auction identified by its serviceCode.

Requirements:

  • The user must belong to the company that owns the auction
  • The auction must exist and not be deleted

Fields included in the response:

  • All basic fields (serviceCode, status, dates)
  • Complete load/unload information (etl/etd)
  • List of bids placed (if any exist)
  • Winner information (if the auction is closed)
  • Associated documents (contracts, signatures)

Usage example:

GET /api/auction/ABC123

The response includes all fields of the Auction model plus populated relations.

Request​

Responses​

Complete auction details including:

  • Basic information (serviceCode, status, dates)
  • Load/unload addresses (etl/etd_address)
  • Bid list (bids) with history
  • Current winner (bidWinner) if applicable
  • Associated documents (contracts, signatures)