GET /v1/merchants
{
"meta": {
"total": 112599,
"from": 1,
"to": 100,
"current_page": 1,
"last_page": 1126,
"per_page": 100,
"fields": [
"id",
"name",
"network",
"product_count": 5465
]
},
"data": [
{
"id": 57131,
"name": "Levi's",
"description": "Levi's is synonymous with denim jeans, having invented the original back in the late 1800s. Their products are cut from the best cloth, crafted with expert care, and designed for the long haul. This program offers a 7-day cookie duration.",
"domains": [
"https://www.levi.com/us/en_us"
],
"icon_url": "https://img.affiliate.com/logos/merchants/57131/icon.png",
"logo_url": "https://img.affiliate.com/logos/merchants/57131/logo.png",
"product_count": 28391,
"network": {
"id": 600,
"name": "FlexOffers US",
"url": "https://www.flexoffers.com",
"logo_url": "https://img.affiliate.com/logos/groups/10018/128x128.png"
}
},
{
"id": 37590,
"name": "WalMart Canada",
"description": "Skip store lineups & shop for groceries online from the convenience of home. Order non-essentials & groceries at Walmart.ca with a range of delivery and pick-up options.",
"domains": [
"http://www.walmart.ca"
],
"icon_url": "https://img.affiliate.com/logos/merchants/37590/icon.png",
"logo_url": "https://img.affiliate.com/logos/merchants/37590/logo.png",
"product_count": 0,
"network": {
"id": 4,
"name": "Rakuten US",
"url": "https://rakutenadvertising.com",
"logo_url": "https://img.affiliate.com/logos/groups/10022/128x128.png"
}
}
]
}| Field Name | Type | Description |
|---|---|---|
meta | object | Metadata about the pagination. |
data | array | The array of merchant groups. |
meta Object| Field Name | Type | Description |
|---|---|---|
total | integer | The total number of items. |
from | integer | The start # of the results. |
to | integer | The end # of the results. |
current_page | integer | The current page result. |
last_page | integer | The last page # in result et. |
per_page | integer | The # of results per page. |
fields | array | The fields that are returned. |
data Arraymerchant Object| Field Name | Type | Description |
|---|---|---|
id | integer | The unique identifier of the merchant. |
name | string | The name of the merchant. |
network | object | The network to which the merchant belongs. |
product_count | integer | The amount of products the merchants provides. |
description | string | Description of the merchant |
logo_url | string | The url of the stored logo for that merchant. |
icon_url | string | The url of the stored icon for that merchant. |
domains | array | The cononical domian(s) for the merchant. |
origin_url | string | The unique identifier from the merchant. |
network Object| Field Name | Type | Description |
|---|---|---|
network.id | integer | The unique identifier of the network. |
network.name | string | The name of the network. |
network.logo_url | string | The URL of the network's logo. |
| Parameter Name | Type | Required | Description |
|---|---|---|---|
/{id} | string | No | Filters response to a single merchant by its ID |
fields | string | No | Limit to the return to the fields specified |
page | integer | No | The page number to retrieve. Defaults to 1. |
per_page | integer | No | The number of items per page. Defaults to 100. |
search | string | No | Search for a merchant by their name (e.g. ?search=best+buy) or domain (e.g. betbuy.com |
network_ids | string | No | Filter results with the network ids provided as a comma separated value |
origin_ids | string | No | Filter results origin ids provided as a comma separated value |
has_icon | integer (1 for True, 0 for False) | No | Filter results that only have an icon url. |
has logo | integer (1 for True, 0 for False) | No | Filter results that only have a logo url. |
has_domains | integer (1 for True, 0 for False) | No | Filter results that have a domain value in the array. |
has_description | integer (1 for True, 0 for False) | No | Filter results that have a description value |
product_count_min | integer | No | Filter results that meet the minimum amount of products |
product_count_max | integer | No | Filter results that meet the maximum amount of products |