Get CMR document in PDF format
GET/company/cmr/:service_code
Recupera o documento CMR (Carta de Porte Digital / eCMR) em formato PDF associado a um serviço de transporte específico. O CMR é o documento legal obrigatório para o transporte internacional de mercadorias por estrada, conforme a Convenção CMR.
Objetivo
Permitir que as empresas façam o download do documento eCMR oficial em formato PDF para arquivamento, impressão ou partilha com clientes e autoridades. O documento é gerado pelo serviço especializado ecmr_back e entregue como ficheiro binário.
Casos de Uso
- Uma empresa precisa de descarregar o CMR para uma entrega que acabou de ser concluída
- Um cliente solicita o documento CMR oficial para a sua contabilidade
- É necessário apresentar o CMR às autoridades aduaneiras num controlo de transporte
- A empresa precisa de arquivar o CMR digitalmente por requisitos legais
Nota de Arquitetura
Este endpoint atua como proxy para o serviço ecmr_back (microsserviço especializado na gestão de documentos eCMR). O PDF é gerado e entregue pelo ecmr_back, sendo depois transmitido como um fluxo binário para o cliente.
Pré-condições:
- O utilizador deve estar autenticado e existir na base de dados
- O utilizador deve pertencer a uma empresa válida
- Deve existir uma entrega com o service_code fornecido para a empresa
- A entrega deve ter um documento eCMR associado
Códigos de Erro:
USER_NOT_FOUND(401): O utilizador autenticado não existe na base de dadosAUTHORIZATION_TOKEN_REQUIRED(401): Token em falta ou inválido nos cabeçalhos da requisiçãoCOMPANY_NOT_FOUND(Internal): O utilizador não tem empresa associada (rejeitado antes da resposta da API)NOT_FOUND(404): Entrega não encontrada para esta empresa/service_codeFILE_NOT_AVAILABLE(404): Ficheiro PDF do CMR não disponível no serviço ecmr_back- Erro de
Request
Responses
- 200
- 401
- 404
- 503
Documento CMR em formato PDF baixado com sucesso. O arquivo é transmitido como um fluxo binário direto do serviço ecmr_back.
Response Headers
Tipo de conteúdo do arquivo
Indica que o arquivo deve ser baixado como anexo com o nome do arquivo. Formato: attachment; filename={service_code}.pdf
Tamanho do arquivo PDF em bytes
Tipo de codificação (sempre identity para este endpoint)
Diretiva de cache para evitar transformações
Não autorizado - O usuário não está autenticado ou o token é inválido. Possíveis 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 ou é inválido
Não encontrado - Não existe um CMR disponível para o service_code fornecido. Possíveis causas:
- O código de serviço está incorreto ou não pertence a esta empresa
- A entrega existe, mas o CMR ainda não foi gerado
- O arquivo CMR foi excluído ou não está disponível no ecmr_back Códigos de erro:
NOT_FOUND: A entrega não existe para esta empresaFILE_NOT_AVAILABLE: O CMR não está disponível no ecmr_back
Serviço indisponível - Erro ao comunicar com o serviço ecmr_back ou timeout na geração do PDF. Possíveis causas:
- O serviço ecmr_back não está disponível
- Timeout aguardando a geração do PDF (30 segundos no máximo)
- Erro interno no serviço ecmr_back