API da Yampi: o que dá para fazer e como usar com agentes de IA
A API da Yampi dá acesso aos pedidos, produtos, clientes, cupons e carrinhos da loja ou do checkout. É usada por lojistas de e-commerce e integradores que ligam a Yampi a ERP, logística e atendimento. O acesso é por token e chave secreta gerados no painel da loja.
Os grandes recursos da API, em português claro.
Consulta e atualização de status, pagamento e entrega.
Catálogo, variações, preços e quantidades.
Cadastro e histórico de compras.
Carrinhos não finalizados, com itens e contato.
Criação e regras de descontos.
Avisos de pedido criado, pago, cancelado e outros eventos.
Como se acessa a API do Yampi.
- Com credencial da sua empresaToken de usuário e chave secreta gerados no painel da Yampi, enviados no cabeçalho, junto com o alias da loja na URL.
- Documentação oficialdocs.yampi.com.br
- Respeite opt-in para mensagens de carrinho abandonado (LGPD).
- Há limites de requisição; use webhooks para eventos.
- Defina teto para descontos criados por agentes.
- api yampi
- yampi api pedidos
- yampi webhook
- yampi carrinho abandonado api
- integração api yampi
- yampi api documentação
O que um agente do iTeam faz com a API do Yampi.
O agente pega carrinhos não finalizados e conversa no WhatsApp, tirando dúvidas de frete e prazo antes de mandar o link.
Pedidos com Pix gerado e não pago recebem um lembrete do agente com o código antes de expirar.
O agente aponta pedidos pagos que não foram para separação dentro do prazo.
Para clientes sem compra recente, o agente cria um cupom pessoal e acompanha o uso.
Da credencial ao agente trabalhando, com aprovação.
Gere token e chave na Yampi
No painel, crie as credenciais de API de um usuário dedicado.
Cadastre no cofre do iTeam
As credenciais ficam no cofre; atendimento lê pedidos, marketing cria cupons dentro de limites.
Teste com aprovação
Cancelamentos, reembolsos e cupons acima do teto passam por aprovação humana.
Dúvidas sobre a API do Yampi.
A API da Yampi é gratuita?
De forma geral, a API está disponível para lojas da Yampi conforme o plano; confirme no seu painel.
Preciso programar para usar a API da Yampi com o iTeam?
Não necessariamente. A ferramenta HTTP do iTeam lê a documentação e o time de implantação configura os fluxos.
Dá para recuperar carrinho abandonado pela API?
Sim, a API expõe os carrinhos e o agente pode conduzir a recuperação pelo canal combinado.
Como o agente de IA se autentica na API da Yampi?
Com três informações do painel da loja, na área de credenciais de API: o alias da loja, que vai na URL, o token e a chave secreta, enviados no cabeçalho. A documentação está em docs.yampi.com.br. Trate a chave secreta como senha, guarde-a em cofre e gere novas credenciais se alguém com acesso deixar a empresa.
O agente consegue recuperar carrinhos abandonados pela API da Yampi?
Consegue ler os carrinhos abandonados e os dados do cliente, e a partir disso enviar uma mensagem de recuperação. A condição é ter opt-in para receber contato, pela LGPD. Um agente pode oferecer ajuda no WhatsApp, tirar a dúvida que travou a compra e, se a política permitir, ofertar cupom dentro de um teto definido.
Como o agente responde 'onde está meu pedido' usando a Yampi?
Consultando o pedido pela API, lendo o status e o código de rastreio, e respondendo ao cliente no WhatsApp com a informação e o link. Para atrasos, ele abre um aviso para a logística. O cliente é identificado pelo número do pedido e por um dado conferido, para não expor informação de outra pessoa.
Como a Yampi avisa o agente quando um pedido é pago ou cancelado?
Por webhooks, que a Yampi oferece para eventos da loja, como pedido criado, pago ou cancelado. Isso poupa o limite de requisições, que a documentação informa existir. O agente reage ao evento: confirma o pagamento ao cliente, avisa o estoque ou inicia o contato por cancelamento. Confira quais eventos o painel permite assinar.
Existe ambiente de testes na Yampi?
Não localizei um sandbox descrito para a API. Confira na documentação oficial se há loja de testes ou modo de teste. Uma alternativa prática é uma loja separada, com produtos fictícios e pedidos de valor simbólico, ou um cupom e produto de teste, para validar leitura de pedidos e webhooks antes de ligar a loja real.
O agente pode criar cupons de desconto pela Yampi?
A API lista cupons entre os recursos, então pode, mas defina um teto: percentual máximo, validade curta, uso único e aprovação acima de determinado valor. Sem teto, um agente generoso pode comprometer a margem. Cada cupom criado deve ficar registrado com o motivo e o pedido de origem.
Preciso de desenvolvedor para integrar a Yampi com ERP e logística usando agente?
Para o agente conversar com a loja, basta a configuração das credenciais e das ferramentas. A integração de pedidos com ERP e logística costuma exigir alguém que conheça os sistemas, porque envolve nota fiscal, estoque e regras de envio. O diagnóstico levanta o que a Yampi já entrega nativamente e o que falta.
Vale a pena um agente de IA numa loja pequena na Yampi?
Vale quando o atendimento no WhatsApp consome o dia com 'onde está meu pedido', troca e dúvidas de produto. Lojas muito pequenas, com poucos pedidos, podem resolver à mão. O ganho cresce com volume e com campanhas de recuperação de carrinho. Pedidos e clientes continuam sob as regras de privacidade.
