Shop.app

Search Shop.app products

Searches Shop.app product results. Limit defaults to 20 and accepts values up to 50.

get/shop-app/search

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/shop-app/search
  • Auth: API key in header x-api-key

Query parameters

querystring required

Search query

limitinteger

Maximum products, defaults to 20 and supports up to 50

in_stockboolean

Request in-stock products

on_saleboolean

Request sale products

deep_searchboolean

Accepted for compatibility; Shop.app no longer offers a separate deep search mode, so results are unchanged

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "groups": [
      {
        "products_seen": 4,
        "query": "men's running sneakers",
        "title": "men's running sneakers"
      }
    ],
    "limit": 20,
    "products": [
      {
        "currency": "USD",
        "group_query": "kids' athletic sneakers",
        "group_title": "kids' athletic sneakers",
        "id": "8075903107261",
        "image": "https://cdn.shopify.com/s/files/1/1145/5784/files/example.jpg",
        "image_alt": "Black sneaker side view",
        "original_price": 120,
        "position": 1,
        "price": 100,
        "shop_id": "62696",
        "shop_name": "BILLY Footwear",
        "title": "Black/Black/Gum BILLY Sport Inclusion DZ1",
        "url": "https://billyfootwear.com/products/black-black-gum-billy-sport-inclusion-dz1-zipper-shoes?utm_source=shop_app",
        "variant_id": "46242960965821"
      }
    ],
    "query": "sneakers"
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.