Pular para o conteúdo principal

Yampi

A integração com o Yampi conecta a sua conta ao idworks e sincroniza os fluxos correspondentes ao canal — credenciais, regras de sincronização de produtos, importação de pedidos, conciliação financeira e demais ações específicas dele. A configuração reúne 23 parâmetros distribuídos em 4 grupo(s).

Antes de configurar, ative a integração em Configurações → Integrações (aba Integrações Disponíveis), preencha o nome interno e (quando o tipo exigir) passe pelo fluxo de autenticação. A partir daí, os parâmetros abaixo ficam disponíveis em Configurar parâmetros.

Categoria no catálogo do idworks: E-commerce.


Índice

Conceito

Cadastro e autenticação

Parâmetros por grupo

Referência rápida


O que é a integração Yampi?

É a conexão entre o canal Yampi e o idworks. Ela controla como dados fluem entre os dois sistemas — depende do tipo da integração (a categoria neste caso é E-commerce), mas em geral cobre uma combinação de credenciais, regras de sincronização, gatilhos automáticos e parâmetros de conciliação.

📍 Onde: menu lateral → Configurações → Integrações → aba Integrações DisponíveisYampi.


Como ativar a integração?

  1. Acesse Configurações → Integrações.
  2. Na aba Integrações Disponíveis, busque por Yampi e clique no botão +.
  3. Preencha:
    • Conta (apenas multi-conta) — empresa dona da integração.
    • Nome da Integração — texto livre. Útil para distinguir várias instâncias do mesmo tipo.
  4. Clique em Salvar.

A integração aparece imediatamente em Minhas Integrações. Dependendo do tipo, o status inicial é Ativo (quando só requer credencial fixa) ou Não Autenticado (quando depende de autenticação externa).

Pré-requisito: privilégio Criar parametrizações empresa.


Como autenticar e validar as credenciais?

Preencha o grupo Credenciais de Acesso (ver tabela abaixo). Quando a integração pede uma autorização externa (o canal abre a tela de login dele para você liberar o acesso), clique em Autenticar Integração na linha da integração (ícone de cadeado) — uma nova aba abre o login do canal e, ao confirmar, a conexão fica liberada. Para integrações com credencial fixa (usuário/senha/chave), basta preencher os campos e salvar.

Depois de salvar, use a ação Verificar credenciais (quando disponível) para confirmar que o canal responde. O status na listagem reflete o resultado: Ativo = OK, Erro = credencial inválida ou revogada, Não Autenticado = falta concluir o fluxo de autorização.

Pré-requisito: privilégio Editar parametrizações empresa.


Credenciais de Acesso

4 parâmetro(s).

ParâmetroTipoPara que serve
TokenSenhaNo painel administrativo da Yampi, acesse Perfil > Credenciais de API no canto superior direito para encontrar suas credenciais.
Chave secretaSenhaNo painel administrativo da Yampi, acesse Perfil > Credenciais de API no canto superior direito para encontrar suas credenciais.
AliasTextoNo painel administrativo da Yampi, acesse Perfil > Credenciais de API no canto superior direito para encontrar suas credenciais.
Validar credenciaisBotãoClique para validar as credenciais informadas

Integração de Vendas

7 parâmetro(s).

ParâmetroTipoPara que serve
Empresa FaturadoraListaEmpresa responsável pelo faturamento dos pedidos, caso seja diferente da principal.
Excluir valor frete na NF para PFSim/NãoAtive se quiser excluir o valor do frete na Nota Fiscal quando a venda por para pessoa física (PF)
Importar pedidosSim/NãoAtive se quiser que a idworks integre os pedidos feitos no canal de vendas.
Cancelar pedido automaticamenteSim/NãoAtive se quiser cancelar pedido automaticamente caso ele seja cancelado no canal de vendas
Data inicial para importação de pedidosDataSeleciona a data inicial da criação do pedido no canal para importar. Se não informar, sempre será importado pedidos dos últimos 7 dias
Criar oferta automaticamenteSim/NãoAtive se quiser criar a oferta automaticamente, se o cadastro do SKU for localizado na idworks na importação de pedidos
Fechar pedido automaticamenteSim/NãoQuando marcado, o idworks fecha o pedido integrado do canal de vendas através do hub. Se desmarcado, o pedido quando integrado permanece com o status de aberto para atualização manual.

Integração de Produtos

11 parâmetro(s).

ParâmetroTipoPara que serve
Estoque de segurançaInteiroSe a quantidade de um produto estiver abaixo do valor escolhido, seu anúncio será pausado para evitar que sejam feitas vendas sem estoque. O valor de estoque mínimo é aplicado a todos os produtos.
Atualizar saldo estoqueSim/NãoAtive se quiser que a idworks atualize o saldo de estoque na integração.
Atualizar marcaSim/NãoAtive se quiser enviar atualização de marca na integração
Atualizar categoriaSim/NãoAtive se quiser enviar a atualização de categoria na integração
Atualizar imagemSim/NãoAtive se quiser enviar a atualização de imagem na integração
Atualizar preçoSim/NãoAtive se quiser enviar a atualização de preço na integração
Atualizar produtoSim/NãoAtive se quiser enviar a atualização de produto na integração
Arredondamento dos centavos do preçoDecimalValor em centavos para arredondar o preço de venda. Preencha entre 0,01 e 0,99.
Utilizar título como nome SKUSim/NãoUtilizar o campo título como nome do SKU ao enviar para o canal
Armazéns para somar quantidadeLista múltiplaSelecionar os armazéns que deve somar a quantidade para enviar aos canais de venda. Caso não seja preenchido, será enviado a quantidade do armazém que esta no de/para
Percentual disponibilidade de estoque%Valor base para utilizar do estoque em percentual. Ex. se tiver 100 unidades disponíveis e o percentual for 80% será enviado 80 para o canal

Logística (WMS) -> Picking

1 parâmetro(s).

ParâmetroTipoPara que serve
Emitir NF após iniciar pickingSim/NãoEmitir NF de forma automática ao iniciar o picking

Importação de Anúncios

9 parâmetro(s).

ParâmetroTipoPara que serve
Incluir Preços na ficha do AnúncioSim/NãoTraz o preço do anúncio publicado para dentro da ficha do anúncio no sistema. Caso não habilite, será utilizado preço definido pela política comercial do cadastro do produto no momento da sincronização do anúncio.
Incluir Título na ficha do AnúncioSim/NãoTraz o título do anúncio publicado para dentro da ficha do anúncio no sistema. Caso não habilite, será utilizado o campo Nome do cadastro do produto no momento da sincronização do anúncio.
Incluir Descrição na Ficha do Anúncio.Sim/NãoTraz o descrição do anúncio publicado para dentro da ficha do anúncio no sistema. Caso não habilite, será utilizado o campo Descrição do cadastro do produto no momento da sincronização do anúncio.
Importar somente anúncios inexistente dentro daSim/NãoSó importa anúncios que ainda não estão cadastrados no sistema.
Incluir Imagem dentro do ProdutoSim/NãoTraz as imagens do anúncio publicado para dentro do cadastro do produto no sistema. Caso a opção de trazer imagens para dentro do anúncio esteja habilitada, esta funcionalidade será desconsiderada.
Incluir Imagem dentro do AnúncioSim/NãoTraz as imagens do anúncio publicado para dentro da ficha do anúncio no sistema. Caso não habilite, serão utilizadas as imagens vinculadas ao cadastro do produto no momento da sincronização do anúncio e das imagens.
Não Realizar o vínculo do Anúncio ao Produto/SKUSim/NãoIgnora o vínculo automático do anúncio com o produto/SKU, permitindo que o vínculo seja realizado posteriormente.
Criar Produto/SKU, com base no Anúncio Importado.Sim/NãoCria o Produto/SKU com base no anúncio importado...
Criar Produto ou SKU Único (Todos Anúncios terá um produto único associado)Sim/NãoDiferente da opção Criar Produto/SKU com base no Anúncio Importado, esta configuração faz com que o sistema crie um produto único para cada anúncio importado. Nesse caso, o código será utilizado como código do produto, enquanto o código da variação será utilizado para o cadastro do SKU correspondente. O sistema criará os cadastros sempre como Tipo Produto e Tipo SKU. Caso algum dos anúncios importados represente um Kit, será necessário editar manualmente o item após a importação, alterando seu tipo para Kit e definindo sua composição corretamente.

Privilégios da tela

Esta tela tem privilégios próprios que controlam o que cada usuário pode fazer. Configure os perfis de acesso em Configurações → Perfis de Acesso vinculando os privilégios abaixo aos grupos desejados. Quando o usuário não tem o privilégio, a ação correspondente fica desabilitada na tela.

PrivilégioLibera
Visualizar integraçõesAcesso à tela de Integrações e a esta página de configuração.
Criar parametrizações empresaAtivar a integração (botão + no catálogo).
Editar parametrizações empresaConfigurar parâmetros, editar nome e status, autenticar e validar credenciais.
Deletar parametrizações empresaExcluir a integração.