Batch Cancel Orders

• POST /capi/v2/order/cancel_batch_orders

Weight(IP): 5, Weight(UID): 10

Request parameters

Parameter	Type	Required?	Description
symbol	String	Yes	Trading pair
ids	String[]	No	Either Order ID or cids is required.
cids	String[]	No	Either Client customized ID or ids is required.

Request example

curl -X POST "https://api-contract.weex.com/capi/v2/order/cancel_order" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*" \
   -H "ACCESS-PASSPHRASE:*" \
   -H "ACCESS-TIMESTAMP:1659076670000" \
   -H "locale:zh-CN" \
   -H "Content-Type: application/json" \
   -d '{"symbol":"cmt_bchusdt","ids": ["596471064624628269"]}'

Response parameters

Parameter	Type	Description
result	boolean	Processing result (success/failure)
symbol	string	Contract trading pair code
orderIds	List<String>	List of order IDs to be cancelled
clientOids	List<String>	List of client order IDs
cancelOrderResultList	List<CancelOrderResult>	List of cancellation results
failInfos	List<CancelOrderResult>	List of failed cancellation info

CancelOrderResult Fields:

Parameter	Type	Description
err_code	string	Error code if cancellation failed
err_msg	string	Error message if cancellation failed
order_id	string	Order ID
client_oid	string	Client order ID
result	boolean	Whether cancellation succeeded

Response example

{
  "result": true,
  "symbol": "cmt_bchusdt",
  "orderIds": ["596471064624628269"],
  "clientOids": [],
  "cancelOrderResultList": [
    {
      "err_code": "",
      "err_msg": "",
      "order_id": "596471064624628269",
      "client_oid": "",
      "result": true
    }
  ],
  "failInfos": []
}