Cancels an order identified by order_id (or request_id). Beyond the documented 400 validation cases, the endpoint is rate-limited at a default of 100 requests / 60 seconds (HTTP 429, status 'rate-limit-exceeded') and returns HTTP 500 (status 'application-crash') on an unexpected server error. The rate limit is admin-managed and may change per integration.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Overview
The Order Cancelation API is an easy tool your team can use to cancel any PlanOmatic order prior to it being scheduled.
How long after placing an order can I cancel it via the V3 Order Cancelation API?
The V3 Order Cancelation API will allow you to cancel any order while it is still in a cancelable status (new_request, ordered, or scheduling) and has no confirmed appointment. An order typically leaves these statuses once it is scheduled, which often happens within hours of placement but can vary from order to order based on many factors. We recommend subscribing to the appointment.scheduled webhook event so your system knows when an order can no longer be canceled.
How to Test
Please reach out to [email protected] to get access to our staging server.
POST https://api.planomatic.com/api/v3/orders/cancelValid Cancelation Reasons
Providing accurate cancelation reasons and notes help us provide more meaningful reporting back to your teams.
| cancelation_reason | Description |
|---|---|
| duplicate_order | The order being canceled is a duplicate of an order placed perviously. |
| client_requested_cancelation | The client is requesting a cancelation. Please provide additional notes to help us understand your needs. |
Cancelable Order Statuses
An order can be canceled only while its status is one of new_request, ordered, or scheduling, and it has no confirmed appointments. Cancelability is determined by this status rule (not by a fixed time window). The set of cancelable statuses is admin-managed and may change.