文档中心 > API类目 > 天猫供应链

qimen.taobao.logistics.express.capacity.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输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
supplier_id	String	必须	10000000001		服务商ID
biz_request_id	String	必须	xxxxx		业务请求ID（服务商发起请求的ID）
delivery_code	String	必须	STO-001		服务商配资源唯一编码
success	Boolean	必须	true		true\|false
biz_code	String	可选	200		响应码
biz_message	String	可选	SUCCESS		响应信息
address_ids	AddressIdResults []	可选		最大列表长度：99999	当地址传入方式为菜鸟地址库ID传入时，则必须填写地址id（数组）；四级/三级/二级
└ address_id String 可选 330110005 地址id └ error_message String 可选错误原因错误原因 └ error_code String 可选 ADDRESS_UNKNOWN 错误码
address_names	AddressNameResults []	可选		最大列表长度：99999	当地址传入方式为详细地址时填写
└ province String 可选浙江省省 └ city String 可选杭州市市 └ area String 可选余杭区区 └ town String 可选五常街道街道 └ error_message String 可选错误原因错误原因 └ error_code String 可选 ADDRESS_UNKNOWN 错误码
region_id_results	RegionIdResults []	可选		最大列表长度：99999	地理围栏（经纬度），电子围栏最多5000个点（数组）
└ latitude String 可选 120.21201 经度（高德） └ longitude String 可选 30.2084 纬度（高德） └ error_message String 可选错误原因错误原因 └ error_code String 可选 ADDRESS_UNKNOWN 错误码
region_code	String	可选	region-001		电子围栏外部ID，只会返回错误的电子围栏外部id
daily_capacity_infos	DailyCapacityInfos []	可选		最大列表长度：999	日常产能信息
└ error_message String 可选错误信息错误信息 └ error_code String 可选 code 错误码 └ capacity Number 可选 100 时间段产能（单），表示时间段内可揽可上门单数 └ time_range String 可选 01:00-02:00 单位时间段（整点小时段，HH:MM-HH:MM）
specify_capacity_infos	SpecifyCapacityInfos []	可选		最大列表长度：999	指定日期产能信息
└ error_message String 可选错误信息错误信息 └ error_code String 可选 code 错误码 specify_date_capacity SpecifyDateCapacity [] 可选指定日期时间段产能 └ capacity Number 可选 100 时间段产能（单），表示时间段内可揽可上门单数 └ time_range String 可选 01:00-02:00 单位时间段（整点小时纬度，HH:MM-HH:MM） └ specify_date String 可选 2023-08-16 指定日期，YYYY-MM-DD
ability_type	String	可选	1		1 - 上门取退 2 - 送货上门
service_type	String	可选	1		1 - 上门取退 2 - 送货上门

响应参数

名称	类型	示例值	描述
success	Boolean	true	true\|false
error_code	String	100001	错误码
error_message	String	系统错误	系统错误

请求示例

{"address_ids":[{"error_message":"错误原因","address_id":"330110005","error_code":"ADDRESS_UNKNOWN"}],"biz_code":"200","specify_capacity_infos":[{"error_message":"错误信息","error_code":"code","specify_date_capacity":[{"time_range":"01:00-02:00","capacity":100}],"specify_date":"2023-08-16"}],"service_type":"1","delivery_code":"STO-001","region_id_results":[{"error_message":"错误原因","latitude":"120.21201","error_code":"ADDRESS_UNKNOWN","longitude":"30.2084"}],"biz_request_id":"xxxxx","success":true,"biz_message":"SUCCESS","ability_type":"1","supplier_id":"10000000001","address_names":[{"area":"余杭区","error_message":"错误原因","province":"浙江省","town":"五常街道","city":"杭州市","error_code":"ADDRESS_UNKNOWN"}],"region_code":"region-001","daily_capacity_infos":[{"error_message":"错误信息","time_range":"01:00-02:00","error_code":"code","capacity":100}]}

响应示例

{
    "success":true,
    "error_code":"100001",
    "error_message":"系统错误"
}

验签示例

{"error_message":"Illegal request","success":"false","error_code":"sign-check-failure"}

错误码解释

错误码	错误描述	解决方案
response-body-parse-error

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

天猫供应链

qimen.taobao.logistics.express.capacity.callback (上门取退产能同步/更新结果回告)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ