Skip to main content
Starter Kit home page
Search...
⌘K
Integration Guide
Changelog
Knowledge Base
Search...
Navigation
Asset examples
Page Not Found
API Reference
General
Introduction
Authentication
Errors
Logs
Auction examples
Running auctions
Sponsored listings
Sponsored banners
Sponsored brands
Asset examples
Create
Webhook examples
Using webhooks
Webhook event & payloads
Auctions
POST
Create auctions
POST
Create sponsored brand auctions
POST
Create travel auctions
Events
POST
Report events
POST
[Beta] Report Link Users
Toptimize
POST
[Beta] Rank objects
POST
[Beta] Add Quality Score
POST
[Beta] Retrieve objects
Toppie API
GET
[BETA] Get Toppie Campaigns
POST
[BETA] Create Toppie Campaign
GET
[BETA] Get Agency Account Report.
GET
[BETA] Get Campaigns Reporting.
GET
[BETA] Account Activity Reports.
GET
Get Agency Daily Kpis By Product Dump Urls
GET
[BETA] List Account Products
GET
[BETA] Get Toppie Campaign Details
DEL
[BETA] Delete Toppie Campaign
PATCH
[BETA] Update Toppie Campaign
GET
[BETA] Get Toppie Campaign Bids
GET
[BETA] Get Campaign Report.
GET
[BETA] Get Campaign Products Report.
Campaign API
GET
Get Restriction Types
GET
Get Json Templates
POST
Create Json Template
GET
Get Campaigns
POST
Create Campaign
POST
[BETA] Get estimated clicks of a future campaign for a given vendor
deprecated
GET
Get Sponsored Products
deprecated
GET
Get Products In Campaign
POST
[BETA] Create exclusive listing campaign.
POST
[BETA] Create exclusive banner campaign.
GET
Get Campaign Restriction
POST
Create Campaign Restriction
PATCH
Update Campaign Restriction
GET
Get Restriction Type
GET
Get Json Template
PATCH
Update Json Template
GET
Get Campaign By Id
DEL
Delete Campaign By Id
PATCH
Update Campaign By Id
GET
Get Campaign Bids
POST
Create Campaign Bids
DEL
Delete All Bids From A Campaign
DEL
Delete Campaign Bid By Id
PATCH
Update Campaign Bid By Id
GET
Get Campaign Products
PUT
Upsert Campaign Products
GET
[BETA] Get exclusive listing campaign by ID.
PATCH
[BETA] Update exclusive listing campaign by ID.
GET
[BETA] Get exclusive banner campaign by ID.
PATCH
[BETA] Update exclusive banner campaign by ID.
Catalog API
GET
Get Categories Count
GET
Get Products Count
GET
Get Categories
PUT
Upsert Categories
DEL
Delete Categories
GET
Get Products
PUT
Upsert Products
DEL
Delete Products
PATCH
Update Products
GET
Get Vendors
PUT
Upsert Vendors
DEL
Delete Vendors
GET
Get Category
GET
Get Product
GET
Get Vendor
Billing API
GET
Get Marketplace Credit Limit
deprecated
POST
Set Marketplace Credit Limit
deprecated
GET
Get Vendor Charges
deprecated
GET
Get Billing Contacts
PUT
Upsert Vendor Billing Contact
GET
Get Campaign Billing Contact
PUT
Upsert Campaign Billing Contact
GET
Get Vendor Wallets
POST
Create Wallet
GET
Get Vendor Credit Limit
deprecated
POST
Set Vendor Credit Limit
deprecated
GET
Get Vendor Credit History
deprecated
GET
Get Vendor Account Activity
deprecated
GET
Get Vendor Balance
POST
Add Vendor Balance
POST
Burn Vendor Balance
POST
Adjust Wallet Balance
GET
Get Billing Contact
PUT
Upsert Billing Contact
DEL
Delete Vendor Billing Contact
Reporting API
GET
Get Marketplace Report
GET
Get Marketplace Daily Report
GET
Get Marketplace Vendors Kpis
GET
Get Marketplace Campaigns Kpis
GET
Get Marketplace Interactions Report
GET
Get Scored Attribution Dump Urls
GET
Get Interactions Dump Urls
GET
Get Vendor Report
GET
Get Vendor Daily Report
GET
Get Campaign Report
GET
Get Campaign Daily Report
GET
Get Product Daily Report
GET
Get Campaign Report By Product
GET
Get Product Report
Invitation API
POST
[BETA] Invite Vendors
User API
GET
Get User By Email
PUT
Update User
POST
Create User
Webhooks API
GET
Get Webhooks
POST
Create Webhook
GET
Get Webhook
DEL
Delete Webhook
PATCH
Update Webhook
Assets API
POST
[BETA] Create Collection
POST
Create Asset
GET
[BETA] Get Collections
GET
Get Assets
GET
[BETA] Get Collection
DEL
[BETA] Delete Collection
PATCH
[BETA] Update Collection
GET
Get Asset
DEL
Delete Asset
PATCH
Update Asset
Segments Service
GET
[BETA] Retrieve a list of segments.
PUT
[BETA] Upsert segments with the provided information.
DEL
[BETA] Delete a segment.
GET
[BETA] Get upload users signed url for a segment.
POST
[BETA] Upload users to a segment.
Offsite Ads API
POST
Create a new advertiser
GET
Get vendor offsite campaigns
POST
Create Campaign
GET
List Audiences
POST
[BETA] Create offsite user list audience job.
PUT
Upsert Advertiser Domain
GET
Get Job Status
GET
Get advertiser onboarding state for a specific DSP
GET
Get campaign information
PATCH
Update Campaign
GET
Get Campaign Products Report
GET
Get Campaign Aggregated Report
GET
Get Campaign Daily Report
Forecasting Service
GET
[BETA] Marketplace-level Forecasts
POST
[BETA] Inventory-level Forecasts
POST
[BETA] Campaign-level Forecasts
Media API
GET
Get Slots
POST
Create Slot
DEL
Delete Banner Fallback
DEL
Delete Slot
PATCH
Toggle Slot
API Reference
HOOK
Endpoint to notify events generated in topsort
404
Page Not Found
We couldn't find the page. Maybe you were looking for one of these pages below?
Create Asset
Sponsored Banners on category pages
Authentication
⌘I