Yep: o que é, quais os pré-requisitos e como instalar

O que é e quais são os pré-requisitos
A integração entre o ERP e o Yep importa automaticamente os pedidos para sua conta, agilizando a emissão de notas fiscais e o controle de estoque.
Recursos disponíveis
| Receber pedidos | ✔ |
| Receber produtos | ✔ |
| Enviar produtos | ✔ |
| Enviar estoque | ✔ |
| Enviar preços | ✔ |
| Sincronizar situação | ✔ |
| OMS | ✔ |
Como configurar a integração
Atenção: se sua versão da Yep for diferente de 1.9, 2.0 e 2.3, recomendamos que você faça testes de fluxo para garantir que a integração funcione corretamente.
Confira nesta seção:
1. Configurando a Yep
Crie um Papel (Role) para acesso ao WebServices.
- Acesse o Painel de Administração da sua loja Yep.
- No menu System, selecione a opção WebServices e depois SOAP/XML-RPC - Roles (ou apenas Roles).
- Na tela seguinte, clique em Add New Role.
- No campo Role Name, insira uma descrição para o papel (por exemplo, "ERP").
- No campo Current Admin Password, digite a senha do administrador da Yep.
- Clique em Save Role.
- Agora, clique em Role Resources.
- No campo Resource Access, atribua All (Todas) as funções.
- Clique em Save Role novamente.
Crie um Usuário para acesso ao WebServices
- Ainda no Painel de Administração da sua loja Yep.
- No menu System, selecione a opção WebServices e depois SOAP/XML-RPC - Users (ou apenas Users).
- Clique no botão Add New User.
- Preencha os seguintes dados do usuário:
- Current Admin Password: Informe a senha do administrador do seu painel Yep.
- API Key: Informe a senha de acesso para este novo usuário.
- API Key Confirmation: Repita a senha informada no campo "API Key".
- Clique em Save User.
- Após salvar o usuário, você precisa vinculá-lo ao papel que criou anteriormente. Acesse a aba User Role.
- Marque a opção Admin.
- Clique em Save User.
2. Configurando no ERP
- Para iniciar a configuração no ERP, siga os passos abaixo:
- Acesse o menu → Início → Integrações.
- Clique em Adicionar Integração.
- Busque por "Yep" e clique em Instalar.
Aba Integração
- No campo Nome, informe um nome para a integração no ERP (ex: "Minha Loja Yep").
- Na seção Autenticação, preencha os campos com as credenciais do usuário que você criou na Yep.
- Clique em Testar Configurações para validar as credenciais de login.
Aba Configurações
Nesta aba, você definirá diversas opções de sincronização:
1. Sincronização de Produtos
- Enviar imagens dos produtos ao sincronizar: Escolha como as imagens dos produtos no ERP serão enviadas para a Yep.
- Enviar imagens do produto pai nas variações: Ative para que as imagens do produto pai sejam enviadas para as variações sem imagem própria.
- Ao importar produtos: Escolha como o ERP receberá as imagens dos produtos importados da Yep.
- Enviar categoria na atualização do produto: Ative para que a categoria do produto seja enviada ao atualizar produtos existentes na Yep.
- Na importação de produtos, ao atualizar um produto, atualizar o código (SKU): Ative para que o código SKU seja atualizado no ERP ao importar produtos.
- Envio e importação de produtos com variações (beta): Ative para enviar e importar produtos com variações. (Configuração válida apenas para Yep 2.3)
- Atualizar o produto em todos os escopos: Ative para atualizar os produtos em todos os store modes. (Configuração válida apenas para Yep 2.3)
2. Sincronização de Pedidos
- Sincronização automática de pedidos: Ative para usar o recurso de OMS na integração. (Saiba mais sobre OMS na Central de Ajuda do ERP).
- Importar valor do frete nos pedidos: Ative para importar o valor do frete nos pedidos.
- Importar forma de recebimento nos pedidos: Ative para receber a forma de recebimento. As configurações devem ser feitas na aba Formas de Recebimento.
- Importar campo "shipping_description" como: Escolha entre "Transportadora" ou "Transportadora + Prazo de Entrega".
- Importar transportadora ou forma de frete: Ative para importar a forma de frete da transportadora.
- Shipping Carrier para envio de código de rastreio: Preencha este campo com o Shipping Carrier da Yep para que o código de rastreio do ERP seja enviado.
- Enviar rastreamento ao alterar a situação no ERP para Enviado: Ative para enviar o código de rastreio automaticamente quando o pedido for alterado para "Enviado" no ERP.
- Formatar nome dos contatos no recebimento dos pedidos: Ative para formatar o nome e sobrenome do cliente com iniciais maiúsculas ao importar pedidos.
- Importar campo COMPANY quando cliente for pessoa jurídica: Ative para importar o campo "company" para o ERP quando o cliente for pessoa jurídica. Se desabilitado, serão importados "firstname" e "lastname".
- Completar endereço do cliente a partir do CEP na importação de pedidos: Ative para que o endereço seja preenchido no ERP a partir do CEP. Se escolher Sempre, o CEP será validado nos Correios.
- Adicionar o endereço do cliente nas observações da venda: Ative para incluir o endereço do cliente nas observações da venda ao importar o pedido.
- Inclui observação no pedido da Yep com o número da nota fiscal ou venda: Ative para incluir os números da nota fiscal ou venda nas observações do pedido da Yep.
- Enviar e-mail, através da plataforma, ao enviar rastreamento para a Yep: Ative para que um e-mail seja enviado ao enviar o rastreamento para a plataforma.
Notificações por E-mail
- Enviar e-mail de entrega ao alterar a situação no ERP para Entregue: Ative para que um e-mail seja enviado automaticamente quando o pedido for alterado para "Entregue" no ERP.
Configurações Adicionais
- Envio de dados da NFe: Selecione para enviar os dados da NFe para a Yep.
- Layout da mensagem do envio de dados da NFe: Preencha o texto para configurar a mensagem de envio dos dados da NFe.
Observação: as informações enviadas são: XML da NFe, chave de acesso da NFe, data de envio, número, série e CFOP do primeiro item da NFe.
Aba Estoque
Defina as regras de estoque para a integração:
- Atualizar estoque na loja virtual a partir do ERP: Escolha "Não atualizar", "Enviar saldo físico (estoque total)" ou "Enviar saldo disponível (estoque total considerando a reserva de estoque)".
- Depósito a ser considerado na integração: Selecione o depósito padrão para importação de pedidos, produtos e envio de estoque. (Este campo só aparece se você tiver a extensão de depósitos de estoque instalada).
- Estoque mínimo: Escolha como enviar a informação de estoque mínimo: "enviar para quantidade mínima para exibir produto como disponível (min_qty)", "enviar para quantidade mínima para notificar estoque baixo (notify_stock_qty)" ou "não enviar".
- Produto sempre em estoque na Yep: Ative para que os produtos sempre mantenham estoque na plataforma.
Aba Dados Fiscais
- Selecione a Natureza de Operação para Venda nesta integração. Esta natureza será atribuída por padrão na importação de pedidos no ERP e na geração da nota fiscal.
- Você pode habilitar ou desabilitar o campo Definir natureza de operação diferente para destinatários contribuintes do ICMS. Se habilitado, poderá selecionar uma natureza de operação específica para clientes contribuintes.
Aba Campos Personalizados
Preencha os campos personalizados que serão importados com os pedidos ou produtos, conforme as descrições da Yep.
Atenção: preencha estes campos somente se sua loja Yep foi alterada para incluir essas informações. Caso contrário, deixe-os em branco.
Aba Gestão de Preços
Defina a regra de preços para a integração:
- Preço Fixo: O anúncio recebe um valor fixo de preço de venda, considerando acréscimos e descontos individuais.
- Conforme Regras de Preço: Considera as regras do marketplace (percentual de comissão, adicional de frete, fórmula de cálculo de valores adicionais).
- Conforme Lista de Preços: Usa listas de preços específicas para o e-commerce ou marketplace. Se escolher esta opção, selecione a lista de preços a ser considerada na importação de pedidos.
Aba Categorias
Relacione as categorias de produtos do ERP com as categorias da Yep:
- As categorias já cadastradas no ERP serão exibidas.
- Clique no botão Configurar Categoria no E-commerce e adicione o código da categoria correspondente na Yep.
Observação: se você ainda não tem categorias no ERP, consulte a ajuda sobre como cadastrar categorias de produtos. Para vincular categorias aos produtos, consulte a ajuda sobre como cadastrar um produto simples.
Aba Situações
Relacione as situações dos pedidos na Yep com as situações no ERP e defina o fluxo de situações:
- Clique em Adicionar Situações Padrão para adicionar as situações presentes na Yep.
- Para adicionar novas situações, clique em Adicionar Mapeamento de Situação.
- Para permitir que um pedido retorne a uma situação anterior, habilite o campo Permite Retroceder Situação dos Pedidos na Sincronização de Situações.
- Em Situações Personalizadas, adicione filtros personalizados para a listagem de pedidos. Preencha os campos Código da Situação e Descrição da Situação.
Observação: ao importar um pedido, se a situação não estiver configurada, o pedido receberá a situação "Em Aberto".
Aba Formas de Recebimento
Relacione as formas de recebimento da Yep com as formas de recebimento no ERP:
- Habilite o parâmetro Importar Forma de Recebimento nos Pedidos.
- Clique em Adicionar Forma de Recebimento.
- No campo Forma de Recebimento, selecione a forma do ERP.
- No campo Código na Integração, clique em Relacionar Forma de Recebimento e selecione a forma de recebimento correspondente na Yep.
- Se a forma não for exibida, você pode buscar por um pedido que a possua ou clicar em Informar Código Manualmente e digitar o código.
- Clique em Relacionar para confirmar.
- No campo Forma de Recebimento Padrão, defina uma forma de recebimento que será usada se o pedido importado não tiver uma forma relacionada.
Observação: o ERP busca as formas já configuradas na sua conta. Para cadastrar novas formas, consulte a ajuda sobre Formas de Recebimento.
Aba Formas de Frete
Mapeie as formas de frete da Yep com as formas de envio cadastradas no ERP:
- Nos campos Forma de Envio e Forma de Frete, selecione as formas que deseja mapear.
- Em Código na Integração, clique no botão Relacionar Forma de Frete.
- Na listagem, selecione a forma de envio correspondente na plataforma.
- Se a forma não for exibida, você pode buscar por um pedido que a possua ou clicar em Informar Código Manualmente e digitar o código.
- Clique em Relacionar para confirmar.
- Para adicionar novas formas de frete, clique em Adicionar.
Observação: o ERP busca as formas de envio já configuradas. Para cadastrar novas, consulte a ajuda sobre Formas de Envio. Para mapear formas de frete da Frenet, consulte a ajuda específica.
Aba Custos
- Defina os custos de comissão cobrados pelos pedidos do marketplace:
- Escolha se a base de cálculo da comissão considerará o Valor Total da Venda ou o Total da Venda sem o Frete.
Observação: esta aba só aparece se a extensão Custos do E-commerce estiver instalada.
Não se esqueça de Salvar todas as configurações ao finalizar.
Após finalizar a instalação e configuração, confira como usar a integração sua conta do ERP.