VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Guia rápido/Clientes

Excluir cliente

Remove um usuário da loja por exclusão lógica, preservando pedidos e histórico.

Use esta operação quando um cadastro não deve mais existir para a loja: uma conta duplicada, um pedido de remoção de dados atendido pelo suporte, um teste. A exclusão é lógica: o registro ganha uma data de exclusão, o status passa a D, as sessões abertas morrem e os números de WhatsApp ligados à conta são soltos. Pedidos, endereços e histórico continuam guardados e ligados ao id.

Depois de excluído, o usuário não aparece nas listas, a consulta responde 404 e o e-mail volta a ficar livre para um novo cadastro. Se você só quer impedir o acesso e poder voltar atrás, desative o usuário em vez de excluir.

DELETE/api/v1.0/users/{id}Admin

Excluir um usuário

Também responde em DELETE /api/users/{id}. Quem chama com a chave de um administrador não consegue excluir o próprio usuário (403).

Parâmetros de caminho

idstringobrigatório
Id do usuário (UUID; na rota /api/users/{id}, o id decimal).

Exemplo de requisição

bash
curl -u "$EMAIL:$API_KEY" -X DELETE \
  "$BASE_URL/api/v1.0/users/8ca9b95c-89d4-40d1-afc7-e32a870a569b"

Resposta

204Usuário excluído
http
HTTP/1.1 204 No Content

Erros

StatusQuandoCorpo
401Sem credenciais, chave inválida ou token expirado{"message":"Invalid credentials","status":401}
403Excluir a si mesmo{"message":"Cannot delete yourself","status":403}
403Usuário que não é administrador{"message":"Forbidden: admin scope required","status":403}
404Usuário não existe ou já foi excluído{"message":"User not found","status":404}
Repetir a chamada dá 404

Excluir duas vezes o mesmo id responde 404 na segunda. Numa rotina com retentativa, trate 404 como "já excluído".

Excluir não é desativar

O usuário excluído não volta por esta API: não há rota de restauração, e a consulta passa a responder 404. Se existe qualquer chance de precisar da conta de novo, use o status D.

Veja também

  • Alterar cliente
  • Consultar cliente
Anterior
Alterar cliente
Próxima
Endereços
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também