Enviar fatura por e-mail
Envia a fatura do pedido em PDF por e-mail, para o cliente ou para qualquer destinatário que você informar.
Esta página documenta a ação de enviar a fatura de um pedido por e-mail. O id do caminho é o id do sub-pedido do seller (veja Pedidos do seller).
Enviar a fatura por e-mail
/api/v1/vendor/orders/{id}/invoice/sendSellerEnvia a fatura do pedido em PDF para um e-mail
Gera a fatura do pedido em PDF e a manda como anexo para o e-mail informado. Serve quando o cliente (ou o setor financeiro dele) pede a fatura de novo, ou quando você quer mandá-la a um terceiro. Cada envio, com sucesso ou falha, fica no registro de atividades do pedido.
O assunto e o corpo da mensagem seguem o idioma do cabeçalho Accept-Language (en gera textos em inglês e o arquivo invoice-<número>.pdf; qualquer outro valor gera português e fatura-<número>.pdf). A loja pode personalizar o texto no modelo de e-mail export_order.
Exige o privilégio de gerenciar pedidos do seller (uma permissão só de leitura não basta, porque a rota manda dados do pedido para fora).
Parâmetros de caminho
iduuidobrigatórioCorpo da requisição
emailstringobrigatórioNome <nome@dominio.com>; o servidor extrai só o endereço. Um único destinatário por chamada.Exemplo de requisição: fatura
curl -X POST "$BASE_URL/api/v1/vendor/orders/e148b6aa-d495-4b89-92ab-f38b5979a43f/invoice/send" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"email": "financeiro@example.com"}'Resposta: fatura
{
"sent": true,
"to": "financeiro@example.com",
"recipients": ["financeiro@example.com"],
"order_id": "e148b6aa-d495-4b89-92ab-f38b5979a43f",
"order_number": "PEDIDO-20261011-0001-V1",
"filename": "fatura-PEDIDO-20261011-0001-V1.pdf"
}Campos da resposta
sentbooleantrue em caso de sucesso.tostringrecipientsarrayorder_iduuidorder_numberstringfilenamestringErros: fatura
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 400 | Corpo ausente ou sem email. | {"error":"email is required"} |
| 400 | Endereço inválido. | {"error":"invalid email address","detail":"mail: missing '@' or angle-addr"} |
| 401 | Sem token. | {"error":"authentication required"} |
| 403 | Falta o privilégio de gerenciar pedidos. | {"error":"insufficient vendor privileges","privilege_required_any":["vendor_orders","vendor_manage_orders"]} |
| 403 | O pedido é de outro seller, ou é o pedido pai. | {"error":"you do not have access to this order"} |
| 404 | Pedido inexistente. | {"error":"order not found"} |
| 502 | O serviço de e-mail recusou o envio. | {"error":"failed to send the invoice e-mail","detail":"..."} |
| 503 | Serviço de e-mail indisponível na loja. | {"error":"email service not available"} |