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

qimen.taobao.logistics.express.accessible.query (上门取退收货地可达结果查询接口)

上门取退收货地可达结果查询

公共参数

请求地址：

环境	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输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	描述
supplier_id	String	必须	12341567891022	12341567891022 服务商ID
delivery_code	String	必须	TTWL001	配资源编码
receiver	ReceiverDTO	必须		收件人地址信息
└ province String 必须四川收件人省 └ city String 可选成都收件人市 └ district String 可选高新收件人区 └ town String 可选文一西路收件人乡镇/街道 └ address String 必须四川省成都市高新区新航路283号收件人详细地址 └ address_id String 必须 67991 67991 行政地址ID（菜鸟地址库id）

响应参数

名称	类型	示例值	描述
success	Boolean	true	系统成功失败
error_code	String	10004	错误码
error_message	String	系统错误	错误信息
is_retry	Boolean	true	是否可重试
data	TmsAccessibleQueryResponse		业务处理结果
└ is_accessible Boolean true 可达/不可达

请求示例

{"delivery_code":"TTWL001","receiver":{"address":"四川省成都市高新区新航路283号","province":"四川","town":"文一西路","city":"成都","district":"高新","address_id":"67991"},"sender":{"address":"四川省成都市高新区新航路283号","province":"四川","town":"文一西路","city":"成都","district":"高新","address_id":"67991"},"supplier_id":"12341567891022"}

响应示例

{
    "success":true,
    "error_code":"10004",
    "error_message":"系统错误",
    "is_retry":true,
    "data":{
        "is_accessible":true
    }
}

验签示例

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部