Cancel order
What happens when an order is cancelled?
dorna_cancel_order cancels an order while its canEdit is true. An unpaid order leaves the campaign; a paid order is cancelled and its amount returns to your balance.
- dorna_cancel_order
- Changes data
- Asks before it runs
Parameters
| Field | Type | Description |
|---|---|---|
orderId | string (ID) | Required. The order's ID, from dorna_orders. |
What it returns
The order's new status. An unpaid order leaves the campaign and the draft invoice is re-priced; this is how an outlet is removed from a basket. Orders bought with a coupon cannot be cancelled here (COUPON_ORDER_CANCEL_FORBIDDEN).
Example
Ask your assistant: Cancel the order that the outlet has not accepted yet.
The assistant then calls the tool like this:
{
"name": "dorna_cancel_order",
"arguments": {
"orderId": "64f1a2b3c4d5e6f7a8b9c0d1"
}
}A typical result looks like this (the values are examples):
{
"orderId": "64f1a2b3c4d5e6f7a8b9c0d1",
"campaignId": "64f1a2b3c4d5e6f7a8b9c0d1",
"status": "IN_PROGRESS",
"refunded": true
}Access and confirmation
Changes or deletes existing data. Your assistant asks you before every call.
Cancelling cannot be undone. Your assistant confirms the outlet, and whether the order is paid, first.
Related tools: dorna_orders dorna_delete_campaign
Still have a question?
Open this guide in your own AI assistant and ask it.