Lista de Códigos de Sucesso

A API usa os seguintes códigos HTTP para indicar retornos de sucesso comuns:

Status HTTP Descrição Método HTTP
200 Indica que o processamento foi realizado corretamente e o retorno poderá ser consultado no corpo do HTTP Response GET
201 Indica que o recurso foi criado com sucesso, deverá existir o header Location: indicando a URI do novo recurso POST
202 Indica que o processamento será assíncrono, portanto, além do header Location, deverá retornar o conteúdo com um atributo status POST, PUT e DELETE
204 Indica que o recurso foi alterado ou excluído com sucesso PUT e DELETE

Lista de Códigos de Erro

A API usa os seguintes códigos HTTP para indicar erros comuns:

Status HTTP Descrição
422 Exceções de negócio
400 Requisição Mal Formada
401 Requisição Requer Autenticação
403 Requisição Negada
404 Recurso não Encontrado
405 Método não Permitido
408 Tempo esgotado para a requisição
413 Requisição excede o tamanho máximo permitido
415 Tipo de mídia inválida (falta de informar o content-type correto, ver JSON)
429 Requisição excede a quantidade máxima de chamadas permitidas à API
500 Erro de servidor

Os erros citados acima serão retornados no seguinte padrão:

{
    "errors": [
        {
            "code": "401.001",
            "type": "SecurityException",
            "message": "Você não tem permissão para acessar o recurso desejado",
            "skuSellerId": "" -- campo opcional
        }
    ]
}
Português, Brasil