StartTransferOrder
Starts a transfer order, transitioning its status from DRAFT to STARTED. This is a Beta API.
Stored Procedure Specific Information
Execute
You need to provide the TransferOrderId and a unique IdempotencyKey to start the transfer order. The transfer order must be in DRAFT status. Note: This is a Beta API.
EXECUTE StartTransferOrder TransferOrderId = 'MYQUPHN3EIRBCKJR', IdempotencyKey = 'start-tro-20240721-001'
You can optionally provide TransferOrderVersion for optimistic concurrency control:
EXECUTE StartTransferOrder TransferOrderId = 'MYQUPHN3EIRBCKJR', IdempotencyKey = 'start-tro-20240721-002', TransferOrderVersion = 3
Input
| Name | Type | Required | Description |
| TransferOrderId | String | True | The ID of the transfer order to start. The transfer order must be in DRAFT status. |
| IdempotencyKey | String | True | A unique string that identifies this request. Keys can be any valid string but must be unique for every StartTransferOrder 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 starting (for example, STARTED). |
| Success | Boolean | Whether the operation was successful. |