Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Events
Audience API
Billing API
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Sponsored Products
Catalog API
Invitation API
Modal API
Reporting API
Assets API
Audience API
Billing API
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Sponsored Products
Catalog API
Invitation API
Modal API
Reporting API
Toppie API
Create sponsored brand auctions
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Specifies the maximum number of auction winners that should be returned.
x > 1A category for the purpose of running an auction.
The category ID of the bids that will participate in an auction.
1An array of product IDs that should participate in the auction. We recommend sending no more than 500 products per auction.
An array of marketplace defined quality scores, each corresponding to the product ID with matching array index.
If given, these values will be combined with our internal quality scores to provide a score
that better represents the relevance of the participating products.
Note that the length of this array must be the same as the length of the ids array and
that the values must be between 0 and 1.
Response
Array of winner objects in order from highest to lowest bid. It will be empty if there were no qualifying bids or if there was an error.
Where the product's bid ranked in the auction. One-based, so the product with rank 1 won the auction. In an auction response, the winners array is sorted so rank will match the entry's index.
x > 1The marketplace's ID of the winning entity, depending on the target of the campaign.
An opaque Topsort ID to be used when this item is interacted with.
Assets used to render the sponsored brand ad.
A vendor provided asset that the marketplace has to render. The asset will be served by Topsort's CDN.
The role of the asset. It can be either logo or image.
The asset MIME type.
The size of the asset in bytes.
The asset width in pixels.
The asset height in pixels.
An optional title for the sponsored brand selected when creating the campaign.
A boolean indicating whether this auction was resolved successfully.