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

qimen.taobao.logistics.express.order.create (TMS配订单创建)

TMS配订单创建，下发到TMS，给到配订单信息，快递公司进行取件配送流程

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
biz_code	String	必须	234234234234		单号标识
pick_date	String	可选	2023-02-20		取件日期
pick_time_range	String	可选	09:00-11:00		取件的时间范围
item_list	ItemsDO []	必须		最大列表长度：50	包裹商品列表
item_info ItemInfoDO 必须商品信息 └ item_name String 必须毛衣商品名称 └ sku_name String 可选白色毛衣商品sku信息 └ check_items Boolean 可选 false 默认值：false 是否需要核验，核验商品品类、颜色、数量、外观 └ leaf_category_name String 必须服饰叶子类目信息描述 └ item_num Number 必须 2 商品数量 └ extend_fields String 可选 key1:values;key2:value2 扩展属性
receiver	ReceiverDO	必须			收件人信息
└ name String 必须李某收件人姓名 └ phone String 可选 024-88888888 收件人座机号 └ mobile String 可选 15111111111 收件人电话号码 └ province String 必须四川收件人省 └ city String 可选成都收件人市 └ district String 可选高新区收件人区 └ street String 可选文艺街道收件人街道 └ area_id String 必须 688444 地址id └ address String 必须四川省成都市高新区新航路283号收件人详细地址 └ zip_code String 可选 6500000 邮编
remark	String	可选	11点前上面取件		备注
sender	SenderDO	必须			发件人信息
└ name String 必须李某发件人姓名 └ phone String 可选 024-88888888 发件人座机号 └ mobile String 可选 15111111111 发件人电话号码 └ province String 必须四川发件人省 └ city String 可选成都发件人市 └ district String 可选高新区发件人区 └ street String 可选文艺街道发件人街道 └ area_id String 必须 688444 地址id └ address String 必须四川省成都市高新区新航路283号发件人详细地址 └ zip_code String 可选 6500000 邮编 └ privacy_phone_flag Boolean 必须 false 默认值：false 是否为座机号虚拟号标识 └ privacy_mobile_flag Boolean 必须 false 默认值：false 是否为手机号虚拟号标识 └ latitude String 可选维度 123.000000 └ longitude String 可选经度 123.000000
insure_amount	Number	可选	199		保价金额,此商品明细的总保价金额,单位分
supplier_id	String	可选	12341567891022		服务商id
delivery_code	String	可选	TTWL001		配资源编码
sender_requirement	String	可选	1		寄件人服务要求（枚举），以英文逗号隔开 1-需要包装 2-需要带胶带 3-上门时安静 4-不要打电话 5-已放家门口 6-已放水表箱
platform_requirement	String	可选	UnpaidAssignment		平台服务要求（枚举），以英文逗号隔开 UnpaidNoAssignment-未支付不支持走件 UnpaidAssignment-未支付支持走件
feature	FeatureDO	可选			扩展字段
└ pick_code String 可选 ***3 加密后取件码 └ mail_no String 可选 6789212312 运单号
service_type	String	可选	11		1-上门取退、3-预售极速达、11-驿站自寄

响应参数

名称	类型	示例值	描述
success	Boolean	true	系统成功失败 true\|false
error_code	String	100001	错误码
error_message	String	系统错误	错误信息
is_retry	Boolean	true	是否可重试
data	DataDO		数据内容
└ out_order_code String 32423424 服务商订单号

请求示例

{"biz_code":"234234234234","receiver":{"address":"四川省成都市高新区新航路283号","province":"四川","phone":"024-88888888","city":"成都","street":"文艺街道","district":"高新区","name":"李某","mobile":"15111111111","area_id":"688444","zip_code":"6500000"},"platform_requirement":"UnpaidAssignment","insure_amount":199,"sender_requirement":"1","remark":"11点前上面取件","service_type":"11","delivery_code":"TTWL001","feature":{"mail_no":"6789212312","pick_code":"***3"},"sender":{"address":"四川省成都市高新区新航路283号","city":"成都","privacy_mobile_flag":false,"latitude":"维度","mobile":"15111111111","area_id":"688444","zip_code":"6500000","privacy_phone_flag":false,"province":"四川","phone":"024-88888888","street":"文艺街道","district":"高新区","name":"李某","longitude":"经度"},"pick_time_range":"09:00-11:00","item_list":[{"item_info":{"leaf_category_name":"服饰","check_items":false,"item_name":"毛衣","sku_name":"白色毛衣","extend_fields":"key1:values;key2:value2","item_num":2}}],"pick_date":"2023-02-20","supplier_id":"12341567891022"}

响应示例

{
    "success":true,
    "error_code":"100001",
    "error_message":"系统错误",
    "is_retry":true,
    "data":{
        "out_order_code":"32423424"
    }
}

验签示例

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

淘天物流API

qimen.taobao.logistics.express.order.create (TMS配订单创建)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ