Autocomplete de Produtos

Este endpoint necessita da correta implementação do tracking de cliques de usuário. Caso ainda não tenha implementado o tracking corretamente, acesse /clicks

Esta requisição é utilizada para obter a lista de sugestões de produtos, a partir de uma consulta completa. É usado normalmente quando uma sugestão de busca é previamente selecionada, como em um "mouse over" ou selecionada navegando pelas setas do teclado.

Como fazer a consulta?

Para realizar uma consulta, utilize diretamente a rota:

curl
curl -v -G "https://api.linximpulse.com/engage/search/v3/autocompletes/products" \
  -d apiKey="<my-apikey>" \
  -d secretKey="<my-secret-key>" \
  -d terms="batom"

Padrão de Resposta

Os produtos retornados estarão no campo products.

Query Params

terms
stringrequired

Termos da consulta que deseja-se realizar.

apiKey
stringrequired

ID interno de identificação da sua loja.

Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br

secretKey
stringrequired

Chave de acesso para autenticar a requisição. Pode ser substituída pelo parâmetro origin quando a requisição é feita via frontend para não expor a chave.

Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br

deviceId
stringrequired

Identificador único do dispositivo. Todas as requisições feitas a partir do mesmo dispositivo devem possuir o mesmo deviceId.

source
stringrequired

Origem do dispositivo utilizado. Os tipos padrões são:
  • desktop
  • mobile
  • app
Novos canais podem ser criados no Dashboard da Busca, caso os canais padrões não atendam a necessidade.
Caso um valor inválido seja informado, irá impactar o registro de métricas de desempenho e KPIs da solução de busca.

origin
string

Define a URL de origem da requisição. Pode ser usada no lugar da secretKey para autenticar a requisição.

salesChannel
string

ID de canais de vendas. Para consultar mais de um canal, insira um campo adicional.

hide
string

Desativa retorno de campos na resposta. Por padrão todos os campos são ativos. Para incluir mais de uma opção, insira um campo adicional.Valores permitidos:
  • products
  • quickFilters
  • banners
  • adSearches
  • suggestions
  • filters

productFormat
string default: relevance

Define o formato de resposta dos produtos. Por padrão todos os campos são ativos.Valores permitidos:
  • onlyIds
  • complete
  • compact

userId
string

Id do usuário. Deve ser o mesmo identificador utilizado no site. (Quando o usuário estiver logado)

resultsProducts
number default: 5

Número máximo de sugestões de produtos desejado.

categoryId
string

Quando a opção de busca selecionada tem uma categoria atrelada, o ID da categoria deve ser passado neste parâmetro.
Obs.: O valor do campo categoryId a ser passado precisa ser igual ao campo queries[].categoryId retornado na rota /autocompletes.

Edit this page on GitHub
Typescript
const fetch = require('node-fetch');

const url = 'https://api.linximpulse.com/engage/search/v3/autocompletes/products?resultsProducts=5&productFormat=complete';
const options = {method: 'GET', headers: {accept: 'application/json'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
curl
curl -v -G "https://api.linximpulse.com/engage/search/v3/autocompletes/products" \
    -d apiKey="<my-apikey>" \
    -d secretKey="<my-secret-key>" \
    -d terms="batom"
Full Response
{
  "requestId": "09af5a74-0b94-490d-b991-75229341c392",
  "searchId": "09af5a74-0b94-490d-b991-75229341c392",
  "products": [
    {
      "id": "1123077",
      "collectInfo": {
        "productId": "1123077",
        "skuList": []
      },
      "clickUrl": "/engage/search/v3/clicks?apikey=<my-api-key>&trackingId=<tracking-id>",
      "name": "Smartphone Verde Tela 6.5\" Câmera Traseira 13MP 4GB RAM",
      "price": 699,
      "oldPrice": 1032,
      "url": "//www.my-store.com.br/smartphone-verde-tela-6-5?origin=autocomplete",
      "images": {
        "default": "//www.my-store.com.br/Products/files/1123077.jpg"
      },
      "installment": {
        "count": 10,
        "price": 69.9
      },
      "status": "AVAILABLE",
      "skus": [
        {
          "sku": "1123078",
          "specs": {},
          "properties": {
            "name": "Smartphone Verde Tela 6.5\" Câmera Traseira 13MP 4GB RAM",
            "url": "//www.my-store.com.br/smartphone-verde-tela-6-5",
            "images": {
              "default": "//www.my-store.com.br/Products/files/1123077.jpg"
            },
            "status": "available",
            "price": 699,
            "installment": {
              "count": 10,
              "price": 69.9
            },
            "oldPrice": 1032,
            "eanCode": "7892597353057",
            "details": {},
            "flags": [
              {
                "name": "superofertaflag",
                "url": "/Flags/0008_flag_637885583316058101.png",
                "id": 8
              }
            ]
          }
        }
      ],
      "categories": [
        {
          "id": "1060",
          "name": "Celular e Smartphone",
          "parents": [],
          "used": true
        }
      ],
      "tags": [
        {
          "id": "superofertas",
          "name": "superofertas",
          "parents": []
        }
      ],
      "specs": {},
      "created": "2023-02-06 17:43:57",
      "brand": "my-brand",
      "description": "Smartphone Verde Tela 6.5\" Câmera Traseira 13MP 4GB RAM",
      "details": {}
    }
  ]
}