Modify GTT Order

This API allows you to modify an existing GTT order that is pending in the order book.

🛣️ Endpoint

PUT {{hosturl}}/transactional/v1/orders/regular/:market/:orderID

🛣️ Path Parameters

Fields	Type	Required	Description	Example/Enum
market	string	Yes	Exchange segments	NSE_FO
orderID	string	Yes	Order ID to be modified (URL encoded format)	NYMKL00016;<

🔑 Header Parameters

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
Content-Type	string	Yes	Must be application/json	application/json

📦 Request Body Schema

Fields	Type	Required	Description	Example/Enum
scrip_info	object	Yes	Instrument exchange info	See below table
order_type	string	Yes	Order Types	RL / SL / RL-MKT
quantity	integer	Yes	Updated quantity for the order	75
price	number	Yes	Updated limit price	25500
trigger_price	number	Yes	Updated trigger price	23000
disclosed_quantity	integer	No	Quantity to disclose publicly	0
validity	string	Yes	Order validity type. Must be GTT	GTT
validity_days	integer	No	Number of days the order remains valid	0
traded_quantity	integer	Yes	Already traded quantity (fetch from order book)	0

📘 Scrip Info Object Fields

Fields	Type	Required	Description	Example/Enum
exchange	string	Yes	Exchange segments	NSE_FO

📋 Sample Request Body

{
    "scrip_info": {
        "exchange": "NSE_FO"
    },
    "order_type": "RL",
    "quantity": 75,
    "price": 25500,
    "trigger_price": 23000,
    "disclosed_quantity": 0,
    "validity": "GTT",
    "validity_days": 0,
    "traded_quantity": 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 Fields

Fields	Type	Description	Example/Enum
orderId	string	System-generated modified Order ID	"NYMKL00016;<"

📋 Sample Response

{
    "status": "success",
    "code": "s-101",
    "message": "Order Modification Sent to OMS",
    "data": {
        "orderId": "NYMKL00016;<"
    }
}