OrderCancel
Cancels an order and optionally restocks items and notifies the customer.
Input
| Name | Type | Description |
| NotifyCustomer | Bool | Indicates whether a notification is sent to the customer about the order cancellation. |
| OrderId | String | The Id of the order to be canceled. |
| Reason | String | The reason for canceling the order.
The allowed values are CUSTOMER, DECLINED, FRAUD, INVENTORY, OTHER, STAFF. |
| Refund | Bool | Indicates whether the amount paid by the customer is refunded. |
| Restock | Bool | Indicates whether the inventory committed to the order is restocked. |
| StaffNote | String | A staff-facing note about the order cancellation. Not visible to the customer. |
| WaitJob | Bool | Indicates whether the stored procedure waits until the job is complete.
The default value is true. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation completed successfully. |
| Details | String | Additional details about how the operation was executed. |
| JobID | String | The Id of the job associated with the cancellation. |
| Status | String | The status of the job. |