Batch Cancel Order
batchCancelOrder
Input Parameters
| Parameter | Type | Meaning |
|---|---|---|
| account | Account | Account |
| orderResult | orderResult | Order result object to cancel |
Result
| Parameter | Type | Meaning |
|---|---|---|
| isSuccess | bool | Whether successful |
| data | Object | Modified content is returned |
| message | string ? (optional) | Error message returned when isSuccess = false |
OrderResult Parameter
Return type : Object
| Parameter | Type | Meaning |
|---|---|---|
| functionType | number | Function Type : 0 New Order, 10 New Order Executed, 15 Change Price, 20 Change Quantity, 30 Cancel, 90 Failed |
| date | string | Transaction date |
| seqNo | string | Order serial number |
| branchNo | string | Branch number |
| account | string | Account |
| orderNo | string | Order number |
| assetType | number | Asset type : 0 Stock |
| market | string | Market type : TAIEX Listed, TAISDAQ OTC, TAIEMG EMG |
| marketType | js:string / ts:MarketType | Trading session type : Common, Fixing, IntradayOdd, Odd, Emg, EmgOdd |
| stockNo | string | Symbol |
| buySell | js:string / ts:BSAction | Buy/Sell Type : Buy, Sell |
| priceType | js:string / ts:PriceType | Original order price type : Limit, LimitUp, LimitDown, Market, Reference |
| price | number | Order Price |
| quantity | number | Original order quantity |
| timeInForce | js:string / ts:TimeInForce | Time In Force ROD, FOK, IOC |
| orderType | js:string / ts:OrderType | Order Type : Stock, Margin, Short Short sale, DayTrade, SBL |
| isPreOrder | bool | Reservation Flag |
| status | number | Order status, for details please refer to STATUS |
| afterPriceType | js:string / ts:PriceType | Valid order price type : Limit, LimitUp, LimitDown, Market, Reference |
| afterPrice | number | Valid order price |
| unit | number | Trading Unit |
| afterQty | number | Valid Order Quantity (filled quantity included) |
| filledQty | number | Filled Quantity |
| filledMoney | number | Filled Value |
| beforeQty | number | Before the Quantity Modification |
| beforePrice | number | Before the Price Modification |
| user_def | string | Custom Fields |
| lastTime | string | Last Modification Time |
| details | list | Order Process (Return value when query orderResultDetail or orderHistory ) |
| errorMessage | string | Error Message |
Request Example
// Batch price modification using the batch-detail response
cancel_object = [
batch_results_detail.data[0],
batch_results_detail.data[1],
]
sdk.stock.batchCancelOrder(account, cancel_object)
// Batch quantity modification ( Using different individual orders )
cancel_object = [
orders[37],
orders[35],
]
sdk.stock.batchCancelOrder(account, cancel_object)
Response Example
{
isSuccess: true,
data:
{
functionType: 30, // Function Type (number)
date: '2024/03/08', // Transaction Date (string)
seqNo: '00000308998', // Order sequence number (string)
branchNo: '6460', // Branch code (string)
account: '26', // Account (string)
orderNo: 'x0028', // Order Number (string)
assetType: 0, // Asset Type (number)
market: 'TAIEX', // Market Type (string)
marketType: 'Common', // Trading session type (string)
stockNo: '1101', // Symbol (string)
buySell: 'Sell', // Buy/sell side (string)
priceType: 'Limit', // Original order price type (string)
price: 41.2, // Price (number)
quantity: 5000, // Original Order Quantity (number)
timeInForce: 'ROD', // Time in force (string)
orderType: 'Stock', // Order type (string)
isPreOrder: false, // Reservation Order Flag (bool)
status: 30, // Order Status (number)
afterPriceType: 'Limit', // Valid order price type (string)
afterPrice: 41.2, // Valid Order Price (number)
unit: 1000, // Trading unit (number)
afterQty: 0, // Valid Order Quantity (number)
filledQty: 0, // Filled Quantity (number)
filledMoney: 0, // Filled Value (number)
beforeQty: 5000, // Before the Quantity Modification (number)
beforePrice: 41.2, // Before the Price Modification (number)
userDef: '12345678', // Custom Fields (string)
lastTime: '12:53:57.536', // Last Modification Time (string)
errorMessage: '', // Error message (string)
},
{
functionType: 30, // Function Type (number)
date: '2024/03/08', // Transaction Date (string)
seqNo: '0000030899', // Order sequence number (string)
branchNo: '6460', // Branch code (string)
account: '26', // Account (string)
orderNo: 'x0029', // Order Number (string)
assetType: 0, // Asset Type (number)
market: 'TAIEX', // Market Type (string)
marketType: 'Common', // Trading session type (string)
stockNo: '1101', // Symbol (string)
buySell: 'Sell', // Buy/sell side (string)
priceType: 'Limit', // Original order price type (string)
price: 41.2, // Price (number)
quantity: 5000, // Original Order Quantity (number)
timeInForce: 'ROD', // Time in force (string)
orderType: 'Stock', // Order type (string)
isPreOrder: false, // Reservation Order Flag (bool)
status: 30, // Order Status (number)
...
}
}