文档中心 > API类目 > 淘宝物流API

qimen.taobao.logistics.clearance.sign (关务加签)

关务推关务单加签

公共参数

请求地址：

环境	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	Request	可选			加签请求
└ resourceCode String 必须 STA 资源 Code（路由键，履行给关务） └ ownerCode String 必须 aAX766232 货主 Code（路由键，履行给关务） └ clearanceOrderCode String 必须 QG8877623 清关单编号 └ clearanceOrderType String 必须 1 单据类型 1 订单 2 支付单 3 运单 4 清单 5 撤销申请单 6 退货申请单 └ content String 必须 content 消息内容，泛化 XML └ companyCode String 必须 123 申报企业编码 └ extendProps Map 可选 - 扩展属性

响应参数

名称	类型	示例值	描述
response	Response		加签结果
└ signatureValue String 签名值签名值 └ keyName String 123 键值 └ certificate String ASDF certificate值 └ biz_error_msg String invalid app key 错误描述 └ biz_error_code String E0001 错误编码 └ success Boolean true 是否成功，true-成功; false-失败

请求示例

{"request":{"companyCode":"123","resourceCode":"STA","clearanceOrderType":"1","ownerCode":"aAX766232","extendProps":"-","content":"content","clearanceOrderCode":"QG8877623"}}

响应示例

{
    "response":{
        "signatureValue":"签名值",
        "keyName":"123",
        "certificate":"ASDF",
        "biz_error_msg":"invalid app key",
        "biz_error_code":"E0001",
        "success":true
    }
}

验签示例

{"response":{"biz_error_msg":"Illegal request","success":"不等于true","biz_error_code":"sign-check-failure"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部