> ## Documentation Index
> Fetch the complete documentation index at: https://docs.octasend.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Yampi

> Conecte sua loja Yampi para disparar comunicações a partir de pedidos, pagamentos, notas fiscais e carrinhos abandonados, e manter clientes, produtos e pedidos sincronizados

A integração com a **Yampi** conecta sua loja à OctaSend e faz três coisas:

* **Dispara comunicações sozinha** a partir dos eventos da loja: pedido criado ou pago, pagamento recusado, mudança de status, nota fiscal e carrinho abandonado.
* **Sincroniza clientes, produtos, pedidos, notas fiscais e carrinhos** com o menu [E-commerce](https://docs.octasend.com.br/plataforma/ecommerce.md).
* **Alimenta as [automações](https://docs.octasend.com.br/plataforma/automacoes.md)** que começam por um evento da loja.

> [!NOTE]
>
> O botão **Conectar com Yampi** (OAuth) só aparece nas contas em que está liberado; as demais conectam por token e chave secreta.

## Onde fica

Em **Configurações → Integrações**, o card **Yampi** mostra o status, o nome da loja, o **Último evento** e, em caso de erro, o motivo. Os status são os de [Integrações](https://docs.octasend.com.br/integracoes/visao-geral.md#onde-fica). Cada conta conecta uma loja Yampi, e uma loja fica conectada a uma conta só.

## 1. Conectar

A tela mostra um de dois caminhos, conforme a sua conta.

**Conectar com a Yampi (OAuth).** Aparece só quando está liberado para a sua conta. Clique em **Conectar com Yampi**, autorize o acesso na Yampi e volte para a OctaSend. Se a Yampi recusar o cadastro dos avisos por esse caminho, a tela mostra o erro e indica usar o token.

**Conectar com token e chave secreta.** É o caminho das contas que não têm o OAuth liberado, e fica como alternativa para quem tem.

**1. Copie as credenciais**

No painel da Yampi, abra **Perfil › Credenciais de API** e copie o **User-Token** e a **User-Secret-Key**.

**2. Descubra o alias da loja**

É o identificador que aparece no endereço do painel (`painel.yampi.com.br/minhaloja`) e nas configurações da loja.

**3. Preencha e conecte**

Informe **Alias da loja**, **User-Token** e **User-Secret-Key**. O nome da loja é opcional e serve só para você reconhecê-la; se ficar em branco, usamos o alias. Clique em **Conectar com token**.

Os avisos de pedidos, clientes e carrinhos são cadastrados na Yampi automaticamente, sem passo manual. A conexão começa sempre pelo painel da OctaSend; a conexão pelo botão da loja de aplicativos da Yampi não está disponível.

## 2. O que chega da Yampi

* **Pedidos**, com itens, pagamento e rastreio.
* **Clientes** e **produtos**. O produto traz descrição, marca, especificações e medidas; sem variações, traz EAN-13, preço de venda, preço promocional (quando a promoção está ativa), preço de custo, peso e dimensões; com variações, cada variação traz os seus.
* **Notas fiscais** e **carrinhos abandonados**.

**Importação inicial.** Ao conectar, a OctaSend traz os pedidos dos últimos **365 dias** e os clientes e produtos da loja. A Yampi limita a leitura de produtos a **30 por minuto**, então um catálogo grande leva mais tempo para chegar por inteiro, sem impedir o resto de funcionar. A importação não envia mensagem.

## 3. Mapear os eventos

Clique em **Configurar eventos**. Na aba **Mapeamento de eventos**, cada evento recebe uma comunicação; evento sem comunicação não dispara nada. Crie suas comunicações antes em [Comunicações](https://docs.octasend.com.br/plataforma/comunicacoes.md).

| Evento | Observação |
| - | - |
| Pedido criado | |
| Pedido pago | |
| Pagamento recusado | |
| Status: *nome do status* | Uma linha para cada status da sua loja, com o nome que você usa na Yampi (os status são configuráveis por loja) |
| Nota fiscal emitida | |
| Carrinho abandonado | Veja [Carrinho abandonado](#carrinho-abandonado) |
| Cliente cadastrado | |

Só atualizam os dados na OctaSend, sem enviar mensagem: nota fiscal alterada, endereço de cliente cadastrado, produto criado, alterado ou removido e estoque alterado.

**Uma mensagem por pedido e evento.** Se o pedido volta para um status em que já esteve, ou se a Yampi repete o aviso, a mensagem não é enviada de novo.

A comunicação precisa de um canal ativo compatível com o contato. Sem e-mail nem telefone, o evento fica como **Ignorado**.

## 4. Variáveis do template

O painel **Variáveis disponíveis** mostra as variáveis do evento, com botão para copiar. Várias seguem os nomes da [Nuvem Shop](https://docs.octasend.com.br/integracoes/nuvemshop.md), mas há diferenças (por exemplo, `{{pagamento_link}}` e `{{carrinho_link}}`): confira as do evento no painel.

**Todos os eventos de mensagem:** `{{loja_nome}}`, `{{cliente_nome}}`, `{{cliente_email}}` e `{{cliente_telefone}}`.

**Pedido criado, pedido pago, pagamento recusado, status do pedido e nota fiscal emitida**, além das acima

| Variável | Conteúdo |
| - | - |
| `{{pedido_numero}}` | Número do pedido |
| `{{pedido_total}}` | Valor total |
| `{{pedido_moeda}}` | Moeda |
| `{{pedido_status}}` | Status, com o nome usado pela loja |
| `{{pedido_status_pagamento}}` | Situação do pagamento |
| `{{pedido_status_envio}}` | Situação do envio |
| `{{pedido_itens}}` | Itens, um por linha, como `2× Camiseta Preta` |
| `{{pedido_data}}` | Data do pedido (dd/mm/aaaa) |
| `{{pagamento_link}}` | Link do boleto, Pix ou pagamento, quando houver |
| `{{codigo_rastreio}}` | Código de rastreio |
| `{{link_rastreio}}` | Link de rastreio |

**Nota fiscal emitida** tem ainda `{{nota_fiscal_numero}}` e `{{nota_fiscal_link}}`.

**Carrinho abandonado**, além das comuns: `{{carrinho_link}}`, `{{carrinho_total}}`, `{{carrinho_quantidade}}` e `{{carrinho_itens}}`.

**Cliente cadastrado:** só as variáveis comuns.

Uma variável que não existe no evento não é substituída. Uma que existe mas a Yampi não preencheu (rastreio antes do envio, link de pagamento em pedido sem boleto) chega vazia: monte o texto de modo que faça sentido sem ela.

## Carrinho abandonado

* A OctaSend envia **uma mensagem por carrinho**. A Yampi pode avisar até quatro vezes sobre o mesmo carrinho, mas só o primeiro aviso gera mensagem.
* Se o carrinho já virou pedido quando a mensagem ia sair, ela **não é enviada** e o evento fica como **Ignorado** ("Carrinho convertido").
* Para uma sequência de lembretes (um na hora e outro no dia seguinte, por exemplo), monte uma [automação](https://docs.octasend.com.br/plataforma/automacoes.md) com o gatilho do carrinho abandonado e os intervalos que quiser.

## 5. Manter os dados em dia

* **Conferência diária de pedidos:** todo dia a OctaSend confere os pedidos alterados recentemente e recupera os avisos de pedido criado, pago e mudança de status que tenham se perdido. Na mesma conferência, clientes e produtos também são lidos de novo; em catálogos grandes isso pode levar mais de uma conferência.
* **Aviso desativado:** se a Yampi deixar o aviso inativo, a OctaSend o detecta e recria.
* **Rotinas manuais:** a aba **Rotinas** tem **Clientes**, **Produtos** e **Pedidos**, cada uma com **Executar agora**, e o histórico fica na aba **Logs**. Não há agenda: a conferência diária segue automática. Clientes e produtos são relidos inteiros; pedidos, desde o último ponto conferido (no máximo 365 dias). Produtos são lentos por causa do limite de 30 consultas por minuto: se a rodada estourar o tempo, aparece como erro com quantos registros entraram, e a próxima execução continua de onde parou. Se a Yampi estiver instável, tente de novo em alguns minutos.

## 6. Acompanhar

A aba **Eventos recebidos** mostra cada evento e o resultado: **Enviado**, **Ignorado** (sem comunicação mapeada, comunicação inativa, contato sem e-mail e telefone, sem canal compatível ou carrinho já convertido) ou **Falhou**, com o motivo. O resultado de cada canal fica em [Logs de mensagens](https://docs.octasend.com.br/plataforma/logs-de-mensagens.md).

## OctaTag na loja

A OctaTag é o código que faz os widgets da OctaSend, como o Conteúdo Rico, funcionarem na vitrine. No cartão **OctaTag na loja**, em **Configurações → Integrações → Yampi**, o interruptor **Instalar OctaTag na loja** cadastra na Yampi um script chamado **OctaSend OctaTag**, para todas as páginas da loja. O Conteúdo Rico só age nas páginas de produto.

* **Liberação:** a instalação automática é liberada aos poucos, conta por conta, e funciona na conexão por **token e chave secreta**. Com ela disponível, na primeira conexão o interruptor já vem ligado; se você reconectar ou editar a conexão depois, sua escolha é mantida.
* **Modo manual:** se a instalação automática não está disponível para a conta, ou o token não consegue instalar o script, o cartão mostra **Instalação automática indisponível para esta conexão**, com a tag para copiar. Cole essa linha no tema da loja, antes de fechar a tag `</body>`. Só quem pode editar a integração vê o código.
* **Para desligar,** desligue o interruptor e a OctaSend remove o script. Se a Yampi recusar a remoção, o interruptor volta a ficar ligado e a tela avisa: apague o script **OctaSend OctaTag** na área de scripts da sua loja na Yampi e desligue de novo.

### Conteúdo Rico automático

O interruptor **Inserir o Conteúdo Rico nas páginas de produto** faz o Conteúdo Rico do produto aparecer sozinho na página. Ele precisa da OctaTag instalada e do módulo Conteúdo Rico liberado para a sua conta.

* Com **Seletor CSS (opcional)** preenchido (clique em **Salvar seletor**), o conteúdo entra logo depois desse elemento. Sem seletor, entra entre a seção principal do produto e a de especificações.
* **Produto sem SKU não mostra Conteúdo Rico.**
* Se o cliente troca de produto sem recarregar a página, o conteúdo acompanha a troca.
* Se você configurou a lista de domínios permitidos do embed, inclua o endereço da vitrine (por exemplo, `sua-loja.catalog.yampi.io`) e o seu domínio próprio.

Para conferir, abra pelo endereço público da loja a página de um produto que tenha Conteúdo Rico. Se não aparecer, confirme que o produto tem SKU, que o domínio está na lista e, no modo manual, que a tag está no tema.

## Desconectar

Ao desconectar, a OctaSend remove o aviso na Yampi e para de recebê-los. Mesmo que a Yampi não consiga remover o aviso, a conta é desconectada. Os pedidos, clientes e produtos já importados **continuam** na OctaSend. Para voltar, conecte de novo.

Se você **desinstalar o app na Yampi**, ela não avisa a OctaSend. A OctaSend confere a cada hora se a Yampi ainda aceita a conexão feita por **Conectar com Yampi** e, quando ela recusa, desconecta a conta e mostra o motivo na página da integração, normalmente em até 1 hora. A conexão por token e chave secreta não passa por essa verificação.

## Limitações

* A Yampi permite 30 leituras de produtos por minuto; catálogos grandes levam mais tempo.
* A importação inicial cobre os últimos 365 dias de pedidos.
* Uma loja Yampi por conta OctaSend.

## Veja também

> [card] [Integrações](https://docs.octasend.com.br/integracoes/visao-geral.md)
>
> As plataformas disponíveis e o que muda entre elas

> [card] [Nuvem Shop](https://docs.octasend.com.br/integracoes/nuvemshop.md)
>
> Telas de eventos, logs e rotinas, iguais às da Yampi

> [card] [E-commerce](https://docs.octasend.com.br/plataforma/ecommerce.md)
>
> Clientes, pedidos e produtos sincronizados da loja

> [card] [Automações](https://docs.octasend.com.br/plataforma/automacoes.md)
>
> Sequências de mensagens a partir de eventos da loja


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.