A Dito extrai os dados através da API disponibilizada pela Microvix.

Credencial necessária

  • Microvix Key (Token).

Informações obrigatórias antes das extrações de dados

  • Lista dos IDs dos CFOPs de vendas e devoluções que devem ser considerados para cálculo do faturamento das lojas.

🚧

Importante!

CFOP é o Código Fiscal de Operações e Prestações.

Esses códigos identificam as operações por categoria no momento da emissão da nota fiscal e nem todas são consideradas pelo financeiro das marcas para compor a receita.

Por isso o envio dessa lista dos IDs dos CFOPs validada pela marca para a Dito é tão importante antes do início das extrações dos dados, para que não haja divergências no momento de validar a receita da marca na Dito.


Extração dos dados

Para extração dos dados, a Dito dito acessa apenas um endpoint, mudando apenas o corpo da requisição para acessar as Lojas, Produtos, Clientes, Vendedores e Transações:


Grupo de lojas - Corpo da requisição para obter os dados:

<?xml version="1.0" encoding="utf-8"?>
<LinxMicrovix>
    <Authentication user="linx_export" password="linx_export" />
    <ResponseFormat>csv</ResponseFormat>
    <Command>
        <Name>LinxGrupoLojas</Name>
        <Parameters>
            <Parameter id="chave">TOKEN</Parameter>
        </Parameters>
    </Command>
</LinxMicrovix>

Produtos - Corpo da requisição para obter os dados:

<?xml version="1.0" encoding="utf-8"?>
<LinxMicrovix>
    <Authentication user="linx_export" password="linx_export" />
    <ResponseFormat>csv</ResponseFormat>
    <IdPortal>295</IdPortal>
    <Command>
        <Name>LinxProdutos</Name>
        <Parameters>
            <Parameter id="chave">TOKEN</Parameter>
            <Parameter id="cnpjEmp">11629461000225</Parameter>
            <Parameter id="id_setor">NULL</Parameter>
            <Parameter id="id_linha">NULL</Parameter>
            <Parameter id="id_marca">NULL</Parameter>
            <Parameter id="id_colecao">NULL</Parameter>
            <Parameter id="dt_update_inicio">NULL</Parameter>
            <Parameter id="dt_update_fim">NULL</Parameter>
        </Parameters>
    </Command>
</LinxMicrovix>

Clientes - Corpo da requisição para obter os dados:

<?xml version="1.0" encoding="utf-8"?>
<LinxMicrovix>
    <Authentication user="linx_export" password="linx_export" />
    <ResponseFormat>csv</ResponseFormat>
    <Command>
        <Name>LinxClientesFornec</Name>
        <Parameters>
            <Parameter id="chave">TOKEN</Parameter>
            <Parameter id="cnpjEmp">25270948000198</Parameter>
            <Parameter id="data_inicial">1759-01-01</Parameter>
            <Parameter id="data_fim">9999-12-31</Parameter>
            <!-- <Parameter id="dt_update_inicial">2023-01-01</Parameter> -->
            <Parameter id="dt_update_inicial">2022-12-31</Parameter>
            <Parameter id="dt_update_fim">2023-01-02</Parameter>
        </Parameters>
    </Command>
</LinxMicrovix>

Vendedores - Corpo da requisição para obter os dados:

<?xml version="1.0" encoding="utf-8"?>
<LinxMicrovix>
    <Authentication user="linx_export" password="linx_export" />
    <ResponseFormat>csv</ResponseFormat>
    <Command>
        <Name>LinxVendedores</Name>
        <Parameters>
            <Parameter id="chave">TOKEN</Parameter>
            <Parameter id="cnpjEmp">22939305000287</Parameter>
            <!-- <Parameter id="cod_vendedor">1145</Parameter> -->
            <Parameter id="data_upd_inicial">NULL</Parameter>
            <Parameter id="data_upd_fim">NULL</Parameter>
        </Parameters>
    </Command>
</LinxMicrovix>

Lojas - Corpo da requisição para obter os dados:

<?xml version="1.0" encoding="utf-8"?>
<LinxMicrovix>
    <Authentication user="linx_export" password="linx_export" />
    <ResponseFormat>csv</ResponseFormat>
    <Command>
        <Name>LinxLojas</Name>
        <Parameters>
            <Parameter id="chave">TOKEN</Parameter>
            <Parameter id="cnpjEmp">17097431000544</Parameter>
        </Parameters>
    </Command>
</LinxMicrovix>

Transações - Corpo da requisição para obter os dados:

<?xml version="1.0" encoding="utf-8"?>
<LinxMicrovix>
    <Authentication user="linx_export" password="linx_export" />
    <ResponseFormat>csv</ResponseFormat>
    <IdPortal>16427</IdPortal>
    <Command>
        <Name>LinxMovimento</Name>
        <Parameters>
            <Parameter id="chave">TOKEN</Parameter>
            <Parameter id="cnpjEmp">46925421000124</Parameter>
            <Parameter id="data_inicial">2023-06-30</Parameter>
            <Parameter id="data_fim">2023-06-30</Parameter>
        </Parameters>
    </Command>
</LinxMicrovix>

Horário da extração

Todos os acessos ocorrem de madrugada entre 0h e 3h, exceto o primeiro acesso onde iremos pegar a carga retroativa completa do cliente e o tempo de processamento vai depender da quantidade de dados que o cliente possui.

Plano de tracking:

A estrutura dos dados que serão obtidos é padronizada neste tipo de integração, ou seja, não é possível alterar, nem incluir novos tipos de dados.

Dados dos Usuários


Dados do UsuárioCadastro do UsuárioGlossário Dito
ID
Nome
E-mail
Cidade
Data de nascimento
Gênero

cpf
Telefone
Endereço
Bairro
UF
dito.identify({
id: dito.generateID('99999999999'),
name: 'Nome Usuário',
email: '[email protected] ',
location: 'Cidade',
birthday: '22/12/1997'
gender: 'female'
data: {
cpf: '999.999.999-99',
telefone: '31988887777',
endereco: 'Nome Rua, 33',
bairro: 'Bairro',
uf: 'SP',
}
});
ID: Informação única utilizada para identificar
e registrar os usuários durante a coleta de
informações que estarão presentes na ficha
dos mesmos. Recomendamos que ele esteja
em todas as páginas do seu ambiente.
São exemplos de IDs: CPF, e-mail e código próprio.

Dados dos Eventos

Página/açãoEventoPropriedades (exemplo)Glossário Dito
Cadastrouregister- browser (Firefox)
- dispositivo (Desktop)
- sistema_operacional (Windows)
- utm_source (Dito)
- utm_medium (email)
- utm_campaign (Dito-vendas-recorrentes)
Evento padrão

As propriedades listadas no 'Evento padrão'
também serão adicionadas automaticamente
em todos os eventos listados nesse plano.
ComproucomprouRevenue (xxxx)

- codigo_vendedor": "44",
- controle": "545",
- data_at": "2021-12-09 17:49:37 +0000",
- fidelidade_pontos": "4",
- fidelidade_valor": "0.0",
- id_loja": "56",
- id_loja_presence": "56",
- id_transacao": "45346336",
- integracao_pedido": "N",
- loja": "teste56",
- loja_presence": "teste56",
- metodo_pagamento": "CARTAO CREDITO 1X",
- quantidade_produtos": "3",
- subtotal": "177",
- terminal": "1",
- tipo_loja": "OFFLINE",
- tipo_nota": "S",
- total": "177",
- total_desconto": "0",
- total_frete": "0",
- vendedor": "teste"
Comprou: Este evento representa o financeiro
de uma de compra faturada. Será registrado
uma única vez, contemplando os valores totais
da transação. Além disso, esse evento será
fundamental, pois é a partir dele que todas as
telas de resultados e relatórios financeiros,
serão nutridos.
Comprou produtocomprou-produto- id_transacao (8f4af5f2-838bsdsd4699aa47fb)
- id_produto (xxx)
- quantidade (1)
- preco_produto (159.95)
- grupo_produto (548)
- grupo_produto_subgrupo (VESTIDO)
- nome_produto (xxxxx)
- subcategoria_produto (xxx)
- tipo_produto (xxx)
- linha (xxx)
- transacao (xxx)
- cor (xxx)
- tamanho (04)
- cod_barras (xxx0)
Comprou produto: Este evento apresenta
as informações dos produtos e os dados
relacionados. Será registrado um evento
comprou-produto para cada produto único
que compõe a transação.

obs: caso o usuário compre o mesmo produto
em uma quantidade maior que 1, será registrado
apenas um deste evento, sendo a quantidade
sinalizada na propriedade "quantidade".
DevolveudevolveuRevenue (-xxx)

- dt_compra (2020-11-09T00:00:00-03:00)
- id_transacao (71dsfvdf98)
- total (-149.95)
- cpf vendedor (xxxx)
- portal (xxx)
- id_cfop (xx)
- desconto (0.0)
- quantidade_produtos (1)
- nome_vendedor (xxxx)
- codigo_vendedor (1128:1498)
- id_vendedor (xxx)
- cnpj (xxx)
- id_loja (xxx)
- loja (xxxx)
- documento (xxx)
- operacao (xx)
- transacao (xxx)
Devolveu: Este evento representa o financeiro
de uma de devolução. Será registrado uma
única vez, contemplando os valores totais da
transação, a fim de subtrair na receita total do
usuário.
Devolveu produtodevolveu-produto- id_transacao (8f4af5f2-838bsdsd4699aa47fb)
- id_produto (xxx)
- quantidade (1)
- preco_produto (159.95)
- grupo_produto (548)
- grupo_produto_subgrupo (VESTIDO)
- nome_produto (xxxxx)
- subcategoria_produto (xxx)
- tipo_produto (xxx)
- linha (xxx)
- transacao (xxx)
- cor (xxx)
- tamanho (04)
- cod_barras (xxx0)
Devolveu produto: Este evento apresenta
as informações dos produtos e os dados
relacionados a transação de devolução.
Será registrado um evento devolveu-produto
para cada produto único que compõe a
evolução.

obs: caso o usuário devolva o mesmo
produto em uma quantidade maior que 1,
será registrado apenas um deste evento,
sendo a quantidade sinalizada na propriedade "quantidade".

👍

Caso haja necessidade de alterar ou enviar outros dados que não estão no plano de tracking, é necessário que seja utilizada uma integração customizada.