Shopify Search API

Search products across Shopify stores by keyword, with price, rating, condition and stock filters.

GET | POST /v1/shopify/search

Send parameters as a query string with GET, or as a JSON body with POST. Both are equivalent.

Request

curl "https://gateway.apinoa.com/v1/shopify/search?query=running+shoes" \
  -H "x-api-key: $APINOA_API_KEY"

Parameters

Parameter	Type	Required	Notes
`query`	string	yes	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.

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

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

Results span many independent stores. Each item's id is shop/handle and chains into Product and Reviews.
Paging is by cursor. Pass the previous response's cursor; page is refused. Every page holds up to 50 items, so there is no pageSize.
No sort, no brands. Shopify search offers neither.
No currency. Prices follow region.
condition=refurbished is refused rather than mapped onto used: the catalog distinguishes new and secondhand only.

Search