OrderAmend

Amend an existing Order.

Order Management Details

Metadata

  • Message Type: TransactionMessage
  • Message Number: 1002

Inherited fields

NameTypeSize (bytes)Description
MessageTypeInteger (unsigned)2The unique identifier of this message.
ClientIdInteger (unsigned)4The unique identifier of a session with the server, returned in a successful LoginReply message.
RequestIdInteger (unsigned)4Within each session each message must be uniquely identified by this field. It must be monotonically increasing for the duration of the session.

Fields

NameTypeSize (bytes)Description
IdForeign key to Order8The Id of the Order to be amended.
ClOrdIDString60For a FIX Order, this is the Client OrderId of the new Order that will be generated by the amendment.
OrigClOrdIDString60For a FIX Order, this is the Client OrderId of the Order that is being amended.
OriginalAccountForeign key to Account8if not NULL, the Account of the order being amended must match this.
AmendPriceInteger (unsigned)1If true, the price of the Order will be amended.
PriceInteger (signed)8If AmendPrice is set, this is the new price for the Order.
AmendTotalQuantityInteger (unsigned)1If true, the total quantity of the Order will be amended.
TotalQuantityInteger (signed)8If AmendTotalQuantity is set, this is the new total quantity for the Order.
AmendHiddenQuantityInteger (unsigned)1If true, the hidden quantity of the Order will be amended.
HiddenQuantityInteger (signed)8If AmendHiddenQuantity is set, this is the new hidden quantity for the Order.
AmendAccountInteger (unsigned)1If true, the Account of the Order will be amended.
AccountForeign key to Account8If AmendAccount is set, this is the Id of the new Account for the Order if non-zero (otherwise, AccountCode will be used).
AccountCodeString40If AmendAccount is set, and Account is zero, this is the new Account Code for the Order.
AmendTagInteger (unsigned)1If true, the Tag of the Order will be amended.
TagString50If AmendTag is set, this is the new Tag for the Order.
AmendExpiryInteger (unsigned)1If true, the expiry of the Order will be amended.
ExpirySet of OrderType4If AmendExpiry is set, one of the OrderType bitmask fields corresponding to an expiry type.
ExpiryDateInteger (signed)4If AmendExpiry is set, the expiry date for the Order.
ExpiryTimeInteger (signed)4If AmendExpiry is set, the expiry time for the Order.
LiveForInteger (unsigned)4If AmendExpiry is set, a new LiveFor value for the Order.
AmendPegRefInteger (unsigned)1If true, the PegRef of the Order will be amended.
PegRefOne of PegRef1The reference for a peg order. Can be Bid, Mid or Ask
AmendPegOffsetInteger (unsigned)1If true, the PegOffset of the Order will be amended.
PegOffsetInteger (signed)8Price offset from the peg reference
AmendMinimumFillInteger (unsigned)1If true, the MinimumFill of the Order will be amended.
MinimumFillInteger (signed)8Minimum Fill Quantity for this order. Can fill with multiple smaller orders.
AmendAllOrNoneInteger (unsigned)1If true, the All Or None bit of the order will be amended.
AllOrNoneInteger (unsigned)1If AmendAllOrNone is set, the new value of the AON bit of the order.
AmendOrderInfoInteger (unsigned)1If set, the OrderInfo field will be amended.
OrderInfoString140Free-text field for supplementary information that can be entered with the order, which will be displayed in the order book.
AmendPriorityInteger (unsigned)1If true, the Priority (settlement priority) for the order will be amended.
PriorityInteger (unsigned)2If AmendPriority is set, amends the settlement priority for a multi-class settlement order.

Permissions


Amend a specific order

{ id: 1, amendprice: true, price: 110 }

Permission Checks

PermissionActionTableScopeIndex
AmendOrderInstance0
ViewAccountInstance0
ViewInstrumentMarketInstance0
ViewMarketInstance0
EnterInstrumentMarketInstance0
ViewMarketInstance0
AllowBuyOrSellMarketInstance0

Test file: OrderAmend