Modify Order

The Modify Order API allows users to update an existing pending order on the exchange. This can include changes to the order’s quantity, price, order type, disclosed quantity, or validity. It is typically used when a trader wants to adjust an order that has not yet been fully executed.

🛣️Path Parameters

Parameters	Type	Required	Description	Example/ENUM
exchange	string	yes	Exchange segments	NSE_FO
order_id	string	yes	Order ID is given in URL encode form	NWSYF00005>3

🔑Header Parameters

Field	Type	Required	Description	Example/ENUM
content_type	String	Yes	Specifies the format of the request body.	application/json
Authorization	String	yes	Bearer token for user authentication	acess_token
x-api-key	String	yes	The API key provided for identifying the client application.	x-api-key

📦Request Body Schema:

Fields	Type	Required	Description	Example
order_type	String	yes	Specifies the Order Types of the order..	"RL"
quantity	integer	yes	This specifies the number of quantity users wants to modify.	5
traded_quantity	integer	yes	Specifies the total quantity traded for the order up to the current point. This data can be obtained from the order book response.	50
price	number	yes	The price at which the order will be placed, specified in rupees.Default: 0	250.75
trigger_price	number	yes	The price set by the user for stop loss or stop loss market order types. When this price is reached, the order is triggered and subsequently placed at the specified limit price.	245.00
disclosed_quantity	integer	yes	A portion of disclosed order quantity that the user chooses to display in the market. The remaining quantity stays hidden until the disclosed quantity is fully executed	20
validity	string	yes	Default: "DAY"The order Validity value will be dependant on exchange segments in which the order is being placed.	"DAY"
validity_days	integer	yes	Number of days for which the GTD order needs to be carried forward.	5

🟢Success Response - 200 Ok

Fields	Type	Description	Example/Enum
status	string	Indicates the result of API Call	"success"
code	string	Response code corresponding to the request	"s-101"
message	string	Descriptive message for the response	"order modification sent to OMS"
data	object	Contains order-specific response details	Order Identification number generated by system

📘Data Object Info field

Fields	Type	Description	Example
orderId	string	System generated order ID after modification	"NWSYF00005>3"

put/transactional/v1/orders/regular/{exchange}/{order_id}