Order Entry API V2 - Update Order
Request
Body
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | header | |||||
2 | → applicationName | Application Name | String | REQUIRED | Identifies the application generating the message. | |
3 | → applicationVendor | Application Vendor | String | REQUIRED | Identifies the vendor of the application generating the message. | |
4 | → applicationVersion | Application Version | String | REQUIRED | Identifies the version of the application generating the message. | |
5 | → requestId | Request ID | String | REQUIRED | A unique identifier for the request provided by the client for correlation. | |
6 | → sentTime | Sent Time | DateTime | REQUIRED | Timestamp of the message leaving the producing application. | |
7 | payload | |||||
8 | → customerOrderHandlingInstr | Customer Order Handling Instruction | CustomerOrderHandlingInstruction | REQUIRED | ||
9 | → customerOrderId | Customer Order ID | String |
| REQUIRED | |
10 | → displayQtyInt | Display Quantity Integer | Integer | OPTIONAL | ||
11 | → durationType | Duration Type | OrderDurationType |
| REQUIRED | |
12 | → entities | |||||
13 | → → customerAccountId | Customer Account ID | String |
| REQUIRED | |
14 | → → customerOriginType | Customer Origin Type | OriginType |
| REQUIRED | |
15 | → → customerType | Customer Type | CustomerType |
| REQUIRED | |
16 | → → executingFirmId | Executing Firm ID | String |
| REQUIRED | |
17 | → → operatorId | Operator ID | String |
| REQUIRED | |
18 | → → senderCountry | Sender Country | String |
| REQUIRED | |
19 | → → senderState | Sender State | String |
| OPTIONAL | |
20 | → expirationDt | Expiration Date | Date | CONDITIONAL | Criteria
| |
21 | → instrument | |||||
22 | → → glbxSecurityId | Globex Security ID | Integer | REQUIRED | ||
23 | → manualInd | Manual Indicator | YesNoIndicator |
| REQUIRED | Indicates whether the order was generated by automated trading logic. |
24 | → memo | Memo | String |
| OPTIONAL | |
25 | → minimumQtyInt | Minimum Quantity Integer | Integer | OPTIONAL | ||
26 | → ofmOverrideInd | Over-fill Mitigation Override Indicator | YesNoIndicator |
| OPTIONAL | |
27 | → price | Price | Price | CONDITIONAL | Criteria
| |
28 | → qtyInt | Quantity Integer | Integer | REQUIRED | ||
29 | → selfMatchPreventionId | Self-Match Prevention ID | Integer | OPTIONAL | ||
30 | → selfMatchPreventionInstr | Self-Match Prevention Instruction | SelfMatchPreventionInstruction |
| OPTIONAL | |
31 | → sideInd | Side Indicator | MarketSideIndicator |
| REQUIRED | |
32 | → stopPrice | Stop Price | Price | CONDITIONAL | Criteria
| |
33 | → type | Type | OrderType |
| REQUIRED | |
34 | → venueOrderId | Venue Order ID | String | OPTIONAL |
Response - 200
Body
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | header | |||||
2 | → requestId | Request ID | string | ALWAYS | A unique identifier for the request provided by the client for correlation. | |
3 | → sentTime | Sent Time | dateTime | ALWAYS | Timestamp of the message leaving the producing application. | |
4 | payload | |||||
5 | → action | Action | orderAction |
| ALWAYS | |
6 | → cumulativeQtyInt | Cumulative Quantity Integer | int32 | ALWAYS | ||
7 | → customerOrderHandlingInstr | Customer Order Handling Instruction | customerOrderHandlingInstruction | ALWAYS | ||
8 | → customerOrderId | Customer Order ID | string | ALWAYS | ||
9 | → displayQtyInt | Display Quantity Integer | int32 | OPTIONAL | ||
10 | → durationType | Duration Type | orderDurationType |
| ALWAYS | |
11 | → entities | |||||
12 | → → customerAccountId | Customer Account ID | string | ALWAYS | ||
13 | → → customerOriginType | Customer Origin Type | originType |
| OPTIONAL | |
14 | → → customerType | Customer Type | customerType |
| OPTIONAL | |
15 | → → executingFirmId | Executing Firm ID | string | ALWAYS | ||
16 | → → senderCountry | Sender Country | string | ALWAYS | ||
17 | → → senderState | Sender State | string | OPTIONAL | ||
18 | → expirationDt | Expiration Date | date | CONDITIONAL | Criteria
| |
19 | → instrument | |||||
20 | → → glbxSecurityId | Globex Security ID | int32 | ALWAYS | ||
21 | → manualInd | Manual Indicator | yesNoIndicator |
| ALWAYS | Indicates whether the order was generated by automated trading logic. |
22 | → memo | Memo | string | OPTIONAL | ||
23 | → minimumQtyInt | Minimum Quantity Integer | int32 | OPTIONAL | ||
24 | → price | Price | price | CONDITIONAL | Criteria
| |
25 | → qtyInt | Quantity Integer | int32 | ALWAYS | ||
26 | → remainingQtyInt | Remaining Quantity Integer | int32 | ALWAYS | ||
27 | → sideInd | Side Indicator | marketSideIndicator |
| ALWAYS | |
28 | → status | Status | orderStatus |
| ALWAYS | |
29 | → stopPrice | Stop Price | price | CONDITIONAL | Criteria
| |
30 | → transactionTime | Transaction Time | dateTime | ALWAYS | ||
31 | → type | Type | orderType |
| ALWAYS | |
32 | → venueExecutionId | Venue Execution ID | string | ALWAYS | ||
33 | → venueOrderId | Venue Order ID | string | ALWAYS |
Response - 400
Body
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | errors[] | |||||
2 | → code | Code | string |
| ALWAYS | |
3 | → message | Message | string | ALWAYS | ||
4 | header | |||||
5 | → requestId | Request ID | string | ALWAYS | A unique identifier for the request provided by the client for correlation. | |
6 | → sentTime | Sent Time | dateTime | ALWAYS | Timestamp of the message leaving the producing application. |
Response - 403
Body
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | errors[] | |||||
2 | → code | Code | string |
| ALWAYS | |
3 | → message | Message | string | ALWAYS | ||
4 | header | |||||
5 | → requestId | Request ID | string | ALWAYS | A unique identifier for the request provided by the client for correlation. | |
6 | → sentTime | Sent Time | dateTime | ALWAYS | Timestamp of the message leaving the producing application. |
Response - 500
Body
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | errors[] | |||||
2 | → code | Code | string | ALWAYS | ||
3 | → message | Message | string | ALWAYS | ||
4 | → referenceField | Reference Field | string | OPTIONAL | ||
5 | header | |||||
6 | → requestId | Request ID | string | ALWAYS | A unique identifier for the request provided by the client for correlation. | |
7 | → sentTime | Sent Time | dateTime | ALWAYS | Timestamp of the message leaving the producing application. | |
8 | payload | |||||
9 | → customerOrderId | Customer Order ID | string | ALWAYS | ||
10 | → transactionTime | Transaction Time | dateTime | OPTIONAL | ||
11 | → venueOrderId | Venue Order ID | string | ALWAYS |
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.