Pular para o conteúdo
Envelope de erro
{
  "error": {
    "code": "not_found",
    "message": "Order not found.",
    "request_id": "83955522c09ff2d1"
  }
}

Um caminho inexistente também retorna JSON 404 not_found no mesmo envelope; nunca uma página HTML.

Códigos

HTTPcodeQuando
401unauthorizedToken ausente, malformado ou inválido.
403insufficient_scopeO token não tem o escopo exigido por este endpoint.
403tier_requiredO recurso solicitado não está incluído no seu plano (por exemplo, escolher seu próprio nome de usuário).
403forbiddenEsta operação não é permitida.
404not_foundO recurso não foi encontrado ou está oculto porque venceu.
404api_disabledO acesso à API está desativado.
405method_not_allowedEste endpoint não suporta este método HTTP. Os métodos suportados estão no cabeçalho Allow.
400invalid_requestCampo inválido, campo ou parâmetro desconhecido, campo exclusivo de outro tipo.
402insufficient_balanceO saldo não é suficiente para esta operação.
409conflictConflito de estado: serviço que não pode ser renovado, requisição idempotente ainda em processamento, nome de usuário já em uso.
429rate_limitedO limite de requisições foi excedido.
502 / 503service_unavailableNão foi possível acessar o provedor ou o armazenamento de logs; tente de novo.
500 / 502internal_errorErro inesperado; entre em contato com o suporte informando o request_id.

details

Se o erro tiver um detalhe legível por máquina, ele vem no campo details: o campo com erro (field), o estoque (available), a quantidade mínima (min_required), o saldo (balance), o valor máximo permitido (max), o motivo do erro (reason) etc. Por exemplo, se o tipo de serviço estiver em manutenção, vem reason: maintenance junto com service_unavailable.

402 insufficient_balance
{
  "error": {
    "code": "insufficient_balance",
    "message": "Insufficient balance for this operation.",
    "request_id": "5f1c0a9e7b2d4c61",
    "details": { "field": "balance", "balance": 3.2, "min_required": 12.5 }
  }
}

request_id

Registre o valor de request_id nos seus logs; a equipe de suporte pode buscar por esse ID nos registros do servidor.