Plans

Delete Plan by ID

Permanently delete a plan from your depot, along with every route and stop on it. This includes routes from earlier optimisations of the plan and routes that have already been dispatched. Deleting a dispatched plan is allowed, and there is no undo.

What happens to related data:

  • The orders themselves are not deleted.
  • Orders on dispatched routes move back to OPEN so they can be planned again, and an orders.status webhook is published for each one. Orders on routes that were never dispatched keep their current status.
  • Scheduled customer notifications for the removed stops are cancelled, and the SMS credit reserved for them is refunded.
  • A routes.deleted webhook is published for each dispatched route removed, and a plans.deleted webhook is published for the plan.

A plan that does not exist, or that belongs to another depot, answers 404 RESOURCE_NOT_FOUND.

delete/plans/{id}

Request

  • Base URL: https://api.smartroutes.io/v2
  • URL: https://api.smartroutes.io/v2/plans/{id}
  • Auth: none declared

Path parameters

idnumber required

ID of the plan to delete.

Response

Successful response

Changes

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