Request URL
[GET] http://api.popshops.com/v3/merchants.xml
[GET] http://api.popshops.com/v3/merchants.json
Response formats
Required request parameters
Parameter name |
Type |
Kind |
Allowed values |
Default value |
Description |
account |
|
account |
|
|
Your API account key. You can find this on your API keys account page. |
Optional request parameters
Parameter name |
Type |
Kind |
Allowed values |
Default value |
Description |
catalog |
item |
|
|
|
A catalog key to limit the merchants to those for a specific catalog. |
alpha |
item |
filter |
#,1-26 |
|
A number that maps to a single letter that will filter on the first letter in a merchant's name. Pass in the '#' symbol for non-alpha characters. Refer to the alpha filters node in the merchant API response for number/letter mappings. |
category |
item |
|
|
|
A category ID to filter the merchants on. |
keyword |
|
query |
|
|
A keyword or phrase to search merchant names on. |
merchant |
selection |
filter |
|
|
The merchant ID to filter the merchants on. |
network |
selection |
filter |
|
|
The affiliate network ID to filter the merchants on. |
page |
item |
pagination |
1-15 |
1 |
The page number of results to return. |
results_per_page |
item |
pagination |
1-100 |
20 |
The number of merchants to return in every response. |
tracking_id |
|
view |
|
|
Optional custom tracking id to be passed along in affiliate links to the affiliate network. |
Response results
Node |
Attribute |
Kind |
Data Type |
Description |
merchants |
|
|
|
The container for all individual merchants |
|
count |
|
integer |
A count of merchants matching the query parameters. |
merchant |
|
|
|
An individual merchant. |
|
category |
resource |
integer |
A category ID for the category the merchant belongs to. |
|
country |
resource |
integer |
A country ID for the country the merchant belongs to. |
|
deal_count |
count |
integer |
The number of deals available from the merchant. |
|
idrequired |
primary_key |
integer |
The unique identifier for the merchant. This acts as a primary key that can be used to reference the merchant. |
|
logo_url |
image |
string |
The URL for a merchant logo. Merchant logos default to a size of 88x31. |
|
merchant_type |
resource |
integer |
A merchant type ID for the merchant type the merchant belongs to. |
|
namerequired |
display |
string |
The name of the merchant. |
|
network |
resource |
integer |
The network ID for the network the merchant belongs to. |
|
network_merchant_id |
display |
string |
The ID assigned to the merchant by the affiliate network. |
|
product_count |
count |
integer |
The number of products offered by the merchant. |
|
site_url |
direct_url |
string |
The direct URL to the merchant's website. This URL does not have any affiliate tracking information in it. |
|
url |
redirect_url |
string |
The affiliate network redirect URL to the merchant's website. |
Resources
Sample response
<?xml version="1.0" encoding="UTF-8"?>
<response status="200" message="ok">
<parameters>...</parameters>
<results>
<merchants count="1015">
<merchant logo_url="http://www.popshops.com/img/public/l/0/0/0/344-1.jpg" category="1" country="1" site_url="http://www.1stopflorists.com" network_merchant_id="2745781" product_count="353" network="2" name="1 Stop Florists" merchant_type="3" deal_count="0" id="344" url="http://r.popshops.com/r/UjM1NUpMN3RFR3pkL1BBNnFwenlKM0I1cGtzZHVIaTBwS09IaS9jTEprbz0K"></merchant>
<merchant logo_url="http://www.popshops.com/img/public/l/0/0/5/409-1.jpg" category="1" country="214" site_url="http://www.1and1.co.uk" network_merchant_id="1499268" product_count="0" network="2" name="1&1 UK Affiliate Program: Domains, Web Hosting & more" merchant_type="72" deal_count="2" id="5409" url="http://r.popshops.com/r/UjM1NUpMN3RFR3pkL1BBNnFwenlKNDFyeDgvWmJjN1FXd09vSE1xTitXaz0K"></merchant>
<merchant logo_url="http://www.popshops.com/img/public/l/0/0/5/395-1.jpg" category="1" country="1" site_url="http://www.1and1.com/?ac=OM.US.US469K02463T2103a" network_merchant_id="1426179" product_count="0" network="2" name="1&1 USA Affiliate Program: Domains, Web Hosting & more." merchant_type="72" deal_count="0" id="5395" url="http://r.popshops.com/r/UjM1NUpMN3RFR3pkL1BBNnFwenlKNUZrSWtjT3lURlIyWlVtaVEyS3ZLOD0K"></merchant>
...
</merchants>
</results>
<filters>
<filter type="selection" parameter="network" resource="network" name="network"></filter>
<filter type="item" parameter="alpha" name="alpha">
<values>
<value count="62" name="p" id="16"></value>
...
<value count="4" name="q" id="17"></value>
</values>
</filter>
...
</filters>
<resources>
<networks count="2">
<network count="1005" selected="true" name="Commission Junction" id="2"></network>
...
</networks>
<merchant_types count="49">
<merchant_type count="28" name="Jewelry" id="28"></merchant_type>
...
</merchant_types>
<countries count="4">
<country count="963" name="United States" id="1"></country>
...
</countries>
<categories>
<context>
<category order="0" name="All" id="1"></category>
</context>
<matches>
<category count="117" name="Arts & Crafts" id="32194"></category>
...
</matches>
</categories>
</resources>
</response>
{
"resources":
{
"countries":
{
"country":
[
{
"count": "963",
"name": "United States",
"id": "1"
},...
],
"count": 4
},
"networks":
{
"network":
[
{
"count": "1005",
"selected": "true",
"name": "Commission Junction",
"id": "2"
},...
],
"count": 2
},
"categories":
{
"context":
{
"category":
[
{
"order": "0",
"name": "All",
"id": "1"
}
]
},
"matches":
{
"category":
[
{
"count": "117",
"name": "Arts & Crafts",
"id": "32194"
},...
]
}
},
"merchant_types":
{
"count": 49,
"merchant_type":
[
{
"count": "28",
"name": "Jewelry",
"id": "28"
},...
]
}
},
"filters":
{
"filter":
[
{
"type": "selection",
"parameter": "network",
"resource": "network",
"name": "network"
},...
]
},
"results":
{
"merchants":
{
"merchant":
[
{
"product_count": "353",
"country": "1",
"network": "2",
"deal_count": "0",
"category": "1",
"merchant_type": "3",
"name": "1 Stop Florists",
"logo_url": "http://www.popshops.com/img/public/l/0/0/0/344-1.jpg",
"id": "344",
"url": "http://r.popshops.com/r/czZpWnRCUE9USVV4aitKbG5VbllNMmV6aTlNQy9SR0h3dFFvWkI4QnZsND0K",
"site_url": "http://www.1stopflorists.com",
"network_merchant_id": "2745781"
},...
],
"count": 1015
}
},
"status": 200,
"parameters":
[
...
],
"message": "ok"
}