Modify Cover Order
This API allows you to modify an existing Cover Order that is pending in the order book.
🛣️Path parameters
| Fields | Type | Required | Description | Example/Enum |
|---|
| Exchange | string | yes | Exchange segments | NSE_EQ |
| order_id | string | yes | Order ID (URL encoded format) | NWSYF00006>3 |
| Fields | Type | Required | Description | Example/Enum |
|---|
| Authorization | string | yes | Bearer token for authentication | access_token |
| x-api-key | string | yes | API key provided by broker | x-api-key |
📦Request Body Schema
| Fields | Type | Required | Description | Example/Enum |
|---|
| main_leg | object | yes | Main order details | See below table |
| stoploss_leg | object | yes | Stop loss order details | See below table |
| leg_indicator | string | yes | Indicates which leg is being modified. "2" refers to the stoploss leg | "2" |
📘Main Leg Object Fields
| Fields | Type | Required | Description | Example/Enum |
|---|
| order_type | string | yes | Order Types Allowed values: RL (Regular Limit) or RL-MKT (Regular Market) | RL` / `RL-MKT |
| quantity | integer | yes | Total quantity to transact | 100 |
| traded_quantity | integer | yes | Quantity already traded (get from order book) | 40 |
| price | number | Yes | Price must be 0 for RL-MKT type orders | 0 |
📘Stoploss Leg Fields
| Fields | Type | Required | Description | Example/Enum |
|---|
| legs | array(object) | yes | Array of stop-loss leg orders. | See below table |
📘Inside Stop-loss legs array:
| Fields | Type | Required | Description | Example/Enum |
|---|
order_type | string | Yes | Order type for the SL leg. After SL is triggered, must be RL-MKT. | RL-MKT |
trigger_price_validation | boolean | Yes | Enable trigger price validation. Must be true after SL is triggered. | true |
quantity | integer | No | Quantity present. Currently ignored by the system. | 2625 |
price | number | Conditional | Price at which SL should execute. Required for SL type only. Must be 0 after SL is triggered. | 0 |
trigger_price | number | Yes | Trigger price that activates the stop-loss leg. Must be 0 after SL is triggered. | 0 |
⚠️ Important: After SL is triggered, price and trigger_price in the stoploss leg must always be 0.
🟢Success Response - 200 OK
| Fields | Type | Description | Example/Enum |
|---|
| Status | String | API call status | success |
| Code | string | Response code | s-101 |
| message | string | success message | Order Modification sent to OMS |
| data | object | Contains the modified order ID | See below table |
📘Data Object Field
| Fields | Type | Description | Example/Enum |
|---|
| orderId | string | Modified system generated Order-ID | "NWSYF00008>3" |