4.4. 撤单
备注
订单是否可撤单受限于订单状态,具体规则参照 OrderStatus。
备注
撤单操作需要生成一个唯一ID,用于标识撤单请求 订单 ID 的介绍。
4.4.1. SDK 定义
@abc.abstractmethod
def cancel_order(self, order_id: str, origin_order_id: str, order_id_type: OrderIdType = OrderIdType.CLIENT) -> HttpResponse:
"""
撤单
:param order_id: 撤单请求 ID
:param origin_order_id: 被撤订单 ID
:param order_id_type: 订单 ID 类型, CLIENT 默认值/代表API订单ID,SNB代表雪盈订单ID
:return:
{
"msg": null,
"result_code": "60000",
"result_data": {
"id": "1711420371",
"status": "WITHDRAWED"
}
}
"""
pass
请求参数
参数名 |
类型 |
描述 |
是否必须 |
默认值 |
|---|---|---|---|---|
order_id |
string |
撤单请求 ID |
是 |
无 |
origin_order_id |
string |
被撤订单 ID |
是 |
无 |
order_id_type |
enum |
订单 ID 类型 OrderIdType |
否 |
CLIENT |
返回值
参数名 |
类型 |
描述 |
是否必须 |
默认值 |
|---|---|---|---|---|
id |
string |
撤单请求 ID |
是 |
无 |
status |
enum |
订单状态 OrderStatus |
是 |
无 |