Pular para o conteúdo principal

Convenções da API

Recursos e versões​

As especificações usam recursos REST e versão /api/v1. Datas seguem ISO 8601 em UTC; dinheiro deve evitar ponto flutuante binário.

Paginação​

Listagens usam parâmetros consistentes de página/limite ou cursor. A resposta deve informar continuidade e quantidade quando disponível.

Erros​

{
"erro": {
"codigo": "FRETE_JANELA_INVALIDA",
"mensagem": "A janela de coleta deve ser anterior à entrega.",
"correlacaoId": "0192f7f8-5bc6-7ad4-a28a-6b64357b8bc2",
"campos": [{"campo": "coletaFim", "motivo": "fora_da_janela"}]
}
}
HTTPUso
400Entrada inválida
401Autenticação ausente ou expirada
403Sem permissão para a operação
404Recurso não encontrado no escopo
409Conflito de estado ou idempotência
422Regra de negócio não satisfeita
429Limite de chamadas excedido
500/503Falha interna ou dependência indisponível

Clientes devem usar retry apenas em falhas transitórias, com backoff e jitter.