淘宝开放平台

请求地址：

环境	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	DeliveryPackageQueryRequest	必须			请求参数
└ openUserId String 可选 123 淘宝平台用户id └ mailNos String [] 可选 1,2,3 物流单号数组 ["SF4352453","YZ25745335"] └ outerWarehouseId String 可选 123 集运仓id └ startTime Number 可选 1640683589996 预报开始时间 └ endTime Number 可选 1640683568946 预报结束时间 └ pageNo Number 可选 0 页码从1开始 └ pageSize Number 可选 20 页大小 └ status Number [] 可选需要查询的状态列表

名称	类型	示例值	描述
data	DeliveryPackageQueryResponse		业务响应
deliveryPackageList DeliveryPackage [] 待集运包裹也就是预报单列表 └ openUserId String 123 淘宝平台用户ID └ outerWarehouseId String 123 集运仓id └ outerUserId String 123 外部会员ID（集运仓地址后缀识别码） └ status Number 100 WAIT_INBOUND(100, "等待仓库入库"), INBOUND_FAIL(-200, "入库异常"), INBOUND_SUCCESS(200,"入库成功"), MERGED(300,"已合单"), OUTBOUND(350,"已出库")，CANCELED(-100,"已取消")，TRANSFER(-400,"转寄"), DESTROY(-500,"销毁") └ mailNo String SF12345 物流单号 └ unpack Boolean false 是否拆包 true表示拆包，仓库会拆包称重 ,false不拆包仅回传包裹信息 └ occurTime Number 1640748165910 业务发生的时间戳（状态变更时间） ms └ inboundExceptionCode String SIGN_FAIL 入库异常原因编码 SIGN_FAIL( "仓库拒收"), UN_KNOW_FAIL("未知异常") └ inboundExceptionDesc String 仓库拒收入库异常时候填写异常原因 └ logisticProperties String [] 物流属性数组示例值 ["has_battery"] 枚举如下： NORMAL("normal", "普货"), HAS_BATTERY("has_battery", "含电"), ONLY_BATTERY("battery", "纯电"), COSMETIC("cosmetic", "非液体化妆品"), SPECIAL_GOODS("special_goods", "特货"), CONTRABAND("contraband", "禁运"), LARGE("large", "大件"), LIQUID("liquid", "液体"), MAGNETIC("magnetic", "磁性"), ELECTRIC("electric", "带电"), PLANTS_ANIMALS("plants_animals", "动植物活体"), FOOD("food", "食品"), POWDER("powder", "粉末"), DANGER("danger", "危险品"), POLICY_LIMIT("policy_limit", "政策限制"), PURE_ELECTRIC("pure_electric", "纯电"), FRAGILE("fragile", "易碎品"), MEDICINE("medicine", "药品"), HEALTH_PRODUCT("health_product", "保健品"), SEX_AIDS("sex_aids", "性用品") logisticInfo LogisticInfo 拆包前包裹信息 └ height Number 10 包裹高 cm └ weight Number 100 包裹重 g └ length Number 10 包裹长 cm └ width Number 10 包裹宽 cm unPackedLogisticInfo LogisticInfo 拆包后包裹信息 └ height Number 10 包裹高 cm └ weight Number 100 包裹重 g └ length Number 10 包裹长 cm └ width Number 10 包裹宽 cm goodsList PackageGoods [] 商品列表 └ skuName String test good 商品名称 └ quantity Number 1 商品数量 └ payAmount Number 10 实际支付金额（单价：分） └ price Number 1 商品单价（单价：分） └ skuCode String fga534325 平台商品 skuCode 非淘宝sku id └ categoryId String 45 叶子类目id └ categoryName String 卫衣叶子类目名称 verifyInfoList VerifyInfo [] 质检结果信息列表 └ resultCode String success 质检结果code，成功(success)/失败(fail) └ picUrls String [] - 图片url数组 ["url1","url2"] └ resultDesc String 质检成功质检结果描述 └ packageSource Number 1 包裹类型：1:千帆下单包裹，2:集运商录入包裹 └ ovsFreePost Boolean false 是否包邮，true代表包邮，false代表不包邮 └ total Number 100 总数 └ pageSize Number 20 页大小 └ pageNo Number 0 当前页从0开始
success	Boolean	true	接口调用成功失败 true/false
failMessage	String	系统错误	错误信息
failCode	String	1100	错误码

{
    "data":{
        "deliveryPackageList":[
            {
                    "openUserId":"123",
                    "outerWarehouseId":"123",
                    "outerUserId":"123",
                    "status":100,
                    "mailNo":"SF12345",
                    "unpack":false,
                    "occurTime":1640748165910,
                    "inboundExceptionCode":"SIGN_FAIL",
                    "inboundExceptionDesc":"仓库拒收",
                    "logisticInfo":{
                        "height":10,
                        "weight":100,
                        "length":10,
                        "width":10
                    },
                    "unPackedLogisticInfo":{
                        "height":10,
                        "weight":100,
                        "length":10,
                        "width":10
                    },
                    "goodsList":[
                        {
                                "skuName":"test good",
                                "quantity":1,
                                "payAmount":10,
                                "price":1,
                                "skuCode":"fga534325",
                                "categoryId":"45",
                                "categoryName":"卫衣"
                        }
                    ],
                    "verifyInfoList":[
                        {
                                "resultCode":"success",
                                "picUrls":{
                                    "string":[
                                        "-"
                                    ]
                                },
                                "resultDesc":"质检成功"
                        }
                    ],
                    "packageSource":1,
                    "ovsFreePost":false
            }
        ],
        "total":100,
        "pageSize":20,
        "pageNo":0
    },
    "success":true,
    "failMessage":"系统错误",
    "failCode":"1100"
}

{"success":"false","failCode":"sign-check-failure","failMessage":"Illegal request"}

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

错误码查询工具 SDK下载

千帆计划

qimen.alibaba.ovs.delivery.package.query (集运包裹预报单查询)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ