Shop Search
Introduction
Search for shop information by shop name, with the following features:
- Supports fuzzy search
- Supports filtering parameters
- Supports custom result sorting
API Endpoint
bash
POST /shop/v1/searchRequest Body
| Field | Type | Required | Description |
|---|---|---|---|
keywords | string | No | Search keywords |
filter | object | No | Filter parameters |
orderby | object | No | Sorting parameters |
page | integer | No | Page number, default: 1 |
pagesize | integer | No | Items per page, default: 10 |
filter Optional Values
| Field | Type | Required | Description |
|---|---|---|---|
region | string | No | Region code, e.g., ['US', 'GB', 'MX', 'ES', 'ID', 'VN', 'MY', 'TH', 'PH'] |
shop_name | object | No | Shop rating range, e.g., {'min': 1, 'max': 5} |
rating_range | object | No | Shop rating range, e.g., {'min': 1, 'max': 5} |
creator_range | object | No | Creator count range, e.g., {'min': 1, 'max': 123} |
is_sshop | boolean | No | Whether it’s a fully managed shop |
is_local | boolean | No | Whether it’s a local shop |
category_id | integer | No | Main category |
orderby Optional Values
| Field | Required | Description |
|---|---|---|
day7_units_sold | No | 7-day sales volume (descending) |
day7_gmv | No | 7-day revenue (descending) |
total_units_sold | No | Total sales volume (descending) |
total_gmv | No | Total revenue (descending) |
Request Example
bash
curl 'https://openapi.test.fastmoss.com/shop/v1/search?client_id=XXX×tamp=XXX&access_token=XXX&sign=XXX ' \
--header 'Content-Type: application/json' \
{
"keywords":"",
"filter": {
"region": "US",
"shop_name": "xxxxx",
},
"page": 1,
"pagesize": 10,
}Response Body
data.total
- Type: integer
- Description: Total number of results
data.list
| Field | Type | Description |
|---|---|---|
seller_id | string | Shop ID |
name | string | Shop name |
uid | string | Uid |
region | string | Region |
Response Example
json
{
"code": 0,
"data": {
"list": [
{
"seller_id": "7495134004458195071",
"uid": "6998429985887667205",
"name": "Halara shop",
"region": "US"
},
{
"seller_id": "7495304734897637668",
"uid": "6945317262698595329",
"name": "Halara US",
"region": "US"
},
{
"seller_id": "7495394207367596894",
"uid": "7272300686909162538",
"name": "Halara Glam",
"region": "US"
},
{
"seller_id": "7495397250347796961",
"uid": "",
"name": "Halara CA",
"region": "US"
},
{
"seller_id": "7495397356525292541",
"uid": "",
"name": "Halara usa1",
"region": "US"
},
{
"seller_id": "7495470591119166378",
"uid": "7311218764057838638",
"name": "Halara Workleisure",
"region": "US"
},
{
"seller_id": "7495586497275202294",
"uid": "7034022154347447342",
"name": "Halara Sports",
"region": "US"
}
],
"total": 7
},
"message": "",
"timestamp": 1744797551,
"request_id": "6f12def3-6946-8c55-ef98-2c2b37af867e"
}