Search

A query search retorna informações sobre a busca e produtos relevantes aos termos de consulta.

Requisição

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
operation	Enum Operation	Não	Operação de busca para os termos de consulta. Por padrão é AND
partnerAccessToken	String	Não	Token de parceiro, utilizado para filtrar os produtos exibidos ao parceiro
query	String	Sim	Termos a serem buscados
ignoreDisplayRules	Bool	Não	Ignora regras de exibição

📘
O operador AND realiza a busca priorizando resultados que contenham todos os termos de consulta. O operador OR, por sua vez, realiza a busca para todos os resultados que contenham cada um dos termos.

Campos

Campo	Descrição
aggregations	Informações dos produtos retornados para montagem de filtros na página (ex: Cores, Marcas, categorias, etc)
banners	Lista de banners a serem exibidos em buscas
breadcrumbs	Lista de breadcrumbs relativas à busca
contents	Lista de conteúdos a serem exibidos em buscas
forbiddenTerm	Sugestão de outra busca, caso o termo buscado seja um "Termo Sugerido" cadastrado no Admin da loja
products	Lista de produtos paginados por cursor
productsByOffset	Lista de produtos paginados por offset
redirectUrl	URL de redirecionamento caso o termo buscado seja um "Termo Redirecionado" cadastrado no Admin da loja
searchTime	Tempo levado para realizar a busca

Exemplo

Neste exemplo são pedidas informações dos 2 primeiros produtos para a busca por "tenis":

query {
  search(query:"tenis") {
    products(first:2) {
      edges {
        node {
          productId
          productName
          productVariantId
        }
      }
    }
      breadcrumbs{
      link
      text
    }
  }
    redirectUrl
  }

Mostrar resposta

{
  "data": {
    "search": {
      "products": {
        "edges": [
          {
            "node": {
              "productId": 175349,
              "productName": "Tênis Modare Casual 7339.200.19046.52531",
              "productVariantId": 372467
            }
          },
          {
            "node": {
              "productId": 129154,
              "productName": "Tênis Nike Revolution 5-C - Feminino - TESTE",
              "productVariantId": 321675
            }
          }
        ]
      },
        "breadcrumbs": [
        {
          "link": "busca",
          "text": "Busca"
        },
        {
          "link": "busca?busca=tenis",
          "text": "tenis"
        }
      ],
      "redirectUrl": "https://teste.com.br/teste"  
    }
  }
}

Informações de BuyBox de produto

Abaixo temos o exemplo de informações BuyBox de um produto:

{
  search(query: "Jogo de Taças") {
    products(first: 1) {
      nodes {
        id
        productId
        productName
        buyBox {
          installmentPlans {
            displayName
            installments {
              discount
              fees
              number
              value
            }
            name
          }
          maximumPrice
          minimumPrice
          quantityOffers
          sellers {
            name
          }
        }
      }
    }
  }
}

Mostrar resposta

{
	"data": {
		"search": {
			"products": {
				"nodes": [
					{
						"id": "eyJFbnRpdHkiOiJQcm9kdWN0IiwiSWQiOjMxMDUzMn0=",
						"productId": 123014,
						"productName": "Jogo de Taças",
						"buyBox": {
							"installmentPlans": [
								{
									"displayName": "Cartão Sem Desconto",
									"installments": [
										{
											"discount": true,
											"fees": false,
											"number": 1,
											"value": 197.99
										}
									],
									"name": "Vindi - Cartão"
								}
							],
							"maximumPrice": 500,
							"minimumPrice": 219.99,
							"quantityOffers": 2,
							"sellers": [
								{
									"name": "Loja Canais"
								}
							]
						}
					}
				]
			}
		}
	}
}

Busca secundária automática

Abaixo temos o exemplo de uma consulta de busca secundária:

query {
  search(query:"tenis preto vermelho", autoSecondSearch:true){
    products(first:2){
      edges{
        cursor
        node{
          id
          productId
          productName
          productVariantId
        }
      }
    }
  }
}

Mostrar resposta

{
  "data": {
    "search": {
      "products": {
        "edges": [
          {
            "cursor": "eyJPZmZzZXQiOjF9",
            "node": {
              "id": "eyJFbnRpdHkiOiJQcm9kdWN0IiwiSWQiOjMxNjY0000=",
              "productId": 130130,
              "productName": "Tênis All Star Vermelho",
              "productVariantId": 316643
            }
          },
          {
            "cursor": "eyJPZmZzZXQiOjJ9",
            "node": {
              "id": "eyJFbnRpdHkiOiJQcm9kdWN0IiwiSWQiOjMxNjY0110=",
              "productId": 130129,
              "productName": "Tênis All Star Preto",
              "productVariantId": 316640
            }
          }
        ]
      }
    }
  }
}