Skip to main content

MODIFY BRACKET ORDER​

This API enables modification of existing Bracket Orders for authorized end users through a middleware-based integration.

Only eligible pending Bracket Order legs can be modified.

🔗 Path Parameters​

ParameterTypeRequiredDescriptionExample
exchangestringYesExchange segment in which the Bracket Order is placed"NSE_EQ"
order_idstringYesOrder ID of the Bracket Order to be modified"NXVZO00098K1"

🔍 Query Parameters​

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters​

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

📘Request body schema​

FieldsTypeRequiredDescriptionExample/Enum
main_legobjectYesMain order legs to be modifiedSee below table
stoploss_legobjectYesStoploss order leg to be modifiedSee below table
profit_legobjectYesProfit order leg to be modifiedSee below table
fields_modifiedobjectYesFlags indicating which field are being updatedSee below table
product_sourcestringNoSource of the order. Allowed values: WEBAPI, MOBILEAPI (case-insensitive). Any other value is ignored without an error."WEBAPI"

📝Main Leg Object Fields​

FieldsTypeRequiredDescriptionExample/Enum
order_typestringyesOrder Types: Only RL or RL-MKT supportedRL
quantityintegeryesModified quantity of the order100
traded_quantityintegeryesAlready traded quantity from order book20
pricenumberyesNew price for the main leg ( 0 for market )1525.00
traded pricenumberyesShould always be set to 00

📑Stoploss Leg Object Fields​

FieldsTypeRequiredDescriptionExample/Enum
Legsarray (object)YesList of stoploss order legsSee below table
TrailsobjectNoTrailing stoploss settingSee below table

📑Each leg Array Fields​

FieldsTypeRequiredDescriptionExample/Enum
QuantityintegernoIgnored by system (sent as 0 or original quantity)100
pricenumberyesModified execution price of the stoploss leg1540.00
trigger_pricenumberyesTrigger price which SL should activate1510.00

📑Trail objects fields​

FieldsTypeRequiredDescriptionExample/Enum
ltp_jump_pricenumbernoLTP increment required for SL to trail5.00
stoploss_jump_pricenumbernoAmount by which SL will trail once LTP moves2.00

📑Profit Leg Object Field​

FieldTypeRequiredDescriptionExample/Enum
LegsArray (object)YesList of profit ordersSee below table

📑Legs Object Fields​

FieldTypeRequiredDescriptionExample/Enum
QuantityintegernoIgnored by system (send as 0 or original quantity)100
PricenumberyesNew target price for the profit leg1560.00

📑Fields modified object fields​

FieldsTypeRequiredDescriptionExample/Enum
main_leg_pricebooleanyesSet to true if main leg price is changedtrue
main_leg_qtybooleanyesSet to true if quantity is changedtrue
stoploss_leg_pricebooleanyesTrue if stoploss price or trigger price is updatedtrue
stoploss_trail_pricebooleanyesTrue if trailing stoploss values are changedtrue
profit_leg_pricebooleanyesSet to true if profit leg price is changedtrue

🟢Success Response - 200 OK ​

FieldsTypeDescriptionExample/Enum
statusstringStatus of API Call"success"
codestringResponse code"s-101"
messagestringSuccess Message"Order modification sent to OMS"
dataobjectContains additional detail like order IDSee below

📘Data Object Field​

FieldsTypeDescriptionExample/Enum
orderIdstringID of the modified order"NWSYF0027?3"