文档中心 > API类目 > 阿里健康API

qimen.alibaba.alihealth.wms.order.callback (配拦截-拦截指令下发)

下发配送拦截指令给服务商，需要同步返回承诺拦截结果（实物拦截结果通过回告接口）。

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
request	OrderCallbackRequest	可选			请求
└ deliveryOrderCode String 可选 C123 发货单号 └ expressCode String 可选 123456789 运单号 └ orderId String 可选 C123 订单ID └ ownerCode String 可选 C123 货主编码 └ warehouseCode String 可选 C123 仓库编码 └ extendProps String 可选 {"key":"value"} 请求扩展属性;map返回结构

响应参数

名称	类型	示例值	描述
response	OrderCallbackResponse		返回
└ success Boolean true 是否成功: true-成功; false-失败 └ bizErrorCode String E0001 错误编码 └ bizErrorMsg String invalid app key 错误描述 └ extendProps String {"key":"value"} 扩展属性;map返回结构

请求示例

{"request":{"orderId":"C123","ownerCode":"C123","expressCode":"123456789","extendProps":"{\"key\":\"value\"}","deliveryOrderCode":"C123","warehouseCode":"C123"}}

响应示例

{
    "response":{
        "success":true,
        "bizErrorCode":"E0001",
        "bizErrorMsg":"invalid app key",
        "extendProps":"{\"key\":\"value\"}"
    }
}

验签示例

{"response":{"bizErrorMsg":"Illegal request","success":"false","bizErrorCode":"sign-check-failure"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部