Order Entry API - Update Order
Update a working order by the Venue Order ID.
URL |
|
---|---|
HTTP Method |
|
Version | 1.0.1 |
Request
Parameters
Parameter | Name | Location | Type | Multi-ple | Values | Usage | Description |
---|---|---|---|---|---|---|---|
| Application Name | Header |
| No | REQUIRED | Name of the customer system that generated the message. Must match the system name as certified in AutoCert+ exactly. | |
| Application Vendor | Header |
| No | REQUIRED | Name of the vendor who provided the customer system. For a proprietary system, use the firm name. | |
| Application Version | Header |
| No | REQUIRED | Version identifier for the customer system. | |
| Request ID | Header |
| No | REQUIRED | ||
| Transaction Time | Header |
| No | Format:Â | REQUIRED | |
| Venue Order ID | Path |
| No | REQUIRED |
Body
Order Request Message - OrderRequestMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Payload |
|
Order - OrderRequestMessage.payload[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Customer Order ID |
| REQUIRED | Unique customer-assigned order identifier. Client system must maintain uniqueness of this value across all orders for the trading week (Sunday through Friday). Maximum allowed value is 20bytes. | |
| Display Quantity |
| OPTIONAL | Maximum amount of quantity to be displayed in the order book at any given time. Default is the full order quantity. Can be any number between 1 and the value in Quantity. This field can only be changed if the display quantity is set on the initial order. | |
| Manual Indicator |
| REQUIRED | Indicates if the message was generated by manual or automated trading logic. This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems. | |
| Price |
| OPTIONAL | Price per lot for the order. Required for Limit and Stop_Limit orders | |
| Order Quantity |
| OPTIONAL | Total order size. |
Response - 204
Response - 400
Body
Error Response Message - ErrorResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Errors |
|
Error - ErrorResponseMessage.errors[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Error Code |
| ALWAYS | ||
| Error Instance |
| OPTIONAL | ||
| Error Message |
| ALWAYS | ||
| Error Reference Index |
| ALWAYS |
Response - 401
Response - 404
Response - 500
Body
Error Response Message - ErrorResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Errors |
|
Error - ErrorResponseMessage.errors[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Error Code |
| ALWAYS | ||
| Error Instance |
| OPTIONAL | ||
| Error Message |
| ALWAYS | ||
| Error Reference Index |
| ALWAYS |
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.