Shopify Image Search API

Find products across Shopify stores from a photo, optionally narrowed by keyword.

POST /v1/shopify/image-search

POST only, with a JSON body.

Request

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')\"}}"

Parameters

Parameter	Type	Required	Notes
`image`	object	yes	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.

The same parameters, and every response type, are in the OpenAPI document.

Response

Returns SearchResult in data. A real response, shortened: arrays keep their first entries and long text is cut.

{
  "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": []
  }
}

Errors

Status	Code	Meaning
400	`INVALID_CURSOR`	The `cursor` is not one this operation returned. Start again without it.
400	`INVALID_PARAMS`	A parameter is missing, unknown or out of range. The message names it.
401	`UNAUTHORIZED`	The `x-api-key` header is missing, or the key is revoked or unknown.
402	`INSUFFICIENT_BALANCE`	The balance does not cover this call. Top up in the dashboard.
429	`MARKETPLACE_SATURATED`	Too many concurrent calls. Retry after the `Retry-After` seconds.
502	`UPSTREAM_ERROR`	The platform answered with something unusable. Retry with backoff.

Every code is listed in Errors. Failed calls are not billed.

Pricing

Price $0.001 per call. List price; the rate steps down above 1,000 calls a day.

Notes

POST only. The image is sent as base64 in a JSON body.
The image is the anchor and query narrows it. A wool-sneaker photo alone returns anything of that shape; the word "wool" alone returns anything made of wool; together they return wool sneakers.
Images up to about 6 MB of base64, as JPEG, PNG, WebP, GIF or AVIF.
Same filters and paging as Search.

Image Search