order-cancel

取消订单(terminus.wms.outbound.order.cancel)

业务场景：

异步取消创建的订单，用于拦截，有拦截失败概率。可以查询订单状态查看拦截情况

系统入参：

参数名称	类型	是否必填	说明
channelCode	String	是	请传入固定参数【SHIPPER_GRID】，参考请求示例

业务入参

参数名称	类型	是否必填	说明
thirdOutboundOrderCode	String	是	ShipperGrid订单号
reason	String	否	拦截原因

请求示例

public static void main(String[] args) {
        String appKey = "28cd819d0305402bb02e7d01091160c8";
        String secret = "xj1CnrTho1Bc1YSxaZa8ghdqRxwn079prFHqkjGXzdO64TQuy4aIzs06qv5htyXk";
        String url = "https://channelhub-uat.shippergrid.com/terminus/channelhub/api";
        ChannelClient client = new DefaultChannelClient( url, appKey, secret);
        //必填字段
        WmsOutboundOrderCancelRequest wmsRequest = new WmsOutboundOrderCancelRequest();
        wmsRequest.setChannelCode(OpenChannel.SHIPPER_GRID);
        wmsRequest.setReason("测试拦截");
        wmsRequest.setThirdOutboundOrderCode("OB20250508565966");
        WmsOutboundOrderCancelResponse channelResult = client.execute(wmsRequest);
        System.out.println(JSON.toJSONString(channelResult));
       if(!channelResult.isSuccess()) {
           // deal error
       }
        WmsOrderCancelStatusEnum operateResult = channelResult.getOperateResult();

    }

响应出参

参数名称	类型	是否必填	说明
operateResult	Integer	是	CANCELED(1, "取消成功"), INTERCEPT(2, "拦截中"), INTERCEPT_FAIL(3, "拦截失败")

成功响应示例

{
    "code": 200,
    "hasNext": false,
    "headerContent": {
        "traceId": "2025-05-08-11-14-08-545000000-67627f3c-95d5-47b3-b727-26bc3db22308",
        "sign": "4ab56439285f01d73056c14b01556850b09efb03e44055483f095e04ba9b7cac",
        "methodName": "terminus.wms.outbound.order.cancel",
        "appKey": "28cd819d0305402bb02e7d01091160c8",
        "Accept-Language": "zh_CN",
        "version": "1.0.0",
        "channelCode": "SHIPPER_GRID",
        "timestamp": "1746674048570"
    },
    "message": "success",
    "operateResult": "CANCELED",
    "requestId": "2025-05-08-11-14-08-545000000-67627f3c-95d5-47b3-b727-26bc3db22308",
    "requestUrl": "https://channelhub-uat.shippergrid.com/terminus/channelhub/api",
    "success": true,
    "totalCount": 0
}

异常响应示例

{
    "code":300,
    "data":null,
    "message":"系统异常",
    "success":false
}