For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retornos Possíveis (HTTP Status Codes)

O resultado de cada requisição é indicado pelo HTTP Status Code retornado. Sempre consulte esse código para saber se a requisição funcionou ou qual problema ocorreu.

✅ Sucesso

Códigos na faixa 2xx indicam que a requisição foi processada com sucesso.

Código
Significado
Quando ocorre

200

Sucesso, com dados retornados

Consultas que retornam informações (ex.: listagens)

201

Registro criado / editado

Cadastro ou edição concluído com sucesso

204

Ação executada com sucesso

Ação concluída que não retorna conteúdo (ex.: remoção)

❌ Erro

Qualquer código fora da faixa 2xx indica que algo deu errado. Nesses casos, o corpo da resposta traz o elemento Mensagem com a causa do erro.

Código
Significado
Quando ocorre

400

Requisição inválida

Faltam campos essenciais (Loja, Token, Modulo, Acao)

401

Não autorizado

Token inválido — gere um novo token no painel da loja

404

Não encontrado

Módulo ou ação não localizados

405

Método não permitido

O método HTTP usado não é aceito por esse endpoint

422

Falha de validação

Os dados enviados não passaram na validação

Erros

Exemplo

No exemplo abaixo, a requisição retornou o status 204 (ação executada com sucesso):

Last updated