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

Excluir um pedido

Exclui permanentemente um pedido do sistema, pelo id.

Este endpoint exclui um pedido do seu sistema. Depois de excluído, o pedido não pode ser recuperado. Envie uma requisição DELETE ao endpoint de pedidos com o id do pedido no caminho da URL. Por exemplo, DELETE /api/orders/98/ exclui o pedido de id 98.

Cuidado

Excluir um pedido é permanente e não pode ser desfeito. Confirme que você guardou as informações necessárias antes de prosseguir. Na maioria dos casos de negócio, é melhor atualizar o status do pedido do que excluí-lo.

DELETE/api/orders/{order_id}Admin

Excluir um pedido

Parâmetros de caminho

order_idintegerobrigatório
O identificador único do pedido a excluir.

Exemplo de requisição

bash
curl -X DELETE -u "$EMAIL:$API_KEY" "$BASE_URL/api/orders/98/"

Formato da resposta

Código de statusDescrição
204 No ContentO pedido foi excluído com sucesso.
400 Bad RequestNão foi possível excluir o pedido (por exemplo, ele está ligado a outros registros).
404 Not FoundO pedido informado não existe.

Veja também

  • Atualizar um pedido
  • Obter um pedido
Anterior
Atualizar um pedido
Próxima
Pedidos: rotas sem versão e app do seller
Nesta página
  • Exemplo de requisição
  • Formato da resposta
  • Veja também