Evento de Busca

Registra uma busca. Sempre que uma busca for realizada, este evento deve ser enviado.

Body Params

query
stringrequired

Termo buscado

searchId
string

Obrigatório se estiver utilizando a API de Busca

Você deverá passar a mesma propriedade searchId retornada pela API de Busca.

items
SearchItem[]required
Lista de produtos retornados na busca

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

source
stringrequired

Origem do dispositivo utilizado. Os tipos padrões são:
  • desktop
  • mobile
  • app
Novos canais podem ser criados nos dashboards dos produtos, caso os canais padrões não atendam a necessidade.

deviceId
stringrequired

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

salesChannel
string

Identificador do canal de venda.

user
User
Objeto contendo informações do usuário logado

Se torna obrigatório se o usuário estiver logado

Edit this page on GitHub
SDK
import { EventClient } from '@linximpulse/impulse-sdk-js'

const event = new EventClient({
  type: 'backend',
  apiKey: '<my-api-key>',
  secretKey: '<my-secret-key>',
  deviceId: '<my-device-id>'
})

await event.search()
  .source('desktop')
  .deviceId('<my-device-id>')
  .query('calça')
  .searchId('<linx-impulse-search-id>')
  .items([
    {
      pid: "123456"
    },
    {
      pid: "456"
    }
  ])
  .send()
Typescript
import axios from 'axios'

await axios.post("https://api.event.linximpulse.net/v7/events/views/search", {
  apiKey: "<my-api-key>",
  secretKey: "<my-secret-key>",
  deviceId: "<my-device-id>",
  source: "desktop",
  query: "calça",
  searchId: "<linx-impulse-search-id>",
  items: [
    {
      pid: "123456"
    },
    {
      pid: "456"
    }
  ]
})
curl
curl -0 -v -X POST "https://api.event.linximpulse.net/v7/events/views/search" \
-H "Content-type: application/json" \
-d @- << EOF
{
  "apiKey": "<my-api-key>",
  "secretKey": "<my-secret-key>",
  "deviceId": "<my-device-id>",
  "source": "desktop",
  "query": "calça",
  "searchId": "<linx-impulse-search-id>",
  "items": [
    {
      "pid": "123456"
    },
    {
      "pid": "456"
    }
  ]
}
EOF