CancelTransferOrder
Cancels a transfer order, transitioning its status to CANCELED. This is a Beta API.
Stored Procedure Specific Information
Execute
You need to provide the TransferOrderId and an IdempotencyKey to cancel the transfer order. The transfer order must be in STARTED or PARTIALLY_RECEIVED status. Note: This is a Beta API.
EXECUTE CancelTransferOrder TransferOrderId = 'MYQUPHN3EIRBCKJR', IdempotencyKey = 'cancel-tro-20240721-001'
You can optionally provide TransferOrderVersion for optimistic concurrency control:
EXECUTE CancelTransferOrder TransferOrderId = 'MYQUPHN3EIRBCKJR', IdempotencyKey = 'cancel-tro-20240721-001', TransferOrderVersion = 2
Input
| Name | Type | Required | Description |
| TransferOrderId | String | True | The ID of the transfer order to cancel. |
| IdempotencyKey | String | True | A unique string that identifies this request. |
| TransferOrderVersion | Int64 | False | The current version of the transfer order, used for optimistic concurrency control. |
Result Set Columns
| Name | Type | Description |
| CurrentStatus | String | The status of the transfer order after cancellation (CANCELED). |
| Success | Boolean | Whether the operation was successful. |