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

DELETEExcluir um vendedor

Exclui um vendedor do sistema. O vendedor e os dados associados não podem ser recuperados.

Este endpoint exclui um vendedor do seu sistema. Depois de excluído, o vendedor e todos os dados associados não podem ser recuperados. Envie uma requisição DELETE ao endpoint de vendedores, com o ID da empresa no caminho da URL.

DELETE/api/vendors/{company_id}Admin

Exclui um vendedor

Parâmetros de caminho

company_idintegerobrigatório
O ID da empresa do vendedor a excluir.

Exemplo de requisição

Esta requisição exclui do sistema o vendedor com company_id=2.

bash
curl -X DELETE "$BASE_URL/api/vendors/2" \
  -u "$EMAIL:$API_KEY"
Trate os dados do vendedor antes

Antes de excluir um vendedor, confirme que todos os produtos, pedidos e demais dados associados a ele foram tratados. Excluir um vendedor com produtos ou pedidos ativos pode causar inconsistências no sistema.

Resposta

StatusDescrição
204 No ContentO vendedor foi excluído com sucesso.
400 Bad RequestNão foi possível excluir o vendedor (por exemplo, ele tem produtos ou pedidos ativos).
404 Not FoundO vendedor informado não existe.
Desative em vez de excluir

Se você precisa desativar um vendedor temporariamente em vez de excluí-lo, use o endpoint Atualizar um vendedor para mudar o status dele.

Veja também

  • Atualizar um vendedor
  • Vendedores
Anterior
Atualizar um vendedor
Próxima
Assinantes da newsletter
Nesta página
  • Exemplo de requisição
  • Resposta
  • Veja também