Skip to main content
Permission: Write · Workspace: required (from goody_workspaces_list) Cancels a single order — one recipient’s gift.
This is irreversible — it releases the recipient’s payment hold and refunds any applied credit. Only orders the recipient has not yet accepted can be canceled.
To cancel a whole batch, call this once per order id from goody_orders_list.

​
Parameters

​
string
required
Workspace UUID — from goody_workspaces_list. Scopes the cancellation to this workspace.
​
string
required
The order to cancel — an order id from a goody_orders_list result.

​
Returns

​
string
The order id that was canceled.
​
string | null
The order status after cancellation.
A person can also self-serve cancellations on the Goody Track page.

​
Example

Find the order id with goody_orders_list; for the full detail of the batch it belongs to, use goody_order_batches_get.