CloneOrder
Clones an existing order to create a new draft order. This is a Beta API. If IdempotencyKey is omitted, the request is sent without one and duplicate submissions are not protected against.
Stored Procedure Specific Information
Execute
You need to provide the OrderId to clone an order. The cloned order is created as a draft. If IdempotencyKey is omitted, no key is sent and the request is not protected against duplicate submissions. Note: This is a Beta API.
EXECUTE CloneOrder OrderId = 'CAISENgvlJ6jLWAzERDzjyHVybY'
You can optionally provide OrderVersion for optimistic concurrency control:
EXECUTE CloneOrder OrderId = 'CAISENgvlJ6jLWAzERDzjyHVybY', OrderVersion = 3
You can optionally provide a custom IdempotencyKey to control retry behavior:
EXECUTE CloneOrder OrderId = 'CAISENgvlJ6jLWAzERDzjyHVybY', IdempotencyKey = 'clone-order-20240721-001'
You can provide all inputs together:
EXECUTE CloneOrder OrderId = 'CAISENgvlJ6jLWAzERDzjyHVybY', IdempotencyKey = 'clone-order-20240721-001', OrderVersion = 3
Input
| Name | Type | Required | Description |
| OrderId | String | True | The ID of the order to clone. |
| IdempotencyKey | String | False | A unique identifier for the clone request to prevent duplicate orders if the call is retried. |
| OrderVersion | Integer | False | The version of the order for concurrency protection. Must match the stored version if provided. |
Result Set Columns
| Name | Type | Description |
| OrderId | String | The ID of the newly cloned order. |
| State | String | The state of the cloned order (DRAFT). |
| Success | Boolean | Whether the operation was successful. |