{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/search","auth":"required","results":{"codes":[{"code":"{\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}","language":"json","status":200,"name":""}]},"settings":"","examples":{"codes":[{"code":"require 'httparty'\n\nheaders = {\n Authorization: \"secret <secret key>\"\n}\n\nparams = {\n domain: \"nike.com\"\n}\n\nurl = \"https://publishers.viglink.com/api/merchant/search\"\n\nresponse = HTTParty.get(url, headers: headers, query: params)\n","language":"ruby"}]},"method":"get","params":[{"name":"keyword","type":"string","default":"none","desc":"Searches for a keyword in the merchant name. Leave empty for a full list of merchants","required":false,"in":"query","ref":"","_id":"568af7b897d8960d0012ab7f"},{"name":"category","type":"string","default":"none","desc":"searches for merchants within a specific category","required":false,"in":"query","ref":"","_id":"568af8f3bf86800d00fe31c2"},{"name":"updateDate","type":"yyyy-mm-dd","default":"none","desc":"searches for merchants updated on a specific date","required":false,"in":"query","ref":"","_id":"568af8f3bf86800d00fe31c1"},{"name":"createDate","type":"yyyy-mm-dd","default":"none","desc":"searches for merchants created on a specific date","required":false,"in":"query","ref":"","_id":"568af8f3bf86800d00fe31c0"},{"name":"insider","type":"boolean","default":"none","desc":"searches for merchants part of the Viglink insider program with increased commission rates","required":false,"in":"query","ref":"","_id":"568af8f3bf86800d00fe31bf"},{"name":"domain","type":"string","default":"none","desc":"searches for merchants that can affiliate a specific domain. Leave empty for a full list of merchants","required":false,"in":"query","ref":"","_id":"568af8f3bf86800d00fe31be"},{"name":"page","type":"int","default":"1","desc":"specifies a page of the results to return. Defaults to 100 results per page","required":false,"in":"query","ref":"","_id":"568af8f3bf86800d00fe31bd"}]},"next":{"description":"","pages":[]},"title":"Merchant Status","type":"endpoint","slug":"merchant-status-api","excerpt":"The VigLink Merchant API let’s you determine approval status and access estimated commission rates at scale.","body":"[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"Authorization Header\",\n \"body\": \"You must add authorization headers to this request.\\n```Authorization: secret {SECRET KEY}```\\n\\n<b>Replace {SECRET KEY} above with any secret key from any campaign in your account.</b> You can find a secret key in your [VigLink account](https://publishers.viglink.com/account). When logged into your dashboard, go to Manage > Account. Under the My Campaign sub-heading, copy a Secret Key. If you don’t have one, click “Get a Secret Key\\\" on any of your campaigns.\"\n}\n[/block]\n## **Endpoint**\n\nAll VigLink merchant API requests start with “https://publishers.viglink.com/api/merchant/”\n\n## **Rate Limit**\nYour 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.\n\n## **Sample call:**\n\n**Command Line** \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -i -X GET -H \\\"Authorization:secret {SECRET KEY}\\\" 'https://publishers.viglink.com/api/merchant/search?domain=nike.es'\",\n \"language\": \"curl\"\n }\n ]\n}\n[/block]\n**Ruby (Using HTTParty Gem)**\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"url = \\\"https://publishers.viglink.com/api/merchant/342\\\"\\n\\nheaders = {\\n Authorization: \\\"secret <secret key>\\\"\\n }\\n\\nresponse = HTTParty.get(url, headers: headers)\\n\",\n \"language\": \"ruby\"\n }\n ]\n}\n[/block]\n\n\n\n## **Individual Merchant Query:**\n\nTo query a single merchant, add the merchant ID to the path of the url.\n\nhttps://publishers.viglink.com/api/merchant/{merchantId}\n\n## **Sample call:**\n\n**Command Line**\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -i -X GET -H \\\"Authorization:secret {SECRET KEY}\\\" https://publishers.viglink.com/api/merchant/342'\",\n \"language\": \"curl\"\n }\n ]\n}\n[/block]\n**Ruby (Using HTTParty Gem)**\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"url = \\\"https://publishers.viglink.com/api/merchant/342\\\"\\n\\nheaders = {\\n Authorization: \\\"secret <secret key>\\\"\\n }\\n\\nresponse = HTTParty.get(url, headers: headers)\",\n \"language\": \"ruby\"\n }\n ]\n}\n[/block]\n## **Merchant Search:**\n\nYou can search through over 50,000 merchants working with VigLink using the following url.\n\nhttps://publishers.viglink.com/api/merchant/search?\n\n## **Sample call:**\n\n**Command Line**\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -i -X GET -H \\\"Authorization:secret {SECRET KEY}\\\" https://publishers.viglink.com/api/merchant/search?domain=nike.es'\",\n \"language\": \"curl\"\n }\n ]\n}\n[/block]\n**Ruby (Using HTTParty Gem)**\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"url = \\\"https://publishers.viglink.com/api/merchant/search?domain=sephora.com&insider=true\\\"\\n\\nheaders = {\\n Authorization: \\\"secret <secret key>\\\"\\n }\\n\\nresponse = HTTParty.get(url, headers: headers)\",\n \"language\": \"ruby\"\n }\n ]\n}\n[/block]\n## **Potential Categories**\n\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"name\",\n \"h-1\": \"code\",\n \"0-0\": \"Consumer Electronics\",\n \"1-0\": \"Automotive\",\n \"2-0\": \"Fashion & Accessories\",\n \"3-0\": \"Health & Beauty\",\n \"4-0\": \"Real Estate\",\n \"5-0\": \"Art & Entertainment\",\n \"6-0\": \"Sports & Fitness\",\n \"7-0\": \"Self-Help\",\n \"8-0\": \"Travel\",\n \"9-0\": \"Financial Services\",\n \"10-0\": \"Pets\",\n \"11-0\": \"Cell Phones & Mobile\",\n \"12-0\": \"News, Books & Magazines\",\n \"13-0\": \"Education\",\n \"14-0\": \"Other\",\n \"15-0\": \"Dating\",\n \"16-0\": \"Music & Musicians\",\n \"17-0\": \"Food & Drink\",\n \"18-0\": \"Home & Garden\",\n \"19-0\": \"Adult & Gambling\",\n \"20-0\": \"Career & Employment\",\n \"21-0\": \"Collectibles\",\n \"22-0\": \"Online Services\",\n \"23-0\": \"Family & Baby\",\n \"24-0\": \"Firearms and Hunting\",\n \"25-0\": \"Gaming\",\n \"26-0\": \"Jewelry & Watches\",\n \"27-0\": \"Lifestyle\",\n \"28-0\": \"Motorcycles & PowerSports\",\n \"29-0\": \"Shopping & Coupons\",\n \"30-0\": \"Toys & Hobbies\",\n \"31-0\": \"Cameras & Photo\",\n \"32-0\": \"Undefined\",\n \"32-1\": \"UN\",\n \"31-1\": \"CP\",\n \"30-1\": \"HO\",\n \"29-1\": \"SP\",\n \"28-1\": \"MP\",\n \"27-1\": \"LF\",\n \"26-1\": \"JW\",\n \"25-1\": \"GM\",\n \"24-1\": \"FH\",\n \"0-1\": \"CE\",\n \"1-1\": \"AU\",\n \"2-1\": \"FS\",\n \"3-1\": \"HB\",\n \"4-1\": \"RU\",\n \"5-1\": \"AE\",\n \"6-1\": \"SF\",\n \"7-1\": \"SH\",\n \"8-1\": \"TV\",\n \"9-1\": \"FI\",\n \"10-1\": \"PT\",\n \"11-1\": \"CM\",\n \"12-1\": \"BK\",\n \"13-1\": \"ED\",\n \"14-1\": \"OT\",\n \"15-1\": \"DT\",\n \"16-1\": \"MM\",\n \"17-1\": \"FD\",\n \"18-1\": \"HG\",\n \"19-1\": \"AG\",\n \"20-1\": \"CA\",\n \"21-1\": \"CB\",\n \"22-1\": \"EM\",\n \"23-1\": \"FB\"\n },\n \"cols\": 2,\n \"rows\": 33\n}\n[/block]\n## **Response Fields** \n[block:parameters]\n{\n \"data\": {\n \"0-0\": \"page\",\n \"0-1\": \"\",\n \"0-2\": \"page returned\",\n \"0-3\": \"1\",\n \"h-0\": \"Field\",\n \"h-1\": \"Sub-Field\",\n \"h-2\": \"Description\",\n \"h-3\": \"Example\",\n \"1-0\": \"totalPages\",\n \"2-0\": \"totalRecords\",\n \"3-0\": \"merchants\",\n \"3-1\": \"id\",\n \"4-1\": \"name\",\n \"5-1\": \"updateDate\",\n \"1-3\": \"1\",\n \"2-3\": \"33\",\n \"1-2\": \"total number of pages with records\",\n \"2-2\": \"total records displayed on this page\",\n \"3-2\": \"VigLink specific unique identifier\",\n \"4-2\": \"name of the merchant\",\n \"5-2\": \"last date the merchant program was updated in VigLink system\",\n \"3-3\": \"25700\",\n \"4-3\": \"nike.com\",\n \"7-1\": \"insider\",\n \"8-1\": \"industryTypes\",\n \"9-1\": \"affiliateCPA\",\n \"10-1\": \"affiliateCPC\",\n \"11-1\": \"approved\",\n \"12-1\": \"domains\",\n \"13-1\": \"countries\",\n \"14-1\": \"merchantSensitiveTypes\",\n \"15-1\": \"rates\",\n \"7-2\": \"increased commission rate as part of the VigLink Insider Program\",\n \"8-2\": \"merchant vertical classification\",\n \"9-2\": \"CPA program\",\n \"10-2\": \"CPC program\",\n \"11-2\": \"can your campaign earn money on this merchant program\",\n \"12-2\": \"an array of the domains that can be affiliated\",\n \"13-2\": \"a comma separated string of the two letter country codes where this merchant accepts traffic\",\n \"14-2\": \"classification of publishers that this merchant doesn’t work with\",\n \"15-2\": \"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.\",\n \"5-3\": \"2015-03-11\",\n \"6-1\": \"createDate\",\n \"6-2\": \"date the merchant was created in the VigLink system\",\n \"6-3\": \"2011-09-23\",\n \"7-3\": \"false\",\n \"8-3\": \"[{\\\"code\\\"=>\\\"SF\\\", \\\"name\\\"=>\\\"Sports & Fitness\\\"}]\",\n \"9-3\": \"false\",\n \"10-3\": \"true\",\n \"11-3\": \"true\",\n \"12-3\": \"[\\\"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\\\"]\",\n \"13-3\": \"us,ca,uk\",\n \"14-3\": \"Non CPC\",\n \"15-3\": \"{\\\"min\\\"=>6.0, \\\"max\\\"=>6.0, \\\"type\\\"=>\\\"%\\\", \\\"description\\\"=>\\\"commission(US)\\\", \\\"typeName\\\"=>\\\"%\\\"}\"\n },\n \"cols\": 4,\n \"rows\": 16\n}\n[/block]","updates":["5adaa3807a10c00003ca7dc6","5eaa515474c9620073c00589"],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"568af726176a6c0d00a29eca","githubsync":"","user":"568af6d197d8960d0012ab7d","__v":5,"createdAt":"2016-01-04T22:50:14.771Z","editedParams":true,"project":"568af724176a6c0d00a29ec4","category":{"sync":{"isSync":false,"url":""},"pages":["568af726176a6c0d00a29eca"],"title":"Merchant API","slug":"documentation","order":1,"from_sync":false,"reference":false,"_id":"568af725176a6c0d00a29ec8","createdAt":"2016-01-04T22:50:13.876Z","project":"568af724176a6c0d00a29ec4","__v":1,"version":"568af725176a6c0d00a29ec7"},"parentDoc":null,"editedParams2":true,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["568af725176a6c0d00a29ec8","56d9d397337fd11300d6a3e3","56d9d4287222d50b0070160b","56f424307ea0091700f63ac5","56f45babcb0dce29005a8e85","5739e5836c5ba134007a197d","57717aee3dd24019004c9122","5771b5d8c755ca0e00617d7d","579639964913990e001a5911","57e57e7df3d7fc0e009c5119","587569b6f4483a0f00d2e6b8","5ca3c2274439e800149daf96","5fd7d79553f64b005e2de7c3","5fe2422ee0a887014f44a422"],"_id":"568af725176a6c0d00a29ec7","project":"568af724176a6c0d00a29ec4","releaseDate":"2016-01-04T22:50:13.289Z","__v":14,"createdAt":"2016-01-04T22:50:13.289Z"}}
getMerchant Status
The VigLink Merchant API let’s you determine approval status and access estimated commission rates at scale.
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Query Params
keyword:
stringnone
Searches for a keyword in the merchant name. Leave empty for a full list of merchants
category:
stringnone
searches for merchants within a specific category
updateDate:
yyyy-mm-ddnone
searches for merchants updated on a specific date
createDate:
yyyy-mm-ddnone
searches for merchants created on a specific date
insider:
booleannone
searches for merchants part of the Viglink insider program with increased commission rates
domain:
stringnone
searches for merchants that can affiliate a specific domain. Leave empty for a full list of merchants
page:
integer1
specifies a page of the results to return. Defaults to 100 results per page