The SubmitAllocationOrderRequest object is used as an input in SubmitAllocationOrder API. This API is used to allocate partial or full order volume from your account to multiple sub-accounts by sending allocation instructions over Allocations API.
SubmitAllocationOrderRequest
| Field Name | Required? | Data Type | Accepted Values/Examples |
|---|---|---|---|
| Exchange | Yes | string | Three-letter acronym for listing exchange |
| OrderId | Yes | string | A unique id associated to every order. This is the identifier to lookup the specific order to allocate |
| OrderTypes | Yes | OrderType | Refer to the section OrderType |
| SourceAccount | Yes | string | Source account for the allocated order |
| Symbol | Yes | string | Valid ticker symbol (e.g., AAPL, IBM, VOD.LSE) |
| TargetAccount | Yes | string | Destination account for the allocated order |
| TargetPrice | No | google.protobuf.DoubleValue | Limit price of allocated order |
| TargetQuantity | Yes | int32 | Volume of the ticket if the ticket is live, or the Traded Amount if the order has been canceled before completion |
| TypeOfAllocation | Yes | AllocationType | Refer to the section AllocationType |
| UserToken | Yes | string | A server generated GUID that is given as response to the client during the first login |