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

POSTEnviar e-mail de recuperação

Envia agora o e-mail que convida o cliente a retomar o carrinho.

Use quando quer dar um empurrão manual a um carrinho específico, por exemplo depois de um contato do atendimento. A plataforma usa o e-mail do cliente (ou o do visitante), renova a validade do link por mais 72 horas, gera um token novo se o registro não tinha e envia o modelo de e-mail abandoned_cart com os itens, o total e o botão para /recover?token=.... Cada envio soma 1 em recovery_emails_sent.

Enviar o e-mail

POST/api/v1/admin/abandoned-carts/{id}/send-emailAdmin

Envia o e-mail de recuperação de um carrinho abandonado

Parâmetros de caminho

iduuidobrigatório
Id do registro de carrinho abandonado.

Parâmetros de consulta

store_urlstring
Endereço da loja (http ou https, sem parâmetros) usado no link só quando a loja não tem endereço público configurado. Padrão: o host da própria requisição.

Exemplo de requisição: enviar

bash
curl -X POST "$BASE_URL/api/v1/admin/abandoned-carts/02981785-4f6f-43d4-adbf-4177a7490550/send-email" \
  -H "Authorization: Bearer $TOKEN"

Resposta: enviar

200E-mail enviado
json
{
  "message": "recovery email sent"
}

Erros: enviar

StatusQuandoCorpo de exemplo
401Token ausente ou inválido.{"error":"authentication required"}
403O módulo abandoned-cart está desligado na loja.{"error":"module_disabled","module":"abandoned-cart"}
403Falta o privilégio manage_abandoned_carts (ou manage_orders). Vale também para leitura.{"error":"insufficient privileges","required":"manage_abandoned_carts"}
400store_url inválido (não é http/https, ou sem host).{"error":"invalid store_url","detail":"store URL must use http or https scheme, got \"ftp\""}
500O registro não existe, já foi recuperado, não tem e-mail, ou o envio falhou. O motivo vem em detail.{"error":"failed to send recovery email","detail":"cart already recovered"}
Não há trava contra envio repetido

Chamar duas vezes envia dois e-mails. Se uma automação chama esta rota, confira last_email_sent_at antes para não incomodar o cliente.

E-mail precisa estar configurado

O envio usa o serviço de e-mail da loja. Se ele não estiver configurado a rota responde 500 com o motivo.

Veja também

  • Carrinhos abandonados: visão geral
  • Listar e medir
Anterior
Listar e medir carrinhos abandonados
Próxima
Detectar e limpar
Nesta página
  • Enviar o e-mail
  • Exemplo de requisição: enviar
  • Resposta: enviar
  • Erros: enviar
  • Veja também