Orders

Delete Orders by Order Number

Delete an order from your depot using your own order number instead of the SmartRoutes id. The match is exact. URL-encode order numbers that contain characters such as /. The response gives the number of orders and line items deleted.

Deleting an order also deletes:

  • its line items, custom fields, capacities, time windows and other details
  • its links to any route stops and plans it was on
  • proof of delivery photos and signatures recorded against the order

If the order is one half of an exchange, its partner order is deleted too and counted in orders_count.

If no order in your depot has this number, the request still succeeds, with orders_count: 0. It does not return 404. If you later send the same order number to POST /orders, the order is restored under its original id.

delete/orders/order-number/{order_number}

Request

  • Base URL: https://api.smartroutes.io/v2
  • URL: https://api.smartroutes.io/v2/orders/order-number/{order_number}
  • Auth: none declared

Path parameters

order_numberstring required

Order number to delete orders.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.