Começando

Erros

Todo erro vem no mesmo formato, com um código estável para o seu sistema tratar.

Formato

{
  "erro": {
    "codigo": "validacao",
    "mensagem": "Confira os campos enviados.",
    "request_id": "req_b08d82d702d96001",
    "campos": {
      "nome": "Campo obrigatório."
    }
  }
}

campos aparece nos erros de validação, com a mensagem de cada campo. Envie o request_id (também no cabeçalho X-Request-Id) ao suporte se precisar de ajuda.

Códigos

HTTP	código	significado
400	`json_invalido`	O corpo não é um JSON válido (confira também a codificação UTF-8).
400	`parametro_invalido`	Um parâmetro de consulta tem formato errado (ex.: data).
401	`nao_autenticado`	Faltou o cabeçalho Authorization: Bearer <chave>.
401	`chave_invalida`	Chave inexistente ou revogada.
403	`sem_permissao`	A chave não tem o escopo exigido pelo endpoint.
404	`nao_encontrado`	O recurso não existe nesta loja.
404	`rota_nao_encontrada`	Endereço inexistente na API v1.
405	`metodo_nao_permitido`	Método HTTP não aceito neste endereço (veja o cabeçalho Allow).
409	`mesmo_status`	O pedido já está no status pedido.
409	`pedido_encerrado`	Pedido cancelado ou reembolsado não muda mais.
409	`estoque_insuficiente`	Saída maior que o saldo.
409	`limite_do_plano`	A loja atingiu o limite de produtos do plano.
409	`limite_webhooks`	A loja já tem 10 webhooks.
409	`conflito`	O recurso mudou durante a chamada: consulte e tente de novo.
413	`corpo_grande`	Corpo acima de 256 KB.
422	`validacao`	Campos inválidos: veja o objeto "campos".
429	`limite_excedido`	Mais de 120 chamadas no minuto (veja Retry-After).
500	`erro_interno`	Falha inesperada. Tente de novo; se persistir, envie o request_id ao suporte.