Skip to content

Erros

Erros são retornados com o status HTTP apropriado e um corpo JSON no formato:

json
{
  "error": {
    "code": "validation_error",
    "message": "descrição legível do erro",
    "request_id": "abc123"
  }
}

request_id identifica a requisição nos logs do ViaPost — inclua-o ao reportar um problema para o suporte.

Códigos possíveis

StatuscodeQuando ocorre
400validation_errorCorpo da requisição inválido, campo obrigatório ausente, campo desconhecido, regra de negócio violada (ex.: domínio remetente não verificado)
401unauthorizedAPI Key ausente, malformada, inválida, revogada ou expirada
403forbiddenTenant inativo/suspenso, ou chave sem o scope exigido
404not_foundRecurso não existe ou não pertence ao tenant da chave
409conflictIdempotency-Key repetida para uma requisição diferente
429rate_limitedLimite de requisições por segundo excedido
500internal_errorErro interno inesperado