Message: SuspendOrder

File: WebAPI/order_2.proto

Description

Suspend (park) order request.

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 suspend (park).

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 suspension request (will become new client order ID if suspension is accepted). Maximum allowed length is 64 bytes.

when_utc_time (deprecated)

Type: sint64

Description: 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).

activation_utc_time (deprecated)

Type: sint64

Description: Note: Use activation_utc_timestamp field instead.

activation_utc_timestamp

Type: google.protobuf.Timestamp

Description: Time when the suspended (parked) order should automatically activate (UTC). If specified it’s used instead of activation_utc_time field. If neither this nor activation_utc_time field is specified, order must be activated by ActivateOrder request

extra_attributes

Type: shared_1.NamedValue

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