v1SearchCompletions

Get search completions/suggestions for product names

v1SearchCompletionsquery

Arguments

queryString!required

Prefix to match against names and titles. Required

limitInt

Maximum suggestions to return (default 15, max 50)

localeString!required

Locale for translated suggestion text (e.g. en, sv). Required

marketSlugString!required

Market slug used to scope product suggestions. Required

storeGroupSlugString!required

Store group slug used to scope product suggestions. Required

channelSlugString

When set, product suggestions are limited to this sales channel

searchCompletionTypes[SearchCompletionTypes!]

Entity types to suggest. Defaults to product, brand, series, category, and collection

hasActiveVariantsBoolean

When true, only products with an active variants are matched

Returns

[SearchCompletion!]!

Query Reference

query V1SearchCompletions($query: String!, $limit: Int, $locale: String!, $marketSlug: String!, $storeGroupSlug: String!, $channelSlug: String, $searchCompletionTypes: [SearchCompletionTypes!], $hasActiveVariants: Boolean) {  v1SearchCompletions(query: $query, limit: $limit, locale: $locale, marketSlug: $marketSlug, storeGroupSlug: $storeGroupSlug, channelSlug: $channelSlug, searchCompletionTypes: $searchCompletionTypes, hasActiveVariants: $hasActiveVariants) {    value    highlight    matchType    rank    metadata {      id      slug    }  }}

enum SearchCompletionTypes {
  PRODUCT
  BRAND
  SERIE
  CATEGORY
  COLLECTION
}

{
  "query": "string",
  "limit": 0,
  "locale": "string",
  "marketSlug": "string",
  "storeGroupSlug": "string",
  "channelSlug": "string",
  "searchCompletionTypes": [
    "PRODUCT"
  ],
  "hasActiveVariants": true
}

type SearchCompletion {
  value: String!
  highlight: String
  matchType: String!
  rank: Float!
  metadata: CompletionMetadata!
}

type CompletionMetadata {
  id: String!
  slug: String
}

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Bodyapplication/json

Request body

Request

curl -X POST 'https://graphql.enad.io/{app_id}/graphql' \
  -H 'Content-Type: application/json' \
  -d '{
  "query": "query V1SearchCompletions($query: String!, $limit: Int, $locale: String!, $marketSlug: String!, $storeGroupSlug: String!, $channelSlug: String, $searchCompletionTypes: [SearchCompletionTypes!], $hasActiveVariants: Boolean) {\n  v1SearchCompletions(query: $query, limit: $limit, locale: $locale, marketSlug: $marketSlug, storeGroupSlug: $storeGroupSlug, channelSlug: $channelSlug, searchCompletionTypes: $searchCompletionTypes, hasActiveVariants: $hasActiveVariants) {\n    value\n    highlight\n    matchType\n    rank\n    metadata {\n      id\n      slug\n    }\n  }\n}",
  "variables": {
    "query": "string",
    "limit": 0,
    "locale": "string",
    "marketSlug": "string",
    "storeGroupSlug": "string",
    "channelSlug": "string",
    "searchCompletionTypes": [
      "PRODUCT"
    ],
    "hasActiveVariants": true
  }
}'

const response = await fetch("https://graphql.enad.io/{app_id}/graphql", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"query\": \"query V1SearchCompletions($query: String!, $limit: Int, $locale: String!, $marketSlug: String!, $storeGroupSlug: String!, $channelSlug: String, $searchCompletionTypes: [SearchCompletionTypes!], $hasActiveVariants: Boolean) {\\n  v1SearchCompletions(query: $query, limit: $limit, locale: $locale, marketSlug: $marketSlug, storeGroupSlug: $storeGroupSlug, channelSlug: $channelSlug, searchCompletionTypes: $searchCompletionTypes, hasActiveVariants: $hasActiveVariants) {\\n    value\\n    highlight\\n    matchType\\n    rank\\n    metadata {\\n      id\\n      slug\\n    }\\n  }\\n}\",\n  \"variables\": {\n    \"query\": \"string\",\n    \"limit\": 0,\n    \"locale\": \"string\",\n    \"marketSlug\": \"string\",\n    \"storeGroupSlug\": \"string\",\n    \"channelSlug\": \"string\",\n    \"searchCompletionTypes\": [\n      \"PRODUCT\"\n    ],\n    \"hasActiveVariants\": true\n  }\n}"
});

import requests

response = requests.post(
    "https://graphql.enad.io/{app_id}/graphql",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"query\": \"query V1SearchCompletions($query: String!, $limit: Int, $locale: String!, $marketSlug: String!, $storeGroupSlug: String!, $channelSlug: String, $searchCompletionTypes: [SearchCompletionTypes!], $hasActiveVariants: Boolean) {\\n  v1SearchCompletions(query: $query, limit: $limit, locale: $locale, marketSlug: $marketSlug, storeGroupSlug: $storeGroupSlug, channelSlug: $channelSlug, searchCompletionTypes: $searchCompletionTypes, hasActiveVariants: $hasActiveVariants) {\\n    value\\n    highlight\\n    matchType\\n    rank\\n    metadata {\\n      id\\n      slug\\n    }\\n  }\\n}\",\n  \"variables\": {\n    \"query\": \"string\",\n    \"limit\": 0,\n    \"locale\": \"string\",\n    \"marketSlug\": \"string\",\n    \"storeGroupSlug\": \"string\",\n    \"channelSlug\": \"string\",\n    \"searchCompletionTypes\": [\n      \"PRODUCT\"\n    ],\n    \"hasActiveVariants\": true\n  }\n}",
)

Response

{
  "data": {
    "v1SearchCompletions": [
      {
        "value": "string",
        "highlight": "string",
        "matchType": "string",
        "rank": 0,
        "metadata": {
          "id": "string",
          "slug": "string"
        }
      }
    ]
  }
}