Skip to main content

CANCEL ALL ORDERS​

This API enables cancellation of multiple orders for authorized end users through a middleware-based integration.

Orders can be cancelled individually by specifying order identifiers or in bulk based on the value of the cancellation flag.

🔍 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 Parameters​

FieldTypeRequiredDescriptionExample
ordersarray of stringsNoList of orders to be cancelled. Each entry should contain the Exchange Segment and Order ID.`["NSE_EQ
flagbooleanYesFlag indicating whether all eligible orders should be cancelled or only the specified orders.true
product_sourcestringNoSource of the order. Allowed values: WEBAPI, MOBILEAPI (case-insensitive). Any other value is ignored without an error."WEBAPI"

🟢 Success Response - 200 OK​

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"Order cancellation request processed successfully"
dataarrayOrder-wise cancellation statusRefer Data Object Fields

📦 Data Object Fields​

FieldTypeDescriptionExample
statusstringStatus of order cancellation"CANCELLED"
messagestringOrder-specific response message"Order cancelled successfully"
order_idstringOrder identifier"NXVZO00098K1"

📝 Notes​

  • Allows cancellation of multiple orders in a single request.
  • If flag is set to:
    • true → All eligible open/pending orders are cancelled.
    • false → Only the orders specified in the orders array are cancelled.
  • Each order is processed independently and returns its own cancellation status.