淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
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。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
trace_id	String	可选	8uy7yfe		跟踪Id
sender_id	Number	可选	12313254452		卖家联系人地址库ID，可以通过taobao.logistics.address.search接口查询到地址库ID。如果为空，取的卖家的默认取货地址
ins_receiver_to	JzReceiverDto	可选			家装物流-安装收货人信息,如果为空,则取默认收货人信息
└ country String 可选中国国家 └ zip_code String 可选 310013 邮编 └ address String 可选 18号详细地址 └ mobile_phone String 可选 1234567890123 手机号 └ province String 可选浙江省省 └ city String 可选杭州市 └ contact_name String 可选张三收货人名称 └ street String 可选万塘路街道 └ district String 可选西湖区区 └ tele_phone String 可选 0571-88888888 座机号
sub_order_list	StoreConsignedResult []	可选		最大列表长度：20	子订单列表
└ attributes String 可选 {"key": "value"} 扩展字段 └ sub_oid Number 可选 123123123 子订单Id └ code String 可选 0 0表示无系统异常 └ logistic_company String 可选顺丰物流公司名称 └ logistic_company_code String 可选 SF 物流公司code，如果id和code都填入，以code为准。点点送：DISTRIBUTOR_12006531；门店自送：DISTRIBUTOR_12709653；如果是菜鸟配送，code和company可以为空 └ logistic_id String 可选 12345 物流公司id └ logistic_no String 可选 2343432111 物流单号 └ message String 可选 error 异常描述 └ operator String 可选小王操作者 └ package_id Number 可选 123234 速店通packageId └ store_id String 可选 13343 店铺Id, 可能是门店或者电商仓 └ store_name String 可选 XXX门店店铺名称 └ store_type String 可选 Store 店铺类型, 门店(Store)或者电商仓(Warehouse) └ tid Number 可选 1231243213213 主订单Id
jz_top_args	JzTopArgsDto	可选			家装物流-发货参数
└ mail_no String 可选 12321323 运单号,用快递或商家自有发货时,必填 └ package_volume String 可选 12 包裹体积 └ package_remark String 可选易碎物品包裹备注 └ zy_company String 可选新华物流自有物流公司名称 └ package_weight String 可选 2 包裹重量 └ zy_consign_time String 可选 2019-08-21 15:00:00 自有物流发货时间,时间不能早于当前时间 └ zy_phone_number String 可选 1236547890123 自有物流公司电话 └ package_number String 可选 2 包裹数量
ins_tp_dto	TpDto	可选			家装物流-安装公司信息,需要安装时,才填写
└ code String 可选 XBWL 公司编码 └ name String 可选新华物流公司名称
jz_receiver_to	JzReceiverDto	可选			家装物流-家装收货人信息,如果为空,则取默认收货信息
└ country String 可选中国国家 └ zip_code String 可选 310013 邮编 └ address String 可选 18号详细地址 └ mobile_phone String 可选 1234567890123 手机号 └ province String 可选浙江省省 └ city String 可选杭州市 └ contact_name String 可选张三收货人名称 └ street String 可选万塘路街道 └ district String 可选西湖区区 └ tele_phone String 可选 0571-88888888 座机号
tid	Number	必须	234234		淘宝交易主订单ID
report_timestamp	Number	必须	1469970719197		ISV系统上报时间
lg_tp_dto	TpDto	可选			家装物流-物流公司信息
└ code String 可选 XBWL 公司编码 └ name String 可选新华物流公司名称

名称	类型	示例值	描述
err_code	String	56	错误码
data	StoreConsignedResponse	data	data
└ short_id String 1 shortId └ mail_no String 123456 mailNo └ got_code String 1568 gotCode
message	String	xxuu	错误内容

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OmniorderStoreConsignedRequest req = new OmniorderStoreConsignedRequest();
req.setTraceId("8uy7yfe");
req.setSenderId(12313254452L);
OmniorderStoreConsignedRequest.JzReceiverDto obj1 = new OmniorderStoreConsignedRequest.JzReceiverDto();
obj1.setCountry("中国");
obj1.setZipCode("310013");
obj1.setAddress("18号");
obj1.setMobilePhone("1234567890123");
obj1.setProvince("浙江省");
obj1.setCity("杭州");
obj1.setContactName("张三");
obj1.setStreet("万塘路");
obj1.setDistrict("西湖区");
obj1.setTelePhone("0571-88888888");
req.setInsReceiverTo(obj1);
List<OmniorderStoreConsignedRequest.StoreConsignedResult> list3 = new ArrayList<OmniorderStoreConsignedRequest.StoreConsignedResult>();
OmniorderStoreConsignedRequest.StoreConsignedResult obj4 = new OmniorderStoreConsignedRequest.StoreConsignedResult();
list3.add(obj4);
obj4.setAttributes("{\"key\": \"value\"}");
obj4.setSubOid(123123123L);
obj4.setCode("0");
obj4.setLogisticCompany("顺丰");
obj4.setLogisticCompanyCode("SF");
obj4.setLogisticId("12345");
obj4.setLogisticNo("2343432111");
obj4.setMessage("error");
obj4.setOperator("小王");
obj4.setPackageId(123234L);
obj4.setStoreId("13343");
obj4.setStoreName("XXX门店");
obj4.setStoreType("Store");
obj4.setTid(1231243213213L);
req.setSubOrderList(list3);
OmniorderStoreConsignedRequest.JzTopArgsDto obj5 = new OmniorderStoreConsignedRequest.JzTopArgsDto();
obj5.setMailNo("12321323");
obj5.setPackageVolume("12");
obj5.setPackageRemark("易碎物品");
obj5.setZyCompany("新华物流");
obj5.setPackageWeight("2");
obj5.setZyConsignTime("2019-08-21 15:00:00");
obj5.setZyPhoneNumber("1236547890123");
obj5.setPackageNumber("2");
req.setJzTopArgs(obj5);
OmniorderStoreConsignedRequest.TpDto obj6 = new OmniorderStoreConsignedRequest.TpDto();
obj6.setCode("XBWL");
obj6.setName("新华物流");
req.setInsTpDto(obj6);
OmniorderStoreConsignedRequest.JzReceiverDto obj7 = new OmniorderStoreConsignedRequest.JzReceiverDto();
obj7.setCountry("中国");
obj7.setZipCode("310013");
obj7.setAddress("18号");
obj7.setMobilePhone("1234567890123");
obj7.setProvince("浙江省");
obj7.setCity("杭州");
obj7.setContactName("张三");
obj7.setStreet("万塘路");
obj7.setDistrict("西湖区");
obj7.setTelePhone("0571-88888888");
req.setJzReceiverTo(obj7);
req.setTid(234234L);
req.setReportTimestamp(1469970719197L);
OmniorderStoreConsignedRequest.TpDto obj8 = new OmniorderStoreConsignedRequest.TpDto();
obj8.setCode("XBWL");
obj8.setName("新华物流");
req.setLgTpDto(obj8);
OmniorderStoreConsignedResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OmniorderStoreConsignedRequest req = new OmniorderStoreConsignedRequest();
req.TraceId = "8uy7yfe";
req.SenderId = 12313254452L;
OmniorderStoreConsignedRequest.JzReceiverDtoDomain obj1 = new OmniorderStoreConsignedRequest.JzReceiverDtoDomain();
obj1.Country = "中国";
obj1.ZipCode = "310013";
obj1.Address = "18号";
obj1.MobilePhone = "1234567890123";
obj1.Province = "浙江省";
obj1.City = "杭州";
obj1.ContactName = "张三";
obj1.Street = "万塘路";
obj1.District = "西湖区";
obj1.TelePhone = "0571-88888888";
req.InsReceiverTo_ = obj1;
List<OmniorderStoreConsignedRequest.StoreConsignedResultDomain> list3 = new List<OmniorderStoreConsignedRequest.StoreConsignedResultDomain>();
OmniorderStoreConsignedRequest.StoreConsignedResultDomain obj4 = new OmniorderStoreConsignedRequest.StoreConsignedResultDomain();
list3.Add(obj4);
obj4.Attributes = "{\"key\": \"value\"}";
obj4.SubOid = 123123123L;
obj4.Code = "0";
obj4.LogisticCompany = "顺丰";
obj4.LogisticCompanyCode = "SF";
obj4.LogisticId = "12345";
obj4.LogisticNo = "2343432111";
obj4.Message = "error";
obj4.Operator = "小王";
obj4.PackageId = 123234L;
obj4.StoreId = "13343";
obj4.StoreName = "XXX门店";
obj4.StoreType = "Store";
obj4.Tid = 1231243213213L;
req.SubOrderList_ = list3;
OmniorderStoreConsignedRequest.JzTopArgsDtoDomain obj5 = new OmniorderStoreConsignedRequest.JzTopArgsDtoDomain();
obj5.MailNo = "12321323";
obj5.PackageVolume = "12";
obj5.PackageRemark = "易碎物品";
obj5.ZyCompany = "新华物流";
obj5.PackageWeight = "2";
obj5.ZyConsignTime = "2019-08-21 15:00:00";
obj5.ZyPhoneNumber = "1236547890123";
obj5.PackageNumber = "2";
req.JzTopArgs_ = obj5;
OmniorderStoreConsignedRequest.TpDtoDomain obj6 = new OmniorderStoreConsignedRequest.TpDtoDomain();
obj6.Code = "XBWL";
obj6.Name = "新华物流";
req.InsTpDto_ = obj6;
OmniorderStoreConsignedRequest.JzReceiverDtoDomain obj7 = new OmniorderStoreConsignedRequest.JzReceiverDtoDomain();
obj7.Country = "中国";
obj7.ZipCode = "310013";
obj7.Address = "18号";
obj7.MobilePhone = "1234567890123";
obj7.Province = "浙江省";
obj7.City = "杭州";
obj7.ContactName = "张三";
obj7.Street = "万塘路";
obj7.District = "西湖区";
obj7.TelePhone = "0571-88888888";
req.JzReceiverTo_ = obj7;
req.Tid = 234234L;
req.ReportTimestamp = 1469970719197L;
OmniorderStoreConsignedRequest.TpDtoDomain obj8 = new OmniorderStoreConsignedRequest.TpDtoDomain();
obj8.Code = "XBWL";
obj8.Name = "新华物流";
req.LgTpDto_ = obj8;
OmniorderStoreConsignedResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OmniorderStoreConsignedRequest;
$req->setTraceId("8uy7yfe");
$req->setSenderId("12313254452");
$ins_receiver_to = new JzReceiverDto;
$ins_receiver_to->country="中国";
$ins_receiver_to->zip_code="310013";
$ins_receiver_to->address="18号";
$ins_receiver_to->mobile_phone="1234567890123";
$ins_receiver_to->province="浙江省";
$ins_receiver_to->city="杭州";
$ins_receiver_to->contact_name="张三";
$ins_receiver_to->street="万塘路";
$ins_receiver_to->district="西湖区";
$ins_receiver_to->tele_phone="0571-88888888";
$req->setInsReceiverTo(json_encode($ins_receiver_to));
$sub_order_list = new StoreConsignedResult;
$sub_order_list->attributes="{\"key\": \"value\"}";
$sub_order_list->sub_oid="123123123";
$sub_order_list->code="0";
$sub_order_list->logistic_company="顺丰";
$sub_order_list->logistic_company_code="SF";
$sub_order_list->logistic_id="12345";
$sub_order_list->logistic_no="2343432111";
$sub_order_list->message="error";
$sub_order_list->operator="小王";
$sub_order_list->package_id="123234";
$sub_order_list->store_id="13343";
$sub_order_list->store_name="XXX门店";
$sub_order_list->store_type="Store";
$sub_order_list->tid="1231243213213";
$req->setSubOrderList(json_encode($sub_order_list));
$jz_top_args = new JzTopArgsDto;
$jz_top_args->mail_no="12321323";
$jz_top_args->package_volume="12";
$jz_top_args->package_remark="易碎物品";
$jz_top_args->zy_company="新华物流";
$jz_top_args->package_weight="2";
$jz_top_args->zy_consign_time="2019-08-21 15:00:00";
$jz_top_args->zy_phone_number="1236547890123";
$jz_top_args->package_number="2";
$req->setJzTopArgs(json_encode($jz_top_args));
$ins_tp_dto = new TpDto;
$ins_tp_dto->code="XBWL";
$ins_tp_dto->name="新华物流";
$req->setInsTpDto(json_encode($ins_tp_dto));
$jz_receiver_to = new JzReceiverDto;
$jz_receiver_to->country="中国";
$jz_receiver_to->zip_code="310013";
$jz_receiver_to->address="18号";
$jz_receiver_to->mobile_phone="1234567890123";
$jz_receiver_to->province="浙江省";
$jz_receiver_to->city="杭州";
$jz_receiver_to->contact_name="张三";
$jz_receiver_to->street="万塘路";
$jz_receiver_to->district="西湖区";
$jz_receiver_to->tele_phone="0571-88888888";
$req->setJzReceiverTo(json_encode($jz_receiver_to));
$req->setTid("234234");
$req->setReportTimestamp("1469970719197");
$lg_tp_dto = new TpDto;
$lg_tp_dto->code="XBWL";
$lg_tp_dto->name="新华物流";
$req->setLgTpDto(json_encode($lg_tp_dto));
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.omniorder.store.consigned' \
-d 'partner_id=apidoc' \
-d 'session=e321fa0a-bfbe-4969-8aa6-014479943690' \
-d 'sign=5BE403BB9BF11805F67DDFF4CAF856E2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+16%3A57%3A47' \
-d 'v=2.0' \
-d 'ins_receiver_to=null' \
-d 'ins_tp_dto=null' \
-d 'jz_receiver_to=null' \
-d 'jz_top_args=null' \
-d 'lg_tp_dto=null' \
-d 'report_timestamp=1469970719197' \
-d 'sender_id=12313254452' \
-d 'sub_order_list=null' \
-d 'tid=234234' \
-d 'trace_id=8uy7yfe'

# -*- coding: utf-8 -*-
import top.api

req=top.api.OmniorderStoreConsignedRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.trace_id="8uy7yfe"
req.sender_id=12313254452
req.ins_receiver_to=""
req.sub_order_list=""
req.jz_top_args=""
req.ins_tp_dto=""
req.jz_receiver_to=""
req.tid=234234
req.report_timestamp=1469970719197
req.lg_tp_dto=""
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"taobao.omniorder.store.consigned");
add_param(pRequest,"trace_id","8uy7yfe");
add_param(pRequest,"sender_id","12313254452");
add_param(pRequest,"ins_receiver_to","数据结构JSON示例");
add_param(pRequest,"sub_order_list","数据结构JSON示例");
add_param(pRequest,"jz_top_args","数据结构JSON示例");
add_param(pRequest,"ins_tp_dto","数据结构JSON示例");
add_param(pRequest,"jz_receiver_to","数据结构JSON示例");
add_param(pRequest,"tid","234234");
add_param(pRequest,"report_timestamp","1469970719197");
add_param(pRequest,"lg_tp_dto","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.omniorder.store.consigned', {
	'trace_id':'8uy7yfe',
	'sender_id':'12313254452',
	'ins_receiver_to':'数据结构JSON示例',
	'sub_order_list':'数据结构JSON示例',
	'jz_top_args':'数据结构JSON示例',
	'ins_tp_dto':'数据结构JSON示例',
	'jz_receiver_to':'数据结构JSON示例',
	'tid':'234234',
	'report_timestamp':'1469970719197',
	'lg_tp_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<omniorder_store_consigned_response>
    <err_code>56</err_code>
    <data>
        <short_id>1</short_id>
        <mail_no>123456</mail_no>
        <got_code>1568</got_code>
    </data>
    <message>xxuu</message>
</omniorder_store_consigned_response>

{
    "omniorder_store_consigned_response":{
        "err_code":"56",
        "data":{
            "short_id":"1",
            "mail_no":"123456",
            "got_code":"1568"
        },
        "message":"xxuu"
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案
NotIsvAllocateOrderOrIllegalAppKey	非ISV分单订单或AppKey非法	检查订单及商家appkey配置
0010	交易订单不存在	检查主订单号是否正确
0001	当前交易已有任务正在处理, 请稍候再试	请稍后重试
0017	订单发货失败	请稍后重试
0018	物流公司信息与时效订单约定不符	请按照omnichannel_param中RDCompanyCode出参传入logistic_company_code
0019	时效订单暂不支持拆单	发货时请传入该主订单下所有子订单
0020	门店Id与分单信息不符	请传入正确的storeId及storeType

API测试工具错误码查询工具 SDK下载

开放平台

全渠道API

taobao.omniorder.store.consigned (Pos端门店发货)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ