Skip to main content

Add auction to favorites

POST 
/api/auction/favorites

Add an auction to the company's favorites list for quick access and tracking.

Requirements:

  • The auction must exist and be visible to the company
  • It must not already be in favorites
  • The user must have edit permissions

Actions performed:

  1. Create a record in the AuctionFavourite collection
  2. Associate the auction with the company
  3. Enable filtering and quick access to frequent auctions

Mandatory fields:

  • serviceCode: Unique auction identifier. Format: 3 letters of origin, 3 letters of destination and 5 random alphanumeric characters (e.g., VIGMURnT4FN).
  • fav_name: Descriptive name to identify the favorite

Example request body:

{
  serviceCode: ABC123,
  fav_name: Weekly Madrid-Barcelona Route,
  description: Recurrent load on Mondays
}

The response includes the ID of the created favorite.

Request​

Responses​

Favorite created successfully.