--- updatedAt: 2025-03-20T21:49:22.000Z agentTools: projectIndex: https://developer.sovrn.com/llms.txt --- # Merchant Status 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](https://developer.sovrn.com/docs/authorization) for further details. ## **Merchant Search:** You can search through over 50,000 merchants working with Sovrn Commerce using the following url. ? ## **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 curl -i -X GET -H "Authorization:secret {SECRET KEY}" 'https://publishers.viglink.com/api/merchant/search?domain=nike.com' ``` ```ruby require 'httparty' headers = { Authorization: "secret " } params = { domain: "nike.com" } url = "https://publishers.viglink.com/api/merchant/search" response = HTTParty.get(url, headers: headers, query: params) ``` ## **Potential Categories** {`
name code
Consumer Electronics CE
Automotive AU
Fashion & Accessories FS
Health & Beauty HB
Real Estate RU
Art & Entertainment AE
Sports & Fitness SF
Self-Help SH
Travel TV
Financial Services FI
Pets PT
Cell Phones & Mobile CM
News, Books & Magazines BK
Education ED
Other OT
Dating DT
Music & Musicians MM
Food & Drink FD
Home & Garden HG
Adult & Gambling AG
Career & Employment CA
Collectibles CB
Online Services EM
Family & Baby FB
Firearms and Hunting FH
Gaming GM
Jewelry & Watches JW
Lifestyle LF
Motorcycles & PowerSports MP
Shopping & Coupons SP
Toys & Hobbies HO
Cameras & Photo CP
Undefined UN
`} ## **Response Fields** {`
Field Sub-Field Description Example
page page returned 1
totalPages total number of pages with records 1
totalRecords total records displayed on this page 33
merchants id Sovrn Commerce specific unique identifier 25700
groupId Sovrn Commerce specific group identifier 34
name name of the merchant nike.com
groupName normalized name of merchant nike
updateDate last date the merchant program was updated in system 2015-03-11
createDate date the merchant was created in the system 2011-09-23
insider increased commission rate as part of the Insider Program false
industryTypes merchant vertical classification [\{"code"=>"SF", "name"=>"Sports & Fitness"}][{"code"=>"SF", "name"=>"Sports & Fitness"}]
affiliateCPA CPA program false
affiliateCPC CPC program true
approved can your campaign earn money on this merchant program true
domains an 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"]
countries a comma separated string of the two letter country codes where this merchant accepts traffic us,ca,uk
merchantSensitiveTypes classification of publishers that this merchant doesn’t work with Non CPC
rates an 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"=>"%"}
`} # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "merchant", "version": "1.0" }, "servers": [ { "url": "https://publishers.viglink.com/api/merchant" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "authorization", "x-default": "secret " } } }, "security": [ { "sec0": [] } ], "paths": { "/search": { "get": { "summary": "Merchant Status", "description": "The Merchant API let’s you determine approval status and access estimated commission rates at scale.", "operationId": "merchant-status-api", "parameters": [ { "name": "keyword", "in": "query", "description": "Searches for a keyword in the merchant name. Leave empty for a full list of merchants", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "searches for merchants within a specific category", "schema": { "type": "string" } }, { "name": "updateDate", "in": "query", "description": "searches for merchants updated on a specific date", "schema": { "type": "string", "format": "date" } }, { "name": "createDate", "in": "query", "description": "searches for merchants created on a specific date", "schema": { "type": "string", "format": "date" } }, { "name": "insider", "in": "query", "description": "searches for merchants part of the Viglink insider program with increased commission rates", "schema": { "type": "boolean" } }, { "name": "domain", "in": "query", "description": "searches for merchants that can affiliate a specific domain. Leave empty for a full list of merchants", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "specifies a page of the results to return. Defaults to 100 results per page", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"page\": 1,\n \"totalPages\": 1,\n \"merchants\": [\n {\n \"id\": 25785,\n \"name\": \"Macys CA\",\n \"updateDate\": \"2013-10-24\",\n \"createDate\": \"2011-10-13\",\n \"insider\": false,\n \"industryTypes\": [\n {\n \"code\": \"FS\",\n \"name\": \"Fashion & Accessories\"\n }\n ],\n \"affiliateCPA\": true,\n \"affiliateCPC\": false,\n \"approved\": false,\n \"domains\": [\n \"m.macys.com\",\n \"macys.ca\",\n \"social.macys.com\",\n \"t.macys.com\",\n \"macys.com\",\n \"customerservice.macys.com\",\n \"www1.macys.com\"\n ],\n \"countries\": \"ca\",\n \"merchantSensitiveTypes\": [],\n \"rates\": [\n {\n \"min\": 3,\n \"max\": 3,\n \"type\": \"%\",\n \"description\": \"Calculated Rate\",\n \"typeName\": \"%\"\n }\n ]\n },\n {\n \"id\": 53158,\n \"name\": \"Macys UK\",\n \"updateDate\": \"2014-02-27\",\n \"createDate\": \"2012-06-26\",\n \"insider\": false,\n \"industryTypes\": [\n {\n \"code\": \"FS\",\n \"name\": \"Fashion & Accessories\"\n }\n ],\n \"affiliateCPA\": true,\n \"affiliateCPC\": false,\n \"approved\": false,\n \"domains\": [\n \"m.macys.com\",\n \"social.macys.com\",\n \"t.macys.com\",\n \"macys.com\",\n \"customerservice.macys.com\",\n \"www1.macys.com\"\n ],\n \"countries\": \"uk,de,fr,it,es,al,ad,am,at,by,be,ba,bg,hr,cy,cz,dk,ee,fo,fi,ge,gi,gr,gg,hu,is,ie,im,je,lv,li,lt,lu,mk,mt,md,mc,me,nl,no,pl,pt,ro,ru,sm,rs,sk,si,sj,se,ch,ua,va,yu\",\n \"merchantSensitiveTypes\": [],\n \"rates\": [\n {\n \"min\": 3,\n \"max\": 3,\n \"type\": \"%\",\n \"description\": \"Calculated Rate\",\n \"typeName\": \"%\"\n }\n ]\n },\n {\n \"id\": 63614,\n \"name\": \"Macys.com\",\n \"updateDate\": \"2014-12-11\",\n \"createDate\": \"2013-10-22\",\n \"insider\": false,\n \"industryTypes\": [\n {\n \"code\": \"FS\",\n \"name\": \"Fashion & Accessories\"\n }\n ],\n \"affiliateCPA\": false,\n \"affiliateCPC\": true,\n \"approved\": true,\n \"domains\": [\n \"m.macys.com\",\n \"social.macys.com\",\n \"macys.com\",\n \"customerservice.macys.com\",\n \"www1.macys.com\"\n ],\n \"countries\": \"us,ca\",\n \"merchantSensitiveTypes\": [\n \"Non CPC\"\n ],\n \"rates\": [\n {\n \"min\": 3,\n \"max\": 3,\n \"type\": \"%\",\n \"description\": \"Calculated Rate\",\n \"typeName\": \"%\"\n }\n ]\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "page": { "type": "integer", "example": 1, "default": 0 }, "totalPages": { "type": "integer", "example": 1, "default": 0 }, "merchants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 25785, "default": 0 }, "name": { "type": "string", "example": "Macys CA" }, "updateDate": { "type": "string", "example": "2013-10-24" }, "createDate": { "type": "string", "example": "2011-10-13" }, "insider": { "type": "boolean", "example": false, "default": true }, "industryTypes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "example": "FS" }, "name": { "type": "string", "example": "Fashion & Accessories" } } } }, "affiliateCPA": { "type": "boolean", "example": true, "default": true }, "affiliateCPC": { "type": "boolean", "example": false, "default": true }, "approved": { "type": "boolean", "example": false, "default": true }, "domains": { "type": "array", "items": { "type": "string", "example": "m.macys.com" } }, "countries": { "type": "string", "example": "ca" }, "merchantSensitiveTypes": { "type": "array" }, "rates": { "type": "array", "items": { "type": "object", "properties": { "min": { "type": "integer", "example": 3, "default": 0 }, "max": { "type": "integer", "example": 3, "default": 0 }, "type": { "type": "string", "example": "%" }, "description": { "type": "string", "example": "Calculated Rate" }, "typeName": { "type": "string", "example": "%" } } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```