SAsamsara
Beta APIs

[beta] Delete orders from a plan

Delete one or more orders from a plan. Pass either orderIds (a comma-separated list) or deleteAll=true; exactly one is required. Orders are automatically unassigned from their routes before deletion.

Beta: This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have RoutePlanning APIs enabled for your organization.

<b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Write Routes under the Driver Workflow category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

delete/hub/plan/orders

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

planIdstring required

The plan identifier

orderIdsstring

Comma-separated list of order IDs to delete. Mutually exclusive with deleteAll=true; exactly one of the two must be provided.

deleteAllboolean

When true, every order in the plan is deleted. Must not be combined with orderIds. Must be set to true explicitly — false is equivalent to omitting the parameter and requires orderIds to be supplied.

Response

No Content response.

Changes

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