Image Search
사진으로 여러 Shopify 스토어의 상품을 찾으며, 키워드로 좁힐 수도 있습니다.
POST /v1/shopify/image-searchPOST 전용이며 JSON 본문으로 보냅니다.
요청
curl -X POST "https://gateway.apinoa.com/v1/shopify/image-search" \
-H "x-api-key: $APINOA_API_KEY" \
-H "content-type: application/json" \
-d "{\"image\": {\"contentType\": \"image/jpeg\", \"data\": \"$(base64 < photo.jpg | tr -d '\n')\"}}"파라미터
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
image | object | 예 | Base64 image input for visual search; the image is the anchor and query narrows it — the reverse of search. Up to ~6MB of base64; supported types are jpeg, png, webp, gif and avif. |
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. | |
query | string | Optional text that refines the image — the reverse of search, where the query anchors the result. For example, a sneaker photo with query=wool returns wool sneakers rather than any sneaker of that shape. | |
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",
"page": {
"index": 1,
"size": 50,
"total": 403
},
"items": [
{
"marketplace": "shopify",
"id": "killcrew.co/flame-high-socks-black-orange",
"attributes": [
{
"name": "Material",
"value": "Cotton blend"
},
{
"name": "Length",
"value": "Crew high"
}
],
"title": "FLAME HIGH SOCKS - BLACK / ORANGE",
"url": "https://killcrew.co/products/flame-high-socks-black-orange?variant=40760148623458",
"price": {
"currency": "USD",
"amount": 15
},
"rating": {
"average": 4.8
},
"seller": {
"id": "killcrew.co",
"name": "Kill Crew",
"url": "https://killcrew.co"
},
"inStock": true,
"imageUrl": "https://cdn.shopify.com/s/files/1/1955/8565/files/FLAMEHIGHSOCKS-BLACK_ORANGE.jpg",
"badges": [],
"promotions": []
}
],
"cursor": "eyJjIjoiZXlKdlptWnpaWFFpT2pVd0xDSjBiM1JoYkY5amIzVnVkQ0k2TkRBekxDSnlaWFIxY201bFpDSTZOVEI5IiwiaSI6MiwiaCI6IjdOa2tvb1l6bjV…",
"facets": []
}
}에러
| 상태 | 코드 | 의미 |
|---|---|---|
| 400 | INVALID_CURSOR | 이 오퍼레이션이 돌려준 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회를 넘으면 단가가 내려갑니다.
참고
- POST 전용입니다. 이미지는 JSON 본문에 base64로 보냅니다.
- 이미지가 기준이고
query가 이를 좁힙니다. 울 스니커즈 사진만으로는 그런 모양의 무엇이든, "wool"이라는 단어만으로는 울로 만든 무엇이든 돌아오고, 둘을 함께 넘기면 울 스니커즈가 돌아옵니다. - 이미지는 base64로 약 6 MB까지, JPEG, PNG, WebP, GIF 또는 AVIF입니다.
- 필터와 페이지네이션은 Search와 같습니다.