Skip to main content
GET
JavaScript

Authorizations

x-api-key
string
header
required

Query Parameters

cursor
string

Opaque cursor returned from the previous response; pass back to fetch the next page.

Example:

"100"

limit
number
default:20

Limit the number of results

Required range: 1 <= x <= 100
Example:

20

host
string

Filter merchants by host

Minimum string length: 1
Example:

"nike.com"

name
string

Filter merchants by name (partial match)

Minimum string length: 1
Example:

"nike"

coverageStatus
enum<string>

Filter merchants by coverage status (supported, testing, or unsupported).

Available options:
supported,
testing,
unsupported
Example:

"supported"

categories
enum<string>[]
Minimum array length: 1
Available options:
automotive,
baby_and_kids,
ecommerce,
electronics_and_gadgets,
fashion_and_accessories,
finance,
food,
health_and_beauty,
home_and_living,
lifestyle_and_entertainment,
other,
sports_and_outdoor,
travel,
education

Response

Merchants fetched successfully

success
boolean
required
status
string
required
message
string
required
data
object[]
required
pagination
object
required