predictiveSearch - storefront - QUERY

Version: 2024-10

Description:

List of the predictive search results.

Access Scopes

Arguments

• limit: Int - Limits the number of results based on `limit_scope`. The value can range from 1 to 10, and the default is 10.
• limitScope: PredictiveSearchLimitScope - Decides the distribution of results.
• query: String! - The search query.
• searchableFields: SearchableField - Specifies the list of resource fields to use for search. The default fields searched on are TITLE, PRODUCT_TYPE, VARIANT_TITLE, and VENDOR. For the best search experience, you should search on the default field set. The input must not contain more than `250` values.
• types: PredictiveSearchType - The types of resources to search for. The input must not contain more than `250` values.
• unavailableProducts: SearchUnavailableProductsType - Specifies how unavailable products are displayed in the search results.

Returns

• articles: Article! The articles that match the search query.
• collections: Collection! The articles that match the search query.
• pages: Page! The pages that match the search query.
• products: Product! The products that match the search query.
• queries: SearchQuerySuggestion! The query suggestions that are relevant to the search query.

Examples

• Retrieve predictive search results

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query suggestions($query: String!) { predictiveSearch(query: $query) { queries { text } collections { id } products { id } pages { id } articles { id } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query suggestions($query: String!) {\n    predictiveSearch(query: $query) {\n      queries {\n        text\n      }\n      collections {\n        id\n      }\n      products {\n        id\n      }\n      pages {\n        id\n      }\n      articles {\n        id\n      }\n    }\n  }`,\n});\n"
          Ruby example: null
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<<QUERY\n  query suggestions($query: String!) {\n    predictiveSearch(query: $query) {\n      queries {\n        text\n      }\n      collections {\n        id\n      }\n      products {\n        id\n      }\n      pages {\n        id\n      }\n      articles {\n        id\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query suggestions($query: String!) {\n    predictiveSearch(query: $query) {\n      queries {\n        text\n      }\n      collections {\n        id\n      }\n      products {\n        id\n      }\n      pages {\n        id\n      }\n      articles {\n        id\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query suggestions($query: String!) {\n  predictiveSearch(query: $query) {\n    queries {\n      text\n    }\n    collections {\n      id\n    }\n    products {\n      id\n    }\n    pages {\n      id\n    }\n    articles {\n      id\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "predictiveSearch": {
        "queries": [
          {
            "text": "snowboard"
          },
          {
            "text": "oxygen snowboard"
          },
          {
            "text": "3d snowboard"
          },
          {
            "text": "huebert hydroxy snowboard"
          }
        ],
        "collections": [
          {
            "id": "gid://shopify/Collection/1"
          }
        ],
        "products": [
          {
            "id": "gid://shopify/Product/1"
          },
          {
            "id": "gid://shopify/Product/2"
          },
          {
            "id": "gid://shopify/Product/3"
          }
        ],
        "pages": [
          {
            "id": "gid://shopify/Page/1"
          }
        ],
        "articles": [
          {
            "id": "gid://shopify/Article/1"
          }
        ]
      }
    }
  }