Search
按关键词跨 Shopify 店铺搜索商品,支持价格、评分、成色和库存过滤。
GET | POST /v1/shopify/search参数可以用 GET 的查询字符串发送,也可以用 POST 的 JSON 请求体发送,两者等价。
请求
curl "https://gateway.apinoa.com/v1/shopify/search?query=running+shoes" \
-H "x-api-key: $APINOA_API_KEY"参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
query | string | 是 | Keywords to search for. Required: Shopify search always needs a keyword, which is also why Shopify has no keyword-less browse. |
categoryId | string | Narrow to one category, by the marketplace's own id. Opaque and per-marketplace; take it from Product.category[].id or from a result's facets. | |
condition | enum | Item condition: new or used. refurbished is refused by name rather than folded into used — the catalog sells new and secondhand, and those are different claims. new used | |
cursor | string | Opaque; comes from the previous response and carries the page index. Shopify pages by cursor rather than by number — this is the only paging knob, and page is refused by name. | |
inStock | boolean | enum | Only listings the marketplace reports as purchasable now. | |
priceMax | number ≥ 0 | Highest price to return, in decimal major units. | |
priceMin | number ≥ 0 | Lowest price to return, in decimal major units. | |
ratingMin | number 0–5 | Lowest average star rating to return, on the marketplace's own 0-5 scale. | |
region | string | Buyer country as ISO 3166-1 alpha-2; sets availability, shipping and price. |
这些参数及所有响应类型也写在OpenAPI 文档中。
响应
在 data 中返回 SearchResult。 真实响应的节选:数组只保留前几项,长文本已截断。
{
"success": true,
"data": {
"marketplace": "shopify",
"query": "running shoes",
"page": {
"index": 1,
"size": 50,
"total": 235
},
"items": [
{
"marketplace": "shopify",
"id": "startfitness.co.uk/adidas-adizero-evo-sl-mens-running-shoes-white",
"attributes": [
{
"name": "Weight",
"value": "224 g ± 9 g (size UK 8.5)"
},
{
"name": "Midsole Drop",
"value": "6 mm"
}
],
"title": "adidas Adizero EVO SL Mens Running Shoes - White",
"url": "https://startfitness.co.uk/products/adidas-adizero-evo-sl-mens-running-shoes-white?variant=44383311691984",
"price": {
"currency": "USD",
"amount": 171
},
"rating": {
"average": 4.8
},
"seller": {
"id": "startfitness.co.uk",
"name": "Start Fitness",
"url": "https://startfitness.co.uk"
},
"inStock": true,
"imageUrl": "https://cdn.shopify.com/s/files/1/0564/9521/0704/files/adidas-Adizero-Evo-SL-JH6206.jpg",
"badges": [],
"promotions": []
}
],
"cursor": "eyJjIjoiZXlKdlptWnpaWFFpT2pVd0xDSjBiM1JoYkY5amIzVnVkQ0k2TWpNMUxDSnlaWFIxY201bFpDSTZOVEI5IiwiaSI6MiwiaCI6IkhnMUNENHV3REJ…",
"facets": []
}
}错误
| 状态 | 代码 | 含义 |
|---|---|---|
| 400 | INVALID_CURSOR | 该 cursor 不是本操作返回的。请不带它重新开始。 |
| 400 | INVALID_PARAMS | 参数缺失、未知或超出范围。消息中会指出是哪一个。 |
| 401 | UNAUTHORIZED | 缺少 x-api-key 请求头,或密钥已吊销或未知。 |
| 402 | INSUFFICIENT_BALANCE | 余额不足以支付本次调用。请在控制台充值。 |
| 429 | MARKETPLACE_SATURATED | 并发调用过多。请等待 Retry-After 秒后重试。 |
| 502 | UPSTREAM_ERROR | 平台返回了无法使用的内容。请退避后重试。 |
全部错误代码见 Errors。失败的调用不计费。
价格
价格 每次调用 $0.001。标价;单日调用超过 1,000 次后单价下调。