VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Modelos de e-mail

Modelos dos e-mails transacionais e de marketing: ver, editar, visualizar, testar e restaurar.

Sempre que a loja precisa avisar alguém por e-mail (pedido recebido, pedido enviado, carrinho abandonado, cupom, aprovação de seller), ela usa um modelo de e-mail: um assunto e um corpo com variáveis como {{first_name}} que são preenchidas na hora do envio. Esta seção deixa o administrador ler e personalizar esses modelos, ver uma prévia e mandar um teste.

Pontos principais
  • As rotas dependem do módulo email-notifications; sem ele a resposta é 403.
  • Cada modelo existe por idioma e por destinatário (customer, vendor, admin, all), identificado pelo slug.
  • Não há rota para criar ou apagar modelos: os de sistema vêm com a plataforma e podem ser editados ou restaurados.
  • A prévia não envia nada; o teste envia de verdade, só para o seu e-mail.
  • Listar sincroniza os modelos de status de pedido e pode criar linhas.

Como funciona

O caminho comum de personalização: listar para achar o modelo, abrir o modelo, editar o texto, conferir com a prévia (que aceita rascunho), salvar com PUT, enviar um teste para si mesmo e, se não gostar do resultado, restaurar o padrão.

Listar→Consultar→Prévia→Salvar→Teste→Restaurar
EstadoLetraEfeito
AtivoAO e-mail é enviado.
DesativadoDO e-mail daquele evento não é enviado.

Conceitos importantes

Variáveis

O texto usa {{nome_da_variavel}}. As variáveis disponíveis para cada modelo vêm em variables (por exemplo first_name, order_number, tracking_url, store_name). Uma variável fora dessa lista não é preenchida.

Modelos de sistema

is_system: true marca os modelos que a plataforma entrega. Eles podem ser editados e restaurados ao texto original. Modelos com is_wired: false não têm ponto de envio no sistema: editá-los não muda nenhum e-mail real.

Modelos de status de pedido

Para cada status de pedido da loja existe um modelo order_status_<código>, usado para avisar o cliente quando o pedido muda para aquele status. Ao listar, a plataforma cria os que faltarem.

Moldura do e-mail

O HTML final de um e-mail é o corpo do modelo dentro do cabeçalho e rodapé configurados na loja. A prévia mostra esse resultado completo.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1/admin/email-templatesLista os modelos de e-mail da lojaadmin
GET/api/v1/admin/email-templates/{id}Devolve um modelo pelo idadmin
PUT/api/v1/admin/email-templates/{id}Altera o conteúdo de um modeloadmin
POST/api/v1/admin/email-templates/{id}/resetDevolve um modelo de sistema ao texto originaladmin
POST/api/v1/admin/email-templates/{id}/previewMostra como o e-mail ficaria, com dados de exemploadmin
POST/api/v1/admin/email-templates/{id}/testEnvia o modelo, com dados de exemplo, para o e-mail do administradoradmin

Erros comuns

  • Filtrar a lista com status=active: o filtro espera a letra A/D e a palavra não casa com nada.
  • Esperar que POST .../test envie o rascunho: ele envia o modelo salvo.
  • Tentar restaurar um modelo que não é de sistema: recusado com 400.
  • Desativar (D) um modelo de pedido sem perceber que os clientes deixam de receber o aviso.
  • Esperar 404 ao atualizar um modelo inexistente: a resposta é 500.
  • Usar uma variável que não está em variables: ela sai vazia ou literal no e-mail.

Próximos passos

Listar e consultar
Filtros e campos.
Editar e restaurar
Atualizar e voltar ao padrão.
Prévia e teste
Ver antes de enviar.
Anterior
Enviar campanha
Próxima
Listar e consultar modelos
Nesta página
  • Como funciona
  • Conceitos importantes
  • Variáveis
  • Modelos de sistema
  • Modelos de status de pedido
  • Moldura do e-mail
  • Endpoints
  • Erros comuns
  • Próximos passos