DOCS

Erros da API

Erros da API

Entenda e resolva erros retornados pela API GraphQL da Zonos.

GraphQL

A API da Zonos retorna dois tipos de erros: códigos de status HTTP para falhas no nível de transporte e erros GraphQL para problemas no nível do aplicativo. A maioria dos erros são erros GraphQL que incluem uma classificação no campo extensions para ajudar a identificar a causa e a resolução apropriada.

Códigos de status HTTP 

Erros HTTP são retornados quando uma solicitação não pode ser processada no nível de transporte.

Código de statusSignificado
400Argumento inválido/solicitação incorreta — a solicitação contém entrada inválida.
401Não autorizado — nenhuma credencial válida foi fornecida.
404Não encontrado — o recurso solicitado não existe.
409Conflito de recursos — a solicitação entra em conflito com o estado atual de um recurso.
412Falha de pré-condição — uma condição obrigatória não foi atendida antes do processamento.
422Entidade não processável — o corpo da solicitação é estruturalmente válido, mas contém valores inválidos.
429Rate limitado — muitas solicitações em um curto período. Use a espera exponencial e tente novamente.
500Erro interno do servidor — ocorreu uma falha inesperada no servidor. Tente novamente; entre em contato com o suporte se persistir.
503Serviço indisponível — o serviço está temporariamente offline. Tente novamente após um pequeno atraso.
504Tempo limite — o servidor não recebeu uma resposta a tempo. Tente novamente a solicitação.

Formato de erro GraphQL 

Erros no nível do aplicativo são retornados como uma lista no campo errors do corpo da resposta. Cada erro inclui uma message, o path da operação que falhou, e um objeto extensions com o tipo de erro e o ID da solicitação.

1{
2 "errors": [
3 {
4 "message": "Description of the error",
5 "path": [
6 "landedCostCalculate"
7 ],
8 "extensions": {
9 "errorType": "BAD_REQUEST",
10 "requestId": "req_abc123"
11 }
12 }
13 ]
14}

Classificações de erros 

O campo extensions.errorType indica a categoria do erro e a ação recomendada.

Classificaçãoequivalente HTTPSignificadoAção
BAD_REQUEST400Parâmetros de entrada ou solicitação inválidos.Corrija a solicitação — verifique os campos, formatos e valores obrigatórios.
NOT_FOUND404Um recurso referenciado não existe.Verifique IDs, códigos e se os padrões necessários estão configurados.
UNAVAILABLE503O serviço ou opção solicitada não está disponível para esta rota.Experimente um método, nível de serviço ou destino diferente.
PERMISSION_DENIED401 / 403Falha de autenticação ou autorização.Verifique as credenciais e permissões da conta.
FAILED_PRECONDITION412Uma configuração necessária ou condição de configuração não foi atendida.Verifique as configurações da organização ou entre em contato com o suporte.
INTERNAL500Ocorreu uma falha inesperada no servidor.Tente novamente a solicitação; entre em contato com o suporte se o problema persistir.
UNKNOWN500Um erro inesperado sem classificação adicional.Verifique o formato da solicitação; entre em contato com o suporte se o problema persistir.

Esta página foi útil?