Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Toptimize
Offsite Ads API
- POST[BETA] Create a new advertiser
- GET[BETA] Get advertiser details
- GET[BETA] List all audiences
- POST[BETA] Create a new audience
- POST[BETA] Upload users to an audience
- GET[BETA] List all campaigns
- POST[BETA] Create a new campaign
- GET[BETA] Get campaign details
- PATCH[BETA] Update campaign settings
- GET[BETA] Get campaign geotargeting settings
- GET[BETA] Get Job Status
- GET[BETA] Get campaign performance summary
- GET[BETA] Get daily campaign performance report
- GET[BETA] Get product-level campaign performance report
Assets API
Billing API
- GETGet Billing Contacts
- GETGet Billing Contact
- PUTUpsert Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Marketplace Credit Limit
- POSTSet Marketplace Credit Limit
- PUTUpsert Vendor Billing Contact
- GETGet Vendor Charges
- GETGet Vendor Account Activity
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- GETGet Vendor Credit History
- GETGet Vendor Credit Limit
- POSTSet Vendor Credit Limit
- DELDelete Vendor Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- POSTAdjust Wallet Balance
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
- GETGet Campaign Restriction
- POSTCreate Campaign Restriction
- PATCHUpdate Campaign Restriction
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Restriction Types
- GETGet Restriction Type
- GETGet Sponsored Products
Catalog API
Invitation API
Modal API
Reporting API
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
- GETGet Product Daily Report
- GETGet Scored Attribution Dump Urls
- GETGet Marketplace Interactions Report
- GETGet Marketplace Report
- GETGet Marketplace Campaigns Kpis
- GETGet Marketplace Daily Report
- GETGet Marketplace Vendors Kpis
- GETGet Vendor Report
- GETGet Vendor Daily Report
Segments Service
Toppie API
- GET[BETA] Get Agency Account Balance
- GET[BETA] Get Agency Account Top-ups
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Toppie Campaign Details
- DEL[BETA] Delete Toppie Campaign
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GET[BETA] List Account Products
- GET[BETA] Get Agency Account Report.
- GET[BETA] Account Activity Reports.
- GET[BETA] Get Campaigns Reporting.
- GET[BETA] Get Campaigns by IDs report.
- GET[BETA] Get Campaign Report.
- GET[BETA] Get Campaign Products Report.
Upsert Vendors
Upsert vendors.
curl --request PUT \
--url https://api.topsort.com/public/v1/catalog-search-service/catalogs/vendors \
--header 'Content-Type: application/json' \
--data '{
"vendors": [
{
"id": "9SiwYqqL8vdG",
"imageURL": "https://cdn.example.com/logos/9SiwYqqL8vdG.jpg",
"merchant_center_id": 1456723,
"name": "Huyghe Brewery",
"vendor_role": "admin"
}
]
}'This response does not have an example.Body
Create or replace one or more vendors in the catalog.
A vendor is a brand or other entity that promotes products in campaigns.
Unique ID of the vendor. Topsort treats IDs as strings, choose any format as long as it is unique within the catalog.
1"9SiwYqqL8vdG"
Name of the Vendor. Shown in Topsort UI.
1"Huyghe Brewery"
URL of the vendor image. This image will be displayed in the Topsort UI along with the name of the vendor. Image dimensions between 250x250 and 600x600 pixels are recommended for the best performance of the Topsort UI.
1"https://cdn.example.com/logos/9SiwYqqL8vdG.jpg"
The Google Merchant Center ID.
1456723
Role of the vendor in the Topsort UI. Defaults to admin. Vendors with the admin role have full control to manage and set up their own campaigns. Vendors with the analytics role have read-only access to campaigns and reporting but require the marketplace admin to manage their campaigns.
admin, analytics Response
Successful Response
curl --request PUT \
--url https://api.topsort.com/public/v1/catalog-search-service/catalogs/vendors \
--header 'Content-Type: application/json' \
--data '{
"vendors": [
{
"id": "9SiwYqqL8vdG",
"imageURL": "https://cdn.example.com/logos/9SiwYqqL8vdG.jpg",
"merchant_center_id": 1456723,
"name": "Huyghe Brewery",
"vendor_role": "admin"
}
]
}'This response does not have an example.