Send CMR document by email.
POST/company/cmr/send
Envia o documento CMR (Carta de Porte Digital) associado a um serviço de transporte para um ou vários destinatários por e-mail. O documento PDF é gerado e enviado como anexo.
Objetivo
Permitir que as empresas distribuam o documento eCMR às partes interessadas (clientes, transportadoras, autoridades) sem necessidade de download manual. O serviço ecmr_back gere o envio assíncrono dos e-mails.
Casos de Uso
- Uma empresa precisa enviar o CMR ao seu cliente para contabilidade
- É necessário enviar o CMR à transportadora para arquivo
- As autoridades aduaneiras solicitam o documento CMR por e-mail
- A empresa precisa distribuir o CMR a múltiplos departamentos internos
Validação de Pagamento
Middleware: mPlan.isPaymentUpdate
Este endpoint valida o estado de pagamento da empresa antes de processar o envio:
- Verifica se o token JWT é válido
- Verifica se a empresa tem permissões de pagamento atualizadas
- Rejeita a solicitação se a empresa não tiver um pagamento ativo ou subscrição válida Se a validação de pagamento falhar, será retornado um erro 401/403 antes de processar o envio.
Comportamento
- Valida os parâmetros
service_codeeemails - Verifica se o utilizador está autenticado e tem empresa válida
- Valida o estado de pagamento (middleware
isPaymentUpdate) - Reenvia a solicitação ao serviço ecmr_back
- ecmr_back gera o PDF e envia os e-mails
- Retorna confirmação de envio (não confirmação de entrega)
Notas:
- O envio de e-mails é assíncrono: confirma-se que foi enviado para a fila, não que foi entregue
- Cada destinatário receberá o CMR como arquivo PDF anexado
- Máximo 10 endereços de e-mail por solicitação
- Não é realizado tracking de abertura ou entrega dos e-mails
- O serviço pode demorar
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 503
O CMR foi enviado com sucesso aos destinatários especificados. A resposta confirma que o e-mail foi enviado para a fila ecmr_back, mas NÃO confirma a entrega efetiva aos destinatários.
Solicitação inválida - Parâmetros ausentes ou incorretos. Códigos de erro:
SERVICE_CODE_REQUIRED: Falta o parâmetroservice_codeEMAILS_REQUIRED: Falta o parâmetroemailsou está vazio (array com comprimento 0)
Não autorizado - Problemas de autenticação ou pagamento. Códigos de erro:
USER_NOT_FOUND: O usuário autenticado não existe na base de dadosAUTHORIZATION_TOKEN_REQUIRED: Falta o token nos cabeçalhos- Payment validation failed (middleware
isPaymentUpdate): A empresa não possui um status de pagamento válido
Proibido - A empresa não tem permissões de pagamento atualizadas.
O middleware isPaymentUpdate rejeitou a solicitação devido à falta de um pagamento ativo.
Não encontrado - A entrega não existe para esta empresa. Códigos de erro:
NOT_FOUND: Não existe uma entrega com esseservice_codepara esta empresa
Serviço indisponível - Erro ao comunicar com o serviço ecmr_back ou timeout no envio. Possíveis causas:
- O serviço ecmr_back não está disponível
- Timeout aguardando o envio de emails (máximo de 10 segundos)
- Erro interno no serviço ecmr_back