Pular para o conteúdo principal

Consulta de cancelamento

Método e rota

  • Consulta (GET): /frete/lote/operacaoTransporte/cancelar/:enterpriseId/:id

Corpo

Consulte aqui as referências

Resposta do GET

Exemplo de resposta para a consulta:

Em caso de sucesso (200) , a resposta retornará o seguinte JSON:


{
"sucesso": true,
"erros": [
{
"codigo": 200,
"mensagem": "Processamento realizado com sucesso!"
}
],
"protocoloCanc": "123456789012"
}

Em caso de em processamento (202), a resposta retornará o seguinte JSON:


{
"sucesso": true,
"erros": [
{
"codigo": "202",
"mensagem": "Em Processamento"
}
]
}

  • sucesso: booleano que indica se a operação foi processada com êxito (true).
  • erros: array de objetos para reporte de erros (neste exemplo, contém um objeto de erro, mesmo que sucesso seja true, podendo ser utilizado para comunicar avisos ou inconsistências não críticas).
  • protocoloCanc: string que representa o número do protocolo de cancelamento gerado.

Códigos de Status HTTP

  • 200 : Indicam que o cancelamento foi processado com sucesso.
  • 202 : Indica que está em processamento.
  • 400: Erro de validação (por exemplo, campo motivo ausente ou {id} inválido).
  • 401: Não autorizado (token JWT ausente ou inválido).
  • 500: Erro interno do servidor.

Consulte aqui as mensagens e códigos de retorno


Próximos passos

Encerre a operação de transporte