Auctions

Create auctions

Use the /auctions endpoint to create auctions. Each batch of auction requests can be a combination of sponsored listing auctions and banner auctions. Each auction type has a unique body schemas.

post/v2/auctions

Request

  • Base URL: https://api.topsort.com
  • URL: https://api.topsort.com/v2/auctions
  • Auth: HTTP bearer

Request body

Example request

{
  "auctions": [
    {
      "type": "listings",
      "slots": 2,
      "products": {
        "ids": [
          "p_PJbnN"
        ]
      }
    }
  ]
}

Response

The auction results. The list of winners will contain at most slots entries per auction. It may contain fewer or no entries at all if there aren't enough products with usable bids, that is, a bid amount greater than the reserve price and belonging to a campaign with enough remaining budget. Bids become unusable if campaign budget is exhausted, the bid is disqualified to preserve spend pacing, etc.

Example response

{
  "results": [
    {
      "resultType": "listings",
      "winners": [],
      "error": false
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.