Fast Shop - API Seller
Swagger API
  • Sobre a API
  • Guias da API
    • Primeiros passos
    • Autenticação e formato dos dados
    • Códigos de retorno (HTTP status)
    • Limite de requisições
    • Melhores práticas
  • Integração
    • Fluxo de integração
    • Ambientes de integração
    • Definição da URL e Siglas
    • Recursos (endpoint)
      • Catálogo de Produto
        • Notificação de catálogo
        • Registro de catálogo
        • Atualização de catálogo
        • Atualização de preço/estoque
      • Criação de Pedido
        • Cálculo de frete
        • Criação de pedido
      • Processar Pagamento
        • Bandeiras de cartão
        • Parcelamento no cartão
        • Processar transação de pagamento
          • Como criptografar as informações do pagamento
      • Gerenciamento do Pedido
        • Pedido Aprovado/Confirmado pelo Marketplace
        • Pedido Confirmado pelo Seller
        • Pedido Faturado ou Despachado
        • Pedido Entregue
        • Pedido Cancelado pelo Marketplace
        • Pedido Cancelado pelo Seller
        • Consultar Pedido
    • Status de Pedidos no Seller
Powered by GitBook
On this page
  • Erros
  • Status HTTP

Was this helpful?

  1. Guias da API

Códigos de retorno (HTTP status)

Neste tópico você poderá verificar todos os possíveis códigos de retorno da API e a mensagem, seja em caso de sucesso ou de erro.

A API utiliza o grupo padrão dos status HTTP para indicar se uma requisição teve sucesso ou não. No geral:

  • Códigos HTTP 2XX: indicam que a requisição foi realizada com sucesso;

  • Códigos HTTP 4XX: indicam que a requisição contém alguma informação incorreta - dados de acesso incorretos, ausência de um campo obrigatório, etc;

  • Códigos HTTP 5XX: indicam algum erro nos servidores da Fast Shop. Esses são raros e caso você receba esse código, deve entrar em contato com o nosso suporte.

Erros

Sempre que ocorrer um erro, a API retornará no corpo (body) da mensagem um JSON com uma mensagem de erro de acordo com o formato abaixo:

{
  "errorCode": "string",
  "message": "string"
}

Status HTTP

Os status HTTP mais utilizados são:

Status
Descrição

200

Sucesso - a requisição foi processada com sucesso

201

Criado - a requisição foi processada com sucesso e resultou em um novo recurso criado

204

Sem conteúdo - a requisição foi processada com sucesso e não existe conteúdo adicional na resposta

400

Requisição mal formada - a requisição não está de acordo com o formato esperado. Verifique o JSON (body) que está sendo enviado

401

Não autenticado - os dados de autenticação estão incorretos. Verifique o cabeçalho (header) da requisição o token

403

Não autorizado - você está tentando acessar um recurso ao qual não tem permissão

404

Não encontrado - você está tentando acessar um recurso que não existe na API

406

Formato não aceito - a API não suporta o formato de dados especificado no cabeçalho (Accept)

415

Formato de mídia não aceito - a API não consegue processar os dados enviados por conta de seu formato. Certifique-se do uso do charset UTF-8 (tanto no header "Content-Type", quanto no próprio body da requisição)

422

Erro semântico - apesar do formato da requisição estar correto, os dados ferem alguma regra de negócio (por exemplo: transição inválida do status de pedido)

429

Limite de requisições ultrapassado - você fez mais requisições do que o permitido em um determinado recurso

500 ou 502

Erro interno - ocorreu um erro no servidor ao tentar processar a requisição

503

Serviço indisponível - a API está temporariamente fora do ar

504

Timeout - a requisição levou muito tempo e não pode ser processada

PreviousAutenticação e formato dos dadosNextLimite de requisições

Last updated 1 year ago

Was this helpful?