VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Lojas, vendors e companies

Excluir loja

Exclui logicamente um seller e libera o e-mail e o endereço de vitrine.

Exclui um seller. A exclusão é lógica: o registro fica no banco, mas o seller some das listas, passa a responder 404 e vai para a situação D. O endereço de vitrine e o e-mail ficam livres para um cadastro novo.

O login do dono do seller também é desativado, a menos que essa pessoa administre outro seller ativo. Não há operação para desfazer pela API.

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

Excluir uma loja

Parâmetros de caminho

iduuidobrigatório
Id da loja (UUID), como devolvido em company_id por /api/v1.0. O id decimal que a forma /api/... devolve não é aceito aqui.
DELETE/api/stores/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de DELETE /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele. Na forma sem versão (/api/...) os ids saem como números decimais em string, mas os caminhos só aceitam o UUID (veja a home da seção).

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

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de DELETE /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele.

DELETE/api/vendors/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de DELETE /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele. Na forma sem versão (/api/...) os ids saem como números decimais em string, mas os caminhos só aceitam o UUID (veja a home da seção).

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

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de DELETE /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele.

DELETE/api/companies/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de DELETE /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele. Na forma sem versão (/api/...) os ids saem como números decimais em string, mas os caminhos só aceitam o UUID (veja a home da seção).

Exemplo de requisição

bash
curl -X DELETE "$BASE_URL/api/v1.0/stores/3b617148-8a28-4d07-8040-a8903b4238d6" \
  -u "$EMAIL:$API_KEY"

Resposta

204Loja excluída

Resposta vazia: o corpo não tem conteúdo.

Erros

StatusQuandoCorpo de exemplo
401Sem credencial.{"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."}
401E-mail ou chave de API inválidos.{"status":401,"message":"Invalid credentials"}
403A credencial é válida, mas o usuário não é administrador.{"status":403,"message":"Forbidden: admin scope required"}
404Nenhuma loja com esse UUID, ou a loja já foi excluída.{"status":404,"message":"store not found"}
500O id não tem formato de UUID (por exemplo o id decimal da forma /api). É uma falha conhecida: deveria ser 404.{"status":500,"message":"..."} (mensagem interna de erro (não estável))
Sem desfazer pela API

Depois do 204 não existe rota de restauração nesta superfície, e uma segunda chamada devolve 404. Se a intenção é só tirar o seller de circulação por um tempo, prefira PUT com {"status":"D"}.

Veja também

  • Alterar loja
  • Listar lojas
  • Visão geral de lojas e sellers
Anterior
Alterar loja
Próxima
Produtos da loja
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também