Convenção de retornos (HTTP Status)

Padrão para retornos das requisições.

As APIs devem utilizar os padrões HTTP para retornarem sucesso ou erro em uma requisição, basicamente trabalhamos com os grupos de HTTP STATUS abaixo:

  • HTTP 2xx: indica que a requisição foi realizada com sucesso;

  • HTTP 4xx: indicam que a requisição contém alguma informação incorreta: token de acesso incorretos, campo obrigatório não informado, JSON inválido, etc;

  • HTTP 5xx: indica algum erro interno no marketplace.

Os status mais comuns, são:

200 - OK Retorno com sucesso, normalmente utilizados nas requisições do tipo GET.

201 - Created Retorno com sucesso, normalmente utilizados nas requisições do tipo POST.

204 - No Content Retorno com sucesso, normalmente utilizados nas requisições do tipo PUT.

400 - Bad request Requisição inválida, conteúdo JSON com inconsistente ou com informação faltante.

401 - Unauthorized Não autorizado.

404 - The specified resource was not found O objeto requisitado não existe, por exemplo: atualização de preço de um sku inexistente.

5XX - Unexpected error Erro geral no no marketplace.

Last updated