Autocomplete

A query de autocomplete foi projetada para que possam ser retornadas sugestões de termos que complementem uma busca e, também, produtos relevantes à pesquisa que está sendo realizada pelo usuário/visitante no momento.

Ela pode ser utilizada tanto para complementar um termo buscado quanto para torná-lo mais específico no contexto da loja. Esta funcionalidade é comumente encontrada em caixas de pesquisa nas páginas web.

Exemplos

	Query	Retorno
Complemento de termo	camis	cama, camisa, camiseta, camisa plus, campo
Especificação de busca	camiseta	camiseta, camiseta infantil, camiseta kids, camiseta infantil meia malha

📘
A query pode ser executada em uma chamada AJAX vinculada ao input da barra de busca no site.

Requisição

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
query	String	Sim	Termo ou fragmento de termo a ser buscado
limit	Int	Não	O número máximo de itens retornados tanto para "sugestões de pesquisa" quanto para produtos retornados, quando requisitado. (Máximo de 15 itens)
partnerAccessToken	String	Não	Token de parceiro, utilizado para filtrar produtos que podem ser exibidos ao parceiro

Campos

Campo	Descrição
suggestions	Lista de sugestões para o termo fornecido
products	Lista de produtos relevantes para o termo fornecido

Exemplo

Neste exemplo são pedidas cinco sugestões de complemento para busca, o nome da variante e preço dos 5 primeiros produtos relevantes em relação ao termo "camiseta" buscado:

query{
  autocomplete(query: "camiseta", limit: 5) {
    suggestions
    products{
        variantName
        prices{
            price
        }
    }
  }
}

Mostrar resposta

{
    "data": {
        "autocomplete": {
            "suggestions": [
                "camiseta",
                "camiseta infantil",
                "camiseta infantil meia",
                "camiseta kids",
                "camiseta infantil meia malha"
            ],
            "products": [
                {
                    "variantName": "Camiseta Kids Narval",
                    "prices": {
                        "price": 69.9
                    }
                },
                {
                    "variantName": "Camiseta Kids Dragao",
                    "prices": {
                        "price": 109.9
                    }
                },
                {
                    "variantName": "Camiseta Lisa Menino Kids",
                    "prices": {
                        "price": 109.9
                    }
                },
                {
                    "variantName": "Camiseta Kids Lisa Menina",
                    "prices": {
                        "price": 39.9
                    }
                },
                {
                    "variantName": "Camiseta Infantil Meia Malha Manga Curta Básica - Branco",
                    "prices": {
                        "price": 28.8
                    }
                }
            ]
        }
    }
}

Retornando o campo aliasComplete relacionado ao produto

Abaixo temos um exemplo do retorno do campo aliasComplete, onde traz o alias relacionado ao produto e que leva em consideração a configuração Configuração de URL de Produto dentro do painel administrativo.

query {
  autocomplete(query: "tenis") {
    products {
      alias: aliasComplete
      variantName
    }
  }
}

Mostrar resposta

{
  "data": {
    "autocomplete": {
      "products": [
        {
          "alias": "produto/tenis-fila-iconic-feminino-fo2st004028-175338",
          "variantName": "Roupeiro GRP8.32"
        },
        {
          "alias": "produto/tenis-modare-casual-feminino-7354-100-20858-76088-175348",
          "variantName": "Roupeiro GRP8.32"
        }
      ]
    }
  }
}