Página de Categoria

category

Na estrutura do catálogo de produtos há as categorias e subcategorias, para uma melhor organização. A particularidade dessas páginas são os ids das categorias/subcategorias definidas dentro do atributo categories. O id pode ser numeral ou o próprio nome da categoria/subcategoria, desde que seja único. Consideramos a categoria pai a que assume a posição 0 e as demais posições são subcategorias. Para validar se os ids estão corretos será necessário identificar um produto da categoria/subcategoria em questão e verificar como estão definidos no catálogo de produto da plataforma.

Vamos ver como enviar a coleta de categoria(s)! Aqui você declara apenas os parâmetros comuns a todos os eventos e os específicos de visualização da categoria: categories: {...}

Building reference
import { EventClient } from '@linximpulse/impulse-sdk-js'

//Declare os parâmetros obrigatórios para o construtor
const client = new EventClient({...})

const categoryEvent = client.category()
  .categories([ // categories de maneira hierárquica
    {
      id: "0",
      name: "CONVENIENCIA"
    }
  ])
  .deviceId('fb4e49b6-35e3-42a1-a397-960f0b37ab6a')
  .user({...}) // se o usuário estiver logado
  .url('https://www.minhaloja.com.br/conveniencia')
  
await categoryEvent.send()
All at send
import { EventClient } from '@linximpulse/impulse-sdk-js'

//Declare os parâmetros obrigatórios para o construtor
const client = new EventClient({...})

await client.category()
  .send({
    source: 'desktop',
    categories: [ // categories de maneira hierárquica
      {
        id: "0",
        name: "CONVENIENCIA"
      }
    ],
    user: {...}, // se o usuário estiver logado
    url: "https://www.minhaloja.com.br/conveniencia"
  })

API Reference

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

url
stringrequired

URL da página atual no padrão https://minhaloja.com

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[]

Lista de canais de venda selecionados. Apenas para lojas que utilizam canais de venda.

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

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

categories
string[]required
Lista de categorias da página. Pode ser uma lista simples de string ou um objeto estruturado.
Edit this page on GitHub