O que preciso solicitar ao cliente?
Acesso do Omie (login e senha);
Caso seja de preferência do seller, eles poderão apenas compartilhar o acesso com a nossa conta do Omie:
equipe@vnda.com.br
Confirmar se o estoque deverá ser sincronizado.
Obtendo os dados no Omie
Acesse a conta do cliente no Omie e crie o usuário API, seguindo os passos abaixo:
Acesse as preferências do app da loja no página inicial (engrenagem no canto superior direito), e clique em "Resumo do App";
Na página seguinte, copie os dados APP_KEY e APP_SECRET;
Salve essas informações em algum lugar, como um bloco de notas, por exemplo;
Garantir que os produtos estejam cadastrados em ambos os sistemas (na Vnda e no Omie)
Caso o app alvo não tenha sido compartilhado com a conta logada será necessário alterar nas configurações do teste de API para inserir as chaves do app.
Com a APP KEY e o APP SECRET em mãos, precisamos consultar no Omie (para depois cadastrar no Hub) as seguintes informações:
Etapa inicial do pedido
Categoria do pedido
Código das formas de pagamento
Conta corrente do pedido
❗ Em todas as URLs de consulta do Omie, é preciso alterar XXXXXXX (após o APP KEY= ) e YYYYYYYYYYYY (após o APP SECRET= ) na URL pelos dados da loja (obtidos anteriormente).
Recentemente houve uma atualização em que é preciso ter um usuário no Omie para consultar os campos, então o ideal é solicitar o acesso ao Omie.
Consulta de Dados
1. Etapa inicial do pedido (vem da configuração no Omie)
1. Etapa inicial do pedido (vem da configuração no Omie)
Consultar em:
https://app.omie.com.br/developer/api-test/?APP_KEY=XXXXXXXXXXX_SECRET=YYYYYYYYYYYYYYY&ENDPOINT=https%3A%2F%2Fapp.omie.com.br%2Fapi%2Fv1%2Fprodutos%2Fpedidoetapas%2F&OMIE_CALL=ListarEtapasPedido&PARAMS=%257B%2B%2B%2522nPagina%2522%253A%2B1%252C%2B%2B%2522nRegPorPagina%2522%253A%2B20%257D
A informação que precisamos está no campo cEtapa. Normalmente os clientes que utilizam Omie configuram a etapa '10' para o pedido entrar como um pedido de venda na Omie.
Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie.
Os valores são fixos, mas o seller pode personalizar as descrições (ou seja, as funções atribuídas a cada coluna). A API fornece essas descrições.
Se o seller tiver customizado as etapas do pedido, utilize a tag cCodigo do método ListarEtapasFaturamento, disponível na rota /api/v1/produtos/etapafat/, para obter essa informação.
Consulte em:
https://app.omie.com.br/developer/api-test/?APP_KEY=XXXXXXXXXXX_SECRET=YYYYYYYYYYYYYYY&ENDPOINT=https%3A%2F%2Fapp.omie.com.br%2Fapi%2Fv1%2Fprodutos%2Fpedidoetapas%2F&OMIE_CALL=ListarEtapasPedido&PARAMS=%257B%2B%2B%2522nPagina%2522%253A%2B1%252C%2B%2B%2522nRegPorPagina%2522%253A%2B20%257D
Os valores disponíveis para esse campo podem ser:
10 - Primeira coluna
20 - Segunda coluna
30 - Terceira coluna
40 - Quarta coluna
50 - Faturar
Como padrão, pode-se utilizar o "10".
2. Categoria do pedido (vem da configuração no Omie)
2. Categoria do pedido (vem da configuração no Omie)
Consultar em:
https://app.omie.com.br/developer/api-test/?APP_KEY=XXXXXXXXXXX_SECRET=YYYYYYYYYYYYYYY&ENDPOINT=https%3A%2F%2Fapp.omie.com.br%2Fapi%2Fv1%2Fgeral%2Fcategorias%2F&OMIE_CALL=ListarCategorias&PARAMS=%257B%2B%2B%2522pagina%2522%253A%2B1%252C%2B%2B%2522registros_por_pagina%2522%253A%2B50%257D
A informação que precisamos está no campo codigo
Como padrão, pode-se utilizar "1.01.01"
3. Código das formas de pagamento (vem da configuração no Omie)
3. Código das formas de pagamento (vem da configuração no Omie)
Consultar em:
https://app.omie.com.br/developer/api-test/?APP_KEY=XXXXXXXXXXX_SECRET=YYYYYYYYYYYYYYY&ENDPOINT=https%3A%2F%2Fapp.omie.com.br%2Fapi%2Fv1%2Fprodutos%2Fformaspagcompras%2F&OMIE_CALL=ListarFormasPagCompras&PARAMS=%257B%2B%2B%2522pagina%2522%253A%2B1%252C%2B%2B%2522registros_por_pagina%2522%253A%2B50%257D
A informação que precisamos está no campo cCodigo
Normalmente são todas as opções de parcelamento e a modalidade à vista, que seguem exemplo abaixo:
{
"cCodigo": "001",
"cDescricao": "1 Parcela",
"nQtdeParc": 1
},
{
"cCodigo": "002",
"cDescricao": "2 Parcelas",
"nQtdeParc": 2
},
{
"cCodigo": "003",
"cDescricao": "3 Parcelas",
"nQtdeParc": 3
},
{
"cCodigo": "004",
"cDescricao": "4 Parcelas",
"nQtdeParc": 4
},
{
"cCodigo": "005",
"cDescricao": "5 Parcelas",
"nQtdeParc": 5
},
{
"cCodigo": "006",
"cDescricao": "6 Parcelas",
"nQtdeParc": 6
4. Conta corrente do pedido (vem da configuração no Omie)
4. Conta corrente do pedido (vem da configuração no Omie)
Consultar em:
https://app.omie.com.br/developer/api-test/?APP_KEY=XXXXXXXXXXX_SECRET=YYYYYYYYYYYYYYY&ENDPOINT=https%3A%2F%2Fapp.omie.com.br%2Fapi%2Fv1%2Fgeral%2Fcontacorrente%2F&OMIE_CALL=ListarContasCorrentes&PARAMS=%257B%2B%2B%2522pagina%2522%253A%2B1%252C%2B%2B%2522registros_por_pagina%2522%253A%2B100%252C%2B%2B%2522apenas_importado_api%2522%253A%2B%2522N%2522%257D
A informação de que precisamos está no campo nCodCC
Caso o cliente tenha mais de uma conta cadastrada, cite todas as contas listadas pela API e peça que ele confirme qual será utilizada para o e-commerce. Se o cliente não tiver nenhuma cadastrada, peça que ele cadastre uma.
5. Transportadoras (a partir do cadastro do cliente)
5. Transportadoras (a partir do cadastro do cliente)
Consultar em:
https://app.omie.com.br/developer/api-test/?APP_KEY=XXXXXXXXXXXX&APP_SECRET=YYYYYYYYYYYY&ENDPOINT=https%3A%2F%2Fapp.omie.com.br%2Fapi%2Fv1%2Fgeral%2Fclientes%2F&OMIE_CALL=ListarClientes&PARAMS={"pagina"%3A1%2C"registros_por_pagina"%3A50%2C"apenas_importado_api"%3A"N"%2C"clientesFiltro"%3A{"tags"%3A{"tag"%3A"Transportadora"}}}
*A transportadora precisa conter a tag "Transportadora" no Omie para retornar. Aqui o Omie explica como inserir essa tag.
Cadastrar mapeamento da seguinte forma:
De: nome da forma de entrega entre parênteses
Para: Código no campo
"codigo_cliente_omie"da resposta na chamada
6. Vendedores (a partir do cadastro do cliente)
6. Vendedores (a partir do cadastro do cliente)
Consultar em:
https://app.omie.com.br/developer/api-test/?APP_KEY=XXXXXXXXXXX_SECRET=YYYYYYYYYYYY&ENDPOINT=https%3A%2F%2Fapp.omie.com.br%2Fapi%2Fv1%2Fcrm%2Fusuarios%2F&OMIE_CALL=ListarUsuarios&PARAMS=%257B%2B%2B%2522pagina%2522%253A%2B1%252C%2B%2B%2522registros_por_pagina%2522%253A%2B20%257D
A informação de que precisamos está no campo nCodigo. É necessário que o cliente cadastre e vincule o cadastro como vendedor para conseguir fazer o envio dos dados para o ERP.
Cadastrando a integração no HUB
Após termos todas as informações acima, é preciso realizar o cadastro no HUB.
No admin Vnda, acessar em: Configurações > Sistemas ERP. Clique no botão "adicionar nova integração" e preencha os dados a seguir:
Integração: Omie
Ativa?: Sim
Identificador do pacote: deixar em branco
Identificador do centro de distribuição: deixar em branco
Prefixo do Pedido: deixar em branco
Restaurar estoque em caso de falha?: Não
Reservar estoque em caso de falha?: Não
Zerar estoque de SKUs não encontrados no ERP? Não
Status para encaminhar para outras integrações: deixar em branco
Sincronizar estoque com o: E-commerce
Salvar personalização de produto como: deixar em branco
Chave da APP: APP KEY informada pelo cliente na etapa 1
Senha da app: APP SECRET informada pelo cliente na etapa 1
Integrar estoque automaticamente: confirmar com o cliente
Etapa inicial do pedido: obtida aqui
Categoria do pedido: obtida aqui
Conta corrente do pedido: obtida aqui
Enviar email do pedido: Não
Buscar notas fiscais: Não
Faturar pedido automaticamente: Não
Tipo do frete (modalidade):
0 - Frete por conta do emitente
1 - Frete por conta do destinatário
2 - Frete por conta de terceiros
9 - sem frete
Usar créditos como forma de pagamento: Sim (Envia Giftcard e Refund como pagamento para o Omie, sendo necessário mapear)
Código do local do estoque: Código do local para dar baixa no estoque, o local de consulta de estoque continuará sendo o estoque default.
Usar o campo codigo_local_estoque para selecionar o depósito desejado, consultar abaixo.
Se o cliente deseja utilizar a solução de créditos e deseja que Refund e Giftcard entrem como pagamento, não pode usar os webhooks de order-confirmed, o HUB precisa importar sozinho os pedidos.
Faça um pedido teste para o ERP e peça ao cliente para validar os dados do pedido que entrou (principalmente informações de frete e de pagamento, que podem necessitar de um mapeamento).
Mapeando a integração no Hub
Meios de pagamento
Exemplos:
de Pix para PIX
de Boleto para BOL
de Visa - Crédito para CRC
de Mastercard - Crédito para CRC
de credits - para Vou.
credits refere-se a forma de pagamento de créditos quando a opção Usar créditos como forma de pagamento está como Sim. Necessário verificar a qual forma de pagamento o seller quer vincular no ERP caso positivo.
Condição de pagamento
Exemplo:
de Crédito-6 para 006 (Código "para" é obtido na etapa Códigos das formas de pagamento)
Exemplo de mapeamentos em funcionamento:
Mapeamento de Entrega
Exemplo:
de pac para Código correspondente em Transportadoras
O campo "de" refere-se à descrição da forma de entrega (entre parênteses no admin, sem caracteres especiais e espaços).
Mapeamento de Conta Corrente
Esse mapeamento é utilizado quando o cliente não deseja utilizar um único código da Conta corrente do pedido de acordo como preenchido no campo nas preferências.
Através desse mapeamento, os clientes conseguem definir diferentes taxas e prazo de recebimento.
Os códigos do "para" são os obtidos em Conta corrente do pedido
Exemplo:
de Visa - Crédito para 2004140553
de Mastercard - Crédito para 2004139814
Mapeamento de Vendedor
Esse mapeamento é utilizado quando o cliente deseja vincular o vendedor do pedido ao pedido enviado ao Omie.
Os códigos do "para" são os obtidos na chamada Consultar os vendedores.
Exemplo:
de código externo para nCodigo.
Para obter o código externo, acesse o menu "Usuários" no admin, em Configurações > Geral > Usuários