淘宝开放平台

请求地址：

环境	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	必须			请求参数
└ mailNo String 必须 464756865867 物流单号 └ traceId String 必须 234352344353423 平台日志id 用于平台排查问题 └ deliveryTime Number 可选 1641388997529 一段订单发货时间时间戳 ms goodsList PackageGoodsDTO [] 可选商品列表 └ skuName String 可选 test good 商品名称 └ quantity Number 可选 1 数量 └ payAmount Number 可选 23 实际支付金额单价分 └ price Number 可选 21 单价分 └ skuCode String 可选 564535242 平台商品 skuCode 非淘宝sku id └ categoryId String 可选 2435324 叶子类目id └ categoryName String 可选卫衣叶子类目名称 └ picUrl String 可选 - 图片URL └ itemId String 可选 2343523443534 商品id └ unpack Boolean 必须 true 是否拆包 true表示拆包，仓库会拆包称重 ,false不拆包仅回传包裹信息 └ openUserId String 必须 43453463634 平台买家id 淘宝用户id加密不可逆 └ outerWarehouseId String 可选 WH001 集运仓仓库编码 └ hasAppended Boolean 可选 false 说明有追加信息，集运商需要判断该字段如果为true, 则支持多次写入，更新旧数据，而且多次写入都成功。如初次预报商品为3A+B，后面再次预报时当前字段为true, 商品为 4A+B+C , 则需要把最新商品写入。其他字段信息也类似，此处不再列举 └ orderType Number 可选 1 订单类型，0为非跨境订单，1为跨境订单 └ receiveAddress String 可选尧均村均安路4号 (23946) 收件人地址 └ receiveName String 可选 michelleli612（23946）收件人姓名 └ packageType Number 可选 1 包裹类型：1:淘宝下单（千帆+淘宝历史包裹），2:外部包裹录入 └ siteMarketCode String 可选 MY 淘宝买家站点市场编码。市场列表如下： TW(中国台湾), SG(新加坡), MY(马来), VN(越南), JP(日本), KR(韩国), HK(中国香港), MO(中国澳门), CA(加拿大), TH(泰国), KH(柬埔寨), AU(澳大利亚) └ ipMarketCode String 可选 CA 淘宝买家ip所对应市场编码。市场列表见上面字段siteMarketCode描述部分 └ businessType String 可选 bizSelect 业务类型： bizSelect("集运优选"), bizSuggest("集运推荐"); 如果不传则默认为bizSelect └ freePost Boolean 可选 false 是否包邮仅当前字段为true才是包邮订单为false则不是包邮订单 receiverContactInfo ReceiverContactInfo 可选收件人相关信息（直送和海外地址集运模式会下发该字段） certificateInfo CertificateInfo 可选证件信息 └ idNumber String 可选 543252587264624 证件号 └ idType String 可选 id_card 证件类型如id_card代表身份证 └ countryCode String 可选 CN 国家二字简码 └ email String 可选 - 邮箱 └ zip String 可选 - 邮编 └ phone String 可选 - 固话 └ mobileNo String 可选 - 手机号 └ name String 可选萧何姓名 └ addressDetail String 可选大公路909号详细地址 └ street String 可选五常街道街道 └ district String 可选余杭区区 └ city String 可选杭州市市 └ state String 可选浙江省 └ country String 可选中国国家名称 certificateInfoList CertificateInfoDTO [] 可选证件号列表，用于兼容多种证件号 └ idType String 可选 id_card 证件类型如id_card代表身份证、passport代表护照、还有pin_code、national_id、taxpayer_code、fin_code └ idNumber String 可选 543252587264624 证件号 └ selfPickupCode String 可选 ZT01 自提点编码（配送方式为自提时使用。该值为集运商在淘宝的自提点管理页维护的值） └ logisticServiceCode String 可选 P5353526 服务产品（渠道）外部编码，该值为集运商在淘宝服务产品页维护的值 └ shippingType String 可选 PICKUP_IN_STORES 配送方式（HOME_DELIVERY("送货上门"), PICKUP_IN_STORES("自提");

名称	类型	示例值	描述
success	Boolean	false	接口成功失败标示 true/false
failCode	String	1100	错误码
failMessage	String	系统异常	错误信息
data	OvsResponseDataDTO		返回业务数据
└ success Boolean false 业务成功还是失败

{"request":{"traceId":"234352344353423","orderType":1,"freePost":false,"logisticServiceCode":"P5353526","deliveryTime":0,"receiveAddress":"尧均村均安路4号 (23946)","goodsList":[{"skuName":"test good","picUrl":"-","itemId":"2343523443534","quantity":1,"payAmount":23,"price":21,"categoryName":"卫衣","skuCode":"564535242","categoryId":"2435324"}],"shippingType":"PICKUP_IN_STORES","siteMarketCode":"MY","outerWarehouseId":"WH001","openUserId":"43453463634","packageType":1,"mailNo":"464756865867","hasAppended":false,"receiveName":"michelleli612（23946）","receiverContactInfo":{"zip":"-","country":"中国","city":"杭州市","mobileNo":"-","certificateInfo":{"idType":"id_card","idNumber":"543252587264624"},"addressDetail":"大公路909号","phone":"-","countryCode":"CN","street":"五常街道","district":"余杭区","name":"萧何","state":"浙江","email":"-","certificateInfoList":[{"idType":"id_card","idNumber":"543252587264624"}]},"unpack":true,"businessType":"bizSelect","selfPickupCode":"ZT01","ipMarketCode":"CA"}}

{
    "success":false,
    "failCode":"1100",
    "failMessage":"系统异常",
    "data":{
        "success":false
    }
}

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

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

错误码查询工具 SDK下载

千帆计划

qimen.alibaba.ovs.delivery.package.create (集运包裹预报)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ