Edit Basket Instrument

The method editBasketInstrument is used to edit the basket instrument present in the basket. In this we are able to edit the basket instrument details like quantity.

Endpoint: api/v1/basket/order
Method-Type: PUT

Request Packet

{
    "basket_id":"72fa28f8-7c08-4a4d-ba7a-fedd461744a1",
    "name":"h",
    "order_info":
    {
      "exchange":"NSE",
      "instrument_token":3045,
      "client_id":"DEMO1",
      "order_type":"LIMIT",
      "price":506.5,
      "quantity":1,
      "disclosed_quantity":0,
      "validity":"DAY",
      "product":"MIS",
      "trading_symbol":"SBIN-EQ",
      "order_side":"BUY",
      "user_order_id":10002,
      "underlying_token":"3045",
      "series":"EQ",
      "oms_order_id":"a5d13c1f-f99c-4230-ad19-9ed8e826ee74",
      "exchange_order_id":"",
      "trigger_price":0,
      "stop_loss_value":0,
      "square_off_value":0,
      "trailing_stop_loss":0,
      "is_trailing":false,
      "execution_type":"BO"
    },
  "order_id":"a5d13c1f-f99c-4230-ad19-9ed8e826ee74"
}

Parameters

FieldName	Datatype	Description
basket_id	String	Represents the unique id of basket.
name	String	Represents the name of the basket.
exchange	String	`NSE`, `BSE`, `NFO`, `MCX`
instrument_token	String	Represents unique id of a particular instrument.
client_id	String	Represents the unique id of user or username.
order_type	String	`LIMIT`, `SL`
price	String	It can’t be zero.
quantity	Number	It can’t be zero.
disclose_quantity	Number	It can’t be a negative number.
validity	String	`Day` or `IOC`
product	String	`CNC`, `MIS`, `NRML`
trading_symbol	String	Represents the name of the instrument.
order_side	String	`BUY` or `SELL`
user_order_id	Number	Unique id
underlying_token	Number	It is the token of the base equity instrument.
series	String	Represents the particular series based on exchange.
oms_order_id	String	Represents the unique id given by OMS.
exchange_order_id	String	Represents the unique id given by the exchange.
trigger_price	Number	It can’t be zero.
stop_loss_value	Number	It can’t be zero.
square_off_value	Number	It can’t be zero.
trailing_stop_loss	Number	It can’t be zero.
is_trailing	Boolean	`True` or `False`
execution_type	String	`REGULAR`, `BO`, `CO`, `AMO`
order_id	String	Represents the unique id of the order.

Example

data = pocket.editBasketInstrument({

    "basket_id":"72fa28f8-7c08-4a4d-ba7a-fedd461744a1",
    "name":"h",
    "order_info":
    {
      "exchange":"NSE",
      "instrument_token":3045,
      "client_id":"DEMO1",
      "order_type":"LIMIT",
      "price":506.5,
      "quantity":1,
      "disclosed_quantity":0,
      "validity":"DAY",
      "product":"MIS",
      "trading_symbol":"SBIN-EQ",
      "order_side":"BUY",
      "user_order_id":10002,
      "underlying_token":"3045",
      "series":"EQ",
      "oms_order_id":"a5d13c1f-f99c-4230-ad19-9ed8e826ee74",
      "exchange_order_id":"",
      "trigger_price":0,
      "stop_loss_value":0,
      "square_off_value":0,
      "trailing_stop_loss":0,
      "is_trailing":false,
      "execution_type":"BO"
    },
  "order_id":"a5d13c1f-f99c-4230-ad19-9ed8e826ee74"
})

Response

 {
  "data": {
    "basket_id": "9cd5fbc3-333b-4934-8d45-e692349b5ede",
    "basket_type": "NORMAL",
    "is_executed": false,
    "login_id": "<client id>",
    "name": "Y_Basket",
    "order_type": "LIMIT",
    "orders": [
      {
        "order_id": "d5950a9f-b538-458b-a3cd-1dec744cb931",
        "order_info": {
          "login_id": null,
          "order_status": null,
          "rejection_code": 0,
          "exchange": "NSE",
          "sl_trigger_price": 0,
          "client_id": "<client id>",
          "mode": "NEW",
          "product": "MIS",
          "rejection_reason": "",
          "order_side": "BUY",
          "market_protection_percentage": 0,
          "nnf_id": 0,
          "validity": "DAY",
          "trading_symbol": "IDEA-EQ",
          "trigger_price": 0,
          "is_trailing": false,
          "series": "EQ",
          "lot_size": 0,
          "leg_order_indicator": null,
          "disclosed_quantity": 0,
          "order_entry_time": 0,
          "sl_order_quantity": 0,
          "order_type": "LIMIT",
          "average_price": 0,
          "deposit": 0,
          "contract_description": {},
          "average_trade_price": 0,
          "oms_order_id": "",
          "filled_quantity": 0,
          "order_status_info": "",
          "trailing_stop_loss": null,
          "price": 0,
          "segment": "",
          "underlying_token": "14366",
          "sl_order_price": 0,
          "instrument_token": 14366,
          "trade_price": 0,
          "symbol": "",
          "target_price_type": "absolute",
          "execution_type": "REGULAR",
          "quantity": 1,
          "order_tag": "",
          "spread_token": null,
          "isin": "",
          "pro_cli": "CLIENT",
          "tags": [],
          "last_activity_reference": 0,
          "square_off_value": null,
          "remaining_quantity": 0,
          "square_off": false,
          "stop_loss_value": null,
          "exchange_order_id": "",
          "exchange_time": 0,
          "device": null,
          "user_order_id": 10002,
          "source": null
        }
      }
    ],
    "product_type": "ALL",
    "sip_eligible": false,
    "sip_enabled": false
  },
  "message": "Order added in the basket Y_Basket.",
  "status": "success"
}

Field Name	Description
basket_id	Unique identifier for the basket.
basket_type	Type of the basket.
is_executed	Indicates whether the basket has been executed.
login_id	Identifier for the user’s login.
name	Name of the basket.
order_type	Type of orders in the basket.
order_id	Unique identifier for the order.
exchange	Exchange where the order is placed.
client_id	Identifier for the order’s login.
mode	Mode of the order.
product	Product type associated with the order.
rejection_code	Code indicating reason for rejection.
rejection_reason	Reason for rejection of the order.
market_protection_percentage	Market protection percentage.
validity	Validity of the order.
trading_symbol	Symbol for the traded security.
trigger_price	Trigger price for the order.
is_trailing	Indicates if trailing stop loss is enabled.
series	Trading series.
lot_size	Lot size.
disclosed_quantity	Disclosed quantity.
order_entry_time	Time of order entry.
sl_order_quantity	Quantity of shares for stop loss order.
order_type	Type of the order.
average_price	Average price of filled shares.
deposit	Deposit amount.
average_trade_price	Average trade price.
filled_quantity	Quantity of shares filled.
order_status_info	Information about order status.
trailing_stop_loss	Trailing stop loss value.
price	Price specified for the order.
segment	Segment of the market.
underlying_token	Token for the traded security.
sl_order_price	Price for stop loss order.
instrument_token	Token for the traded security.
trade_price	Trade price.
symbol	Symbol for the traded security.
target_price_type	Type of target price.
execution_type	Type of execution.
quantity	Quantity of shares in the order.
order_tag	Order tag.
spread_token	Spread token.
isin	ISIN of the traded security.
pro_cli	Type of client.
tags	Additional tags for the order.
last_activity_reference	Reference for the last activity.
square_off_value	Value for square off.
remaining_quantity	Remaining quantity of shares.
square_off	Indicates if the order is square off.
stop_loss_value	Stop loss value for the order.
exchange_order_id	Exchange order ID.
exchange_time	Time of exchange order.
device	Device from which the order was placed.
user_order_id	User order ID.
source	Source of the order.
product_type	Type of product.
sip_eligible	Indicates if SIP (Systematic Investment Plan) is eligible for the basket.
sip_enabled	Indicates if SIP (Systematic Investment Plan) is enabled for the basket.
message	Information message related to the operation performed on the basket.
status	Status of the operation performed on the basket.

Error Response

 {
  "data": {},
  "error_code": 48004,
  "message": "`order_info` order price cannot be zero in SL/LIMIT order",
  "status": "error"
}