文档中心 > API类目 > 奇门仓储API

taobao.qimen.order.cancel (单据取消接口)

taobao.qimen.order.cancel

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request OrderCancelRequest 可选
  • └ warehouseCode
  • String
  • 必须
  • W1234
  • 仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER)
  • └ ownerCode
  • String
  • 可选
  • H1234
  • 货主编码
  • └ orderCode
  • String
  • 必须
  • O1234
  • 单据编码
  • └ orderId
  • String
  • 可选
  • WQ1234
  • 仓储系统单据编码
  • └ orderType
  • String
  • 可选
  • JYCK
  • 单据类型(JYCK=一般交易出库单;HHCK= 换货出库;BFCK=补发出库;PTCK=普通出库单;DBCK=调拨出库;B2BRK=B2B入库;B2BCK=B2B出库;QTCK=其他出库;SCRK=生产入库;LYRK=领用入库;CCRK=残次品入库;CGRK=采购入库;DBRK= 调拨入库;QTRK=其他入库;XTRK= 销退入库;THRK=退货入库;HHRK= 换货入库;CNJG= 仓内加工单;CGTH=采购退货出库单)
  • └ cancelReason
  • String
  • 可选
  • 已经退货
  • 取消原因
  • └ extendProps
  • Map
  • 可选
  • 扩展属性
  • subSourceOrders
  • SubSourceOrder []
  • 可选
  • 交易平台子订单信息
  • └ subSourceOrderCode
  • String
  • 可选
  • 21324234
  • 交易平台子订单编码

响应参数

名称 类型 示例值 描述
response OrderCancelResponse
  • └ flag
  • String
  • success
  • 响应结果:success|failure
  • └ code
  • String
  • 0
  • 响应码
  • └ message
  • String
  • invalid appkey
  • 响应信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
QimenClient client = new DefaultQimenClient(url, appkey, secret);
OrderCancelRequest req = new OrderCancelRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setWarehouseCode("W1234");
req.setOwnerCode("H1234");
req.setOrderCode("O1234");
req.setOrderId("WQ1234");
req.setOrderType("JYCK");
req.setCancelReason("已经退货");
req.setRemark("备注");
List<SubSourceOrder> list2 = new ArrayList<SubSourceOrder>();
SubSourceOrder obj3 = new SubSourceOrder();
list2.add(obj3);
obj3.setSubSourceOrderCode("21324234");
req.setSubSourceOrders(list2);
OrderCancelResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<response>
    <flag>success</flag>
    <code>0</code>
    <message>invalid appkey</message>
</response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案
isp.http-connection-timeout
isp.http-connection-refuse
isp.http-read-timeout
isp.http-closed

API工具

如何获得此API

FAQ

返回
顶部