MODIFY COVER ORDER
This API enables modification of existing Cover Orders for authorized end users through a middleware-based integration.
Only eligible pending Cover Orders can be modified.
🔗 Path Parameters
| Parameter | Type | Required | Description | Example |
|---|
| exchange | string | Yes | Exchange segment in which the Cover Order is placed | "NSE_EQ" |
| order_id | string | Yes | Order ID of the Cover Order to be modified | "NXWBB00002" |
🔍 Query Parameters
| Parameter | Type | Required | Description | Example |
|---|
| userId | string | Yes | User ID (UCC) | "{{user_id}}" |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Request payload format | application/json |
| Authorization | string | Access token for authenticated requests | {{access_token}} |
| x-api-key | string | API key used to authorize request | {{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" |
| product_source | string | No | Source of the order. Allowed values: WEBAPI, MOBILEAPI (case-insensitive). Any other value is ignored without an error. | "WEBAPI" |
📘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
Content-Type: application/json
| Field | Type | Description | Example |
|---|
| status | string | Status of API call | "success" |
| code | string | Response code | "s-101" |
| message | string | Cover Order modification success message | "Cover order modified successfully" |
| data | object | Order response details | Refer Data Object Fields |
📦 Data Object Fields
| Field | Type | Description | Example |
|---|
| orderId | string | System-generated order identification number | "NXWBB00002" |