Skip to main content

Get auction list

GET 
/api/auction/

Retrieves the complete list of the company's auctions, including drafts, active, and closed ones.

Features:

  • Paginated listing
  • Sorted by update date (most recent first)
  • Filterable by status, dates, and text search
  • Includes basic relationships (addresses, bids, winner)

Optional query parameters:

  • page: Page number (default 1)
  • limit: Items per page (default value of ITEMS_PAGE in .env)
  • status: Filter by status (draft, published, closed, cancelled)
  • search: Text to search in service_code or description
  • minDate/maxDate: Date range for creation or modification

Usage example:

GET /api/auction?page=1&limit=20&status=published&search=urgent

The response includes pagination metadata and the basic fields for each auction.

Responses​

Paginated list of auctions. Each item includes:

  • service_code: Unique identifier (e.g., VIGMURnT4FN)
  • status: Current status
  • etl_date/etd_date: Load/discharge dates
  • cargo_weight/cargo_height: Dimensions
  • bid_current: Current bid (if applicable)
  • bidWinner: Winner (if applicable)
  • createdAt/updatedAt: Creation/update dates

Pagination metadata:

  • total: Total items
  • pages: Total pages
  • page: Current page
  • limit: Items per page