Order Status

PURPOSE

The purpose of this method is to navigate the status of an order placed by the client based on client code and other Order Status Request List parameters such as Exchange, Exchange segment, Scrip code and Remote Order ID. Like other APIs, this will only run in active session when the customer is logged in and will return the status of the order on successful execution. The response will also consist of detailed list as mentioned in parameters of the Order request against the OrderID and will give details of the quantity that has been traded and the order quantity pending as of the request time. It will throw an error message along with the status of the request, if there are discrepancies or lack of information or any other conflicting scenario.

Request URL

https://dataservice.iifl.in/openapi/prod/OrderStatus

Request Method: POST

Request format: JSON

Request Header:

Content-Type: application/json

Ocp-Apim-Subscription-Key:
to be provided after registration

REQUEST BODY

HEADER

Field Name Description Data Type
(max length)		 Validation Sample Value
appName App Name provided at the time of registration String Cannot be empty. IIFLMarDEMO
appVer Developer App Version String Cannot be empty. 1.0
key UserKey generated at the time of registration String Cannot be empty. ABpyyGUh1nsbesSlup3VKURkI4tQDe8y
osName Channel of order String Cannot be empty. WEB, Android, iOS
requestCode Request Code of the API called String Cannot be empty. IIFLMarRQOrdStatus
userId User ID generated at the time of registration String Cannot be empty. ZkhghN5uKj
password Password generated at the time of registration String Cannot be empty. lfjnfS7rHGj

BODY

Field Name Description Data Type
(max length)		 Validation Sample Value
ClientCode Client code for whom order is being placed. String(15) Cannot be empty. Dummy123
OrdStatusReqList List Of OrderStatusReqList List Of OrderStatusReqList - -

ORDERSTATUSREQLIST

Field Name Description Data Type
(max length)		 Validation Sample Value
Exch Exchange in which order has been placed. N- NSE, B- BSE, M - MCX, N - NCDEX Char Cannot be empty N
ExchType Exchange segment. C - Cash, D - Derivative/MCX, U - Currency, Y - NSE/BSE Commodity, X - NCDEX Char Cannot be empty C
ScripCode Scrip Code of the requested order Long Cannot be empty 438
RemoteOrderID For NSE/BSE Cash/Derivative/Currency pass RemoteOrderId

For MCX, NCDEX, NSE Commodity, BSE Commodity pass BrokerOrderId		 String Cannot be empty S0123466789

REQUEST:

{
  "head": {
    "appName": "IIFLMarDEMO",
    "appVer": "1.0",
    "key": "ABpyyGUh1nsbesSlup3VKURkI4tQDe8y",
    "osName": "Android",
    "requestCode": "IIFLMarRQOrdStatus",
    "userId": "mocZueK622W",
    "password": "UjR1ElLwSzr"
  },
  "body": {
    "ClientCode": "Dummy123",
    "OrdStatusReqList": [
      {
        "Exch": "N",
        "ExchType": "C",
        "ScripCode": 4717,
        "RemoteOrderID": "S123456789123456789"
      }
    ]
  }
}

RESPONSE BODY

HEADER

Field Name Description Data Type
(max length)		 List of Values Sample Value
responseCode This is the response code of API String - IIFLMarRQLoginForVendor
status This is the response code of API String 0
2 		0
statusDescription This is the response code of API String 0 - Success
2 - Invalid head parameters		 Success
responseCode This is the response code of API String - IIFLMarRQLoginForVendor

BODY

Field Name Description Data Type
(max length)		 List of values Sample Value
Status Returns the status of the response. Integer -1 = Exception
0 = success
1=No Record Found
2- Invalid Input/ head parameters
9-“Invalid Session”		 0
Message Trade Details of that particular client Array Of OrdStatusResLst Array Of OrdStatusResLst -

ORDER STATUS LIST

FieldName Type Description
Exch Char Exchange in which order has been Placed. N- NSE, B-BSE, M-MCX
ExchType Char Exchange segment C-Cash, D-Derivatives, U-Currency
ScripCode Int32 Scrip Code of the particular stock
Symbol String Symbol of the scrip.
OrderQty Int32 Returns order quantity
OrderRate Double Returns order rate
ExchOrderID Int32 Order ID given by Exchange to an order.
Status String Returns the status of the response.
TradedQty Int32 Returns Traded Qty of an order.
PendingQty Int32 Returns Pending Qty of an order.

Success Response

{
  "head": {
    "responseCode": "IIFLMarRQOrdStatus",
    "status": "0",
    "statusDescription": "Success"
  },
  "body": {
    "Message": "",
    "OrdStatusResLst": [
      {
        "Exch": "N",
        "ExchOrderID": 1100000000031379,
        "ExchOrderTime": "/Date(1557136685000+0530)/",
        "ExchType": "C",
        "OrderQty": 5,
        "OrderRate": 350,
        "PendingQty": 0,
        "ScripCode": 4717,
        "Status": "Placed",
        "Symbol": "GAIL",
        "TradedQty": 5
      }
    ],
    "Status": 0
  }
}