OrderCancel
Cancels an order, reversing associated fulfillments and triggering applicable refunds.
Input
| Name | Type | Description |
| NotifyCustomer | Bool | Indicates whether a notification should be sent to the customer informing them of the order cancellation. |
| OrderId | String | The unique identifier of the order to be canceled. |
| Reason | String | The explanation or justification for canceling the order.
The allowed values are CUSTOMER, DECLINED, FRAUD, INVENTORY, OTHER, STAFF. |
| Refund | Bool | Specifies whether the customer should be refunded for payments made toward the canceled order. |
| Restock | Bool | Indicates whether items from the canceled order should be returned to available inventory. |
| StaffNote | String | An internal note visible only to staff members, providing context or remarks about the cancellation. |
| WaitJob | Bool | Determines whether the stored procedure should wait until the cancellation job is fully completed before returning results.
The default value is true. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Indicates whether the order cancellation process completed successfully without errors. |
| Details | String | Provides additional information or messages describing the outcome of the cancellation operation. |
| JobID | String | A unique identifier assigned to the background job handling the order cancellation process. |
| Status | String | The current status of the background job, such as pending, completed, or failed. |