Shopify

Get Shopify search suggestions

Returns predictive search suggestions from any Shopify storefront for a query: matching products, collections and suggested queries. Choose which with types (default all three) and cap results per type with limit (default 10, max 20). Products carry price, availability, images and options; collections carry title, handle, description and product count.

get/shopify/search/suggest

Request

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

Query parameters

urlstring required

Shopify storefront URL

qstring required

Search query

typesstring

Comma-separated suggestion types. Allowed values: product, collection, query

limitinteger

Maximum results per type, defaults to 10 and supports up to 20

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "collections": [
      {
        "handle": "mens",
        "id": "278435758160",
        "products_count": 24,
        "title": "Men",
        "url": "https://www.allbirds.com/collections/mens"
      }
    ],
    "limit": 10,
    "products": [
      {
        "canonical_colour": "black",
        "colour": "black",
        "compare_at_price": 120,
        "condition": "Excellent",
        "discount_percentage": 20,
        "handle": "mens-wool-runners",
        "id": "6616124981328",
        "images": [
          {
            "alt": "Product image",
            "height": 1600,
            "id": "36411373027408",
            "position": 1,
            "url": "https://cdn.shopify.com/s/files/1/example.jpg",
            "width": 1600
          }
        ],
        "labels": [
          "new"
        ],
        "options": [
          {
            "name": "Size",
            "position": 1
          }
        ],
        "price": 98,
        "product_type": "Shoes",
        "rating": 4.2,
        "rating_count": 1549,
        "title": "Men's Wool Runners",
        "url": "https://www.allbirds.com/products/mens-wool-runners",
        "variants": [
          {
            "compare_at_price": 120,
            "grams": 400,
            "id": "34761278160941",
            "inventory_quantity": 24,
            "position": 1,
            "price": 98,
            "product_id": "6616124981328",
            "sku": "A123",
            "title": "Natural Black / 10"
          }
        ],
        "vendor": "Allbirds"
      }
    ],
    "queries": [
      {
        "text": "wool",
        "url": "https://www.allbirds.com/search?q=wool"
      }
    ],
    "query": "wool",
    "source_url": "https://www.allbirds.com",
    "store_url": "https://www.allbirds.com",
    "types": [
      "product",
      "collection",
      "query"
    ]
  },
  "msg": "OK"
}

Changes

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