Sponsored Brands

Sponsored Brands

Promote brands, restaurants, hotels, agencies, and more with sponsored brands. Utilize a list of candidates with unique product_ids, a specified number of sponsored slots, and an auction request—similar to sponsored listings.

Display sponsored brands on dedicated pages or within search results, category pages, or homepages. Auction requests for sponsored brands follow the same format as sponsored listings.

Request Example

To showcase one sponsored brand on the "brands" page of a website, use this example auction request:

{
  "auctions": [
    {
      "type": "listings",
      "slots": 1,
      "products": {
        "ids": [
          "p_PJbnN",
          "p_ojng4",
          "p_8VKDt",
          "p_Mfk15"
        ]
      }
    }
  ]
}

Response

The response includes the ranked auction results. In this case, the product_id of the winning brand is provided.

An empty response occurs if there are no qualifying bids (no winners) or if an error transpires. In such cases, append organic results.

A new boolean variable, error, indicates successful auction resolution.

An example API V2 JSON-format response with one auction request:

{
  "results": [
    {
      "winners": [
        {
          "rank": 1,
          "winnerType": "product",
          "winnerId": "p_Mfk15",
          "resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0="
        }
      ],
      "error": false
    },
  ]
}

📘

If you are showing both sponsored listings and sponsored brands, you will need 2 sets of API keys while integrating Topsort.