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

Excluir produto

Envia um produto para a lixeira (exclusão suave), de onde ele pode ser restaurado por 30 dias, e libera o SKU.

Use esta operação quando um item saiu definitivamente do catálogo e você quer tirá-lo da loja, das listas e da busca. A exclusão não apaga o registro: ela o marca como excluído e o envia para a lixeira. Um administrador pode restaurá-lo no painel por 30 dias; depois disso a limpeza automática o remove de vez. Os vínculos do produto (categorias, características, imagens, faixas de preço) são preservados, para a restauração devolver o produto completo.

Ao excluir, a plataforma também emite o evento product.deleted, que alimenta a busca (o item some dos resultados) e os webhooks da loja. O SKU do produto excluído fica livre para ser usado por outro produto.

Excluir não desfaz os pedidos nem mexe nas variações

Os pedidos já feitos continuam existindo com o nome e o preço da época. Já as variações de um produto-pai não são excluídas junto: cada filho é um produto e precisa ser excluído por conta própria (ou desligado do pai, veja Variações e opções). Se o produto já foi vendido, prefira desativar (status: "D"): ele sai da loja do mesmo jeito e continua legível nos pedidos e relatórios.

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

Excluir um produto

Autenticação: HTTP Basic com e-mail:chave_de_api de um administrador, ou Authorization: Bearer <JWT>. A rota também responde em /api/products/{id}, com o id decimal em string. A resposta de sucesso é 204 sem corpo.

Parâmetros de caminho

idstringobrigatório
Id do produto: o product_id, em UUID (na rota /api/products/{id}, também o id decimal).

Exemplo de requisição

bash
curl -u "$EMAIL:$API_KEY" -X DELETE \
  "$BASE_URL/api/v1.0/products/0497b6a8-c868-43be-ac21-2abddd24cd3c"

Resposta

204Produto excluído
http
HTTP/1.1 204 No Content

Campos da resposta

(sem corpo)none
A resposta 204 não tem corpo. Para confirmar, consulte o produto: ele passa a responder 404.

Erros

StatusQuandoCorpo
401Sem credenciais, chave inválida ou token expirado{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}
403Usuário sem permissão de escrita{"message":"Forbidden: admin scope required","status":403}
404O produto não existe ou já está na lixeira{"message":"Product not found","status":404}
429Limite de requisições{"error":"rate limit exceeded","detail":"too many requests, please try again later"}
500{id} que não é UUID, ou falha interna{"message":"Failed to delete product","status":500}
Repetir o DELETE é seguro, mas leia o status

Excluir duas vezes o mesmo produto não causa dano: a segunda chamada não encontra nada para excluir. Ela responde 404. Em um laço de sincronização, trate esse retorno como "já excluído" e siga em frente.

Veja também

  • Consultar produto
  • Alterar produto
Anterior
Alterar produto
Próxima
Categorias do produto
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também