Skip to main content
POST
/
merchants
/
fetch
Merchants Fetch
curl --request POST \
  --url https://api.henrylabs.ai/v1/merchants/fetch \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cursor": "2023-01-01T00:00:00.000Z",
  "limit": 40,
  "host": "nike.com",
  "name": "nike",
  "categories": [
    "apparel",
    "footwear"
  ]
}
'
{
  "success": true,
  "status": "<string>",
  "message": "<string>",
  "data": [
    {
      "host": "<string>",
      "name": "<string>",
      "description": "<string>",
      "website": {
        "urls": [
          {
            "value": "<string>",
            "type": "landing"
          }
        ]
      },
      "logo": {
        "urls": [
          {
            "value": "<string>"
          }
        ]
      },
      "categories": [
        "automotive"
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
required

Body

application/json
cursor
string

Cursor returned from the previous response

Example:

"2023-01-01T00:00:00.000Z"

limit
number
default:40

Limit the number of results

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

40

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"

categories
enum<string>[]

Filter merchants by categories

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