The Merchant API let’s you determine approval status and access estimated commission rates at scale.

🚧

Authorization Header

You must add authorization headers to this request. Please see the Authorization section for further details.

Merchant Search:

You can search through over 50,000 merchants working with Sovrn Commerce using the following url.

https://publishers.viglink.com/api/merchant/search?

Rate Limit

Your calls will be limited to 1 query per 3 seconds. If you exceed our rate limit your queries will be throttled and you will get no response.

Sample call:

curl -i -X GET    -H "Authorization:secret {SECRET KEY}"  'https://publishers.viglink.com/api/merchant/search?domain=nike.com'
require 'httparty'

headers = {
  Authorization: "secret <secret key>"
}

params = {
  domain: "nike.com"
}

url = "https://publishers.viglink.com/api/merchant/search"

response = HTTParty.get(url, headers: headers, query: params)

Potential Categories

namecode
Consumer ElectronicsCE
AutomotiveAU
Fashion & AccessoriesFS
Health & BeautyHB
Real EstateRU
Art & EntertainmentAE
Sports & FitnessSF
Self-HelpSH
TravelTV
Financial ServicesFI
PetsPT
Cell Phones & MobileCM
News, Books & MagazinesBK
EducationED
OtherOT
DatingDT
Music & MusiciansMM
Food & DrinkFD
Home & GardenHG
Adult & GamblingAG
Career & EmploymentCA
CollectiblesCB
Online ServicesEM
Family & BabyFB
Firearms and HuntingFH
GamingGM
Jewelry & WatchesJW
LifestyleLF
Motorcycles & PowerSportsMP
Shopping & CouponsSP
Toys & HobbiesHO
Cameras & PhotoCP
UndefinedUN

Response Fields

FieldSub-FieldDescriptionExample
pagepage returned1
totalPagestotal number of pages with records1
totalRecordstotal records displayed on this page33
merchantsidSovrn Commerce specific unique identifier25700
groupIdSovrn Commerce specific group identifier34
namename of the merchantnike.com
groupNamenormalized name of merchantnike
updateDatelast date the merchant program was updated in system2015-03-11
createDatedate the merchant was created in the system2011-09-23
insiderincreased commission rate as part of the Insider Programfalse
industryTypesmerchant vertical classification[{"code"=>"SF", "name"=>"Sports & Fitness"}]
affiliateCPACPA programfalse
affiliateCPCCPC programtrue
approvedcan your campaign earn money on this merchant programtrue
domainsan array of the domains that can be affiliated["thedraw.nike.com", "nikefactorystore.nike.com", "jobs.nike.com", "niketown.nike.com", "news.nike.com", "insider.nike.com", "nikeid.nike.com", "go.nike.com", "content.nike.com", "nikerunning.nike.com", "photoid.nike.com", "nike.com", "m.nike.com", "store.nike.com", "nikelab.nike.com", "secure-nikeplus.nike.com", "producttesting.nike.com", "secure-store.nike.com", "niketeam.nike.com", "images.nike.com", "click.official.nike.com", "help-en-us.nike.com", "nikeplus.nike.com", "secure-images.nike.com"]
countriesa comma separated string of the two letter country codes where this merchant accepts trafficus,ca,uk
merchantSensitiveTypesclassification of publishers that this merchant doesn’t work withNon CPC
ratesan array of the commission rate information, can return different levels of commission, cpc rates, cpa rates, etc... For some merchants we will display a calculated commission rate. This is the average commission rate earned by our publishers for this particular merchant.{"min"=>6.0, "max"=>6.0, "type"=>"%", "description"=>"commission(US)", "typeName"=>"%"}
Language
Authentication
Header
Click Try It! to start a request and see the response here!