Skip to main content

Cancel All Orders

This API cancels either speific orders (by passing order IDs) or all open orders (by setting a flag)

🔑Header Parameters

FieldsTypeRequiredDescriptionExample
AuthorizationstringyesBearer token for authenticationaccess_token
Content_typestringyesMIME Typeapplication/JSON
x-api-keystringYesAPI key provided by bearerx-api-key

📦Request Body Schema: application/json

FieldsTypeRequiredDescriptionExample/ENUM
ordersarray of stringOptionalList of order Ids with Exchange segments to cancel specific orders. Format: <exchange>_<orderId>[ "NSE_EQ" , "NXWA00026L3" ]
flagbooleanYesFlag to cancel all orders if true; if false, cancel only orders in ordersarray.true

🟢Responses - 200 K

FieldsTypeDescriptionExample
statusstringAPI call status"success"
codestringInternal response"s-101"
messagestringResult message"Order cancelled."
dataarray of objectsArray containing cancellation status of each orderSee table below

📘Data array object

FieldsTypeDescriptionExample/ENUM
statusstringOrder cancellation status"true"
messagestringsuccess message"Order cancellation send to OMS"
order_idstringSystem generated order identification number"NXWA000987"
post/transactional/v1/cancelorders