Cancel an order
cancel_orderCancel an order from a conversation on the Shopify store, as the signed-in teammate. The workspace's approval rules apply: a cancellation above their limits waits for an admin, and the result says whether it ran or waits. Repeated calls are not deduplicated: an order already cancelled is refused, but calling it again while a cancellation waits for approval adds another request.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notify | No | Email the customer about the cancellation. | |
| reason | No | Why the order is cancelled. | |
| refund | No | Refund the amount paid to the original payment methods. | |
| orderId | Yes | The order id, from get_conversation_orders or lookup_orders. | |
| restock | No | Put the items back in stock. | |
| staffNote | No | A staff-facing note on the cancellation (at most 255 characters). | |
| conversationId | Yes | The Aide conversation id (`cnv_…`), from find_conversation. | |
| requestApproval | No | Ask a teammate to approve it instead of running it now. Without it, the workspace approval rules decide: an action above their limits waits for an admin. |