Message: ModifyOrder

File: WebAPI/order_2.proto

Description

Modify order request, include only fields that are supposed to be modified.

Used in

OrderRequest

Fields

order_id

Type: string

Description: Order ID assigned by server after the last modification.

Source: latest OrderStatus.order_id received via a TradeSubscription with the order scope in the connection.

account_id

Type: sint32

Description: ID of the order’s account.

Source: trading_account_2.Account.account_id, order_2.OrderStatus.account_id, order_2.Order.account_id.

orig_cl_order_id

Type: string

Description: This client order ID of the order to modify.

Source: latest Order.cl_order_id received via a TradeSubscription with the order scope in the connection.

cl_order_id

Type: string

Description: Client order ID of this modify request (will become new client order ID if modify is accepted). Maximum allowed length is 64 bytes.

when_utc_time (deprecated)

Type: sint64

Description: Client side time when a modify request was submitted (UTC).

Note: Use when_utc_timestamp field instead.

when_utc_timestamp

Type: google.protobuf.Timestamp

Description: Client side time when a modify request was submitted (UTC). If specified it’s used instead of when_utc_time field (at least one of these fields has to be specified).

uint32_qty (deprecated)

Type: uint32

Description: Note: Use qty field instead.

uint32_visible_qty (deprecated)

Type: uint32

Description: Note: Use visible_qty field instead.

uint32_min_visible_qty (deprecated)

Type: uint32

Description: Note: Use min_visible_qty field instead.

qty

Type: cqg.Decimal

Description: Order size what the client wants the total size to become.

visible_qty

Type: cqg.Decimal

Description: What the client wants the visible size to become.

min_visible_qty

Type: cqg.Decimal

Description: What the client wants the minimum visible size to become.

scaled_limit_price

Type: sint64

Description: What the client wants the limit price to become.

scaled_stop_price

Type: sint64

Description: What the client wants the stop price to become.

activation_utc_time (deprecated)

Type: sint64

Description: Note: Use activation_utc_timestamp field instead.

activation_utc_timestamp

Type: google.protobuf.Timestamp

Description: What the client wants the activation time to become (UTC). If specified it’s used instead of activation_utc_time field.

remove_activation_time

Type: bool

Description: True if activation time should be removed.

suspension_utc_time (deprecated)

Type: sint64

Description: Note: Use suspension_utc_timestamp field instead.

suspension_utc_timestamp

Type: google.protobuf.Timestamp

Description: What the client wants the suspension time to become (UTC). If specified it’s used instead of suspension_utc_time field.

remove_suspension_utc_time

Type: bool

Description: True if suspension time should be removed.

duration

Type: uint32

Description: What the client wants the order duration to become. This field is associated with Order.Duration enum type.

good_thru_date

Type: sint64

Description: What the client wants the order expiration date to become (see Order.good_thru_date).

good_thru_utc_time (deprecated)

Type: sint64

Description: Note: Use good_thru_utc_timestamp field instead.

good_thru_utc_timestamp

Type: google.protobuf.Timestamp

Description: What the client wants the order expiration time to become (see Order.good_thru_utc_timestamp). If specified by the user, it’s used instead of good_thru_utc_time field.

extra_attributes

Type: shared_1.NamedValue

Description: List of order extra attributes can be used to remove or modify existing or add new attributes.

execution_source_code

Type: string

Description: FIA Execution Source Code value of the operation. See Order.execution_source_code