淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
content	BmsConsignOrderConfirm	可选			通知消息主体
tms_orders TmsOrders [] 可选 2672164342 运单信息列表 └ package_height Number 可选 245 包裹高度，单位：毫米 tms_items TmsItem [] 可选运单信息 └ item_quantity Number 可选 2 数量 └ item_code String 可选 SF889900002 前端商家编码 └ sc_item_id String 可选 af34q234q2 货品ID package_material_list PackageMaterialList [] 可选包裹的包材信息列表 └ material_quantity Number 可选 3 数量 └ material_type String 可选待定包材 └ package_width Number 可选 13300 包裹宽度，单位：毫米 └ package_length Number 可选 13400 包裹长度，单位：毫米 └ package_weight Number 可选 1280 包裹重量，单位：克 └ tms_order_code String 可选 32452452452 运单编码，运单号 └ tms_code String 可选 234234456 快递公司服务编码 └ package_code String 可选 21323490 包裹号 order_items OrderItems [] 可选订单商品信息列表 └ order_item_id Number 可选 201701030354135474 明细ID └ trade_id String 可选 2942788880724196 明细对应主单的交易单号 └ trade_item_id String 可选 2942788880724196 明细对应的子交易单号 └ item_tag String 可选 1001 默认：0；促销赠品1001 └ sc_item_id String 可选 10334384 货品id └ item_code String 可选 XJD22393 前端商家编码 └ item_quantity Number 可选 23 数量 └ item_amount Number 可选 12333 商品金额 123.33元，单位：分 └ item_id String 可选 23423 前端宝贝itemId └ sku_id String 可选 234234 前端skuId └ sc_item_code String 可选 CN234234 后端商家编码 └ order_post_fee Number 可选 500 邮费，以分为单位 └ order_amount Number 可选 12411 交易订单金额，以分为单位 └ consign_time String 可选 2016-11-11 11:11:11 仓库出库时间 └ store_order_code String 可选 LBX239423939439 仓库作业单号，LBX号 └ store_code String 可选 STORE_1002 发货仓的仓库编码 └ order_soruce Number 可选 0 0销售平台、1手工录入、2导入发货、3ERP推送 └ shop_id String 可选 2672164342 店铺id，主店铺时跟货主id相同 └ order_type Number 可选 201 操作子类型(201 一般交易出库单,502 换货出库单,503 补发出库单) └ erp_order_code String 可选 ERP2017011012345 out_biz_id，（非导入时为订单创建时的交易号） └ consign_code String 可选 BMC201612291026683018 每次发货均重新生成 └ order_code String 可选 BMS201612291026683018 BMS订单编码 └ owner_user_id String 可选 2672164342 货主id └ lg_order_code String 可选 LP00697146833384 发货lp

名称	类型	示例值	描述
result	ResultDO		返回值
└ error_msg String 错误信息网络延时 └ error_code String 错误码 01 └ success Boolean true 成功、失败

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoBmsOrderConsignConfirmRequest req = new CainiaoBmsOrderConsignConfirmRequest();
CainiaoBmsOrderConsignConfirmRequest.BmsConsignOrderConfirm obj1 = new CainiaoBmsOrderConsignConfirmRequest.BmsConsignOrderConfirm();
List<CainiaoBmsOrderConsignConfirmRequest.TmsOrders> list3 = new ArrayList<CainiaoBmsOrderConsignConfirmRequest.TmsOrders>();
CainiaoBmsOrderConsignConfirmRequest.TmsOrders obj4 = new CainiaoBmsOrderConsignConfirmRequest.TmsOrders();
list3.add(obj4);
obj4.setPackageHeight(245L);
List<CainiaoBmsOrderConsignConfirmRequest.TmsItem> list7 = new ArrayList<CainiaoBmsOrderConsignConfirmRequest.TmsItem>();
CainiaoBmsOrderConsignConfirmRequest.TmsItem obj8 = new CainiaoBmsOrderConsignConfirmRequest.TmsItem();
list7.add(obj8);
obj8.setItemQuantity(2L);
obj8.setItemCode("SF889900002");
obj8.setScItemId("af34q234q2");
list5.setTmsItems(list7);
List<CainiaoBmsOrderConsignConfirmRequest.PackageMaterialList> list11 = new ArrayList<CainiaoBmsOrderConsignConfirmRequest.PackageMaterialList>();
CainiaoBmsOrderConsignConfirmRequest.PackageMaterialList obj12 = new CainiaoBmsOrderConsignConfirmRequest.PackageMaterialList();
list11.add(obj12);
obj12.setMaterialQuantity(3L);
obj12.setMaterialType("待定");
list9.setPackageMaterialList(list11);
obj4.setPackageWidth(13300L);
obj4.setPackageLength(13400L);
obj4.setPackageWeight(1280L);
obj4.setTmsOrderCode("32452452452");
obj4.setTmsCode("234234456");
obj4.setPackageCode("21323490");
obj1.setTmsOrders(list3);
List<CainiaoBmsOrderConsignConfirmRequest.OrderItems> list14 = new ArrayList<CainiaoBmsOrderConsignConfirmRequest.OrderItems>();
CainiaoBmsOrderConsignConfirmRequest.OrderItems obj15 = new CainiaoBmsOrderConsignConfirmRequest.OrderItems();
list14.add(obj15);
obj15.setOrderItemId(201701030354135474L);
obj15.setTradeId("2942788880724196");
obj15.setTradeItemId("2942788880724196");
obj15.setItemTag("1001");
obj15.setScItemId("10334384");
obj15.setItemCode("XJD22393");
obj15.setItemQuantity(23L);
obj15.setItemAmount(12333L);
obj15.setItemId("23423");
obj15.setSkuId("234234");
obj15.setScItemCode("CN234234");
obj1.setOrderItems(list14);
obj1.setOrderPostFee(500L);
obj1.setOrderAmount(12411L);
obj1.setConsignTime("2016-11-11 11:11:11");
obj1.setStoreOrderCode("LBX239423939439");
obj1.setStoreCode("STORE_1002");
obj1.setOrderSoruce(0L);
obj1.setShopId("2672164342");
obj1.setOrderType(201L);
obj1.setErpOrderCode("ERP2017011012345");
obj1.setConsignCode("BMC201612291026683018");
obj1.setOrderCode("BMS201612291026683018");
obj1.setOwnerUserId("2672164342");
obj1.setLgOrderCode("LP00697146833384");
req.setContent(obj1);
CainiaoBmsOrderConsignConfirmResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoBmsOrderConsignConfirmRequest req = new CainiaoBmsOrderConsignConfirmRequest();
CainiaoBmsOrderConsignConfirmRequest.BmsConsignOrderConfirmDomain obj1 = new CainiaoBmsOrderConsignConfirmRequest.BmsConsignOrderConfirmDomain();
List<CainiaoBmsOrderConsignConfirmRequest.TmsOrdersDomain> list3 = new List<CainiaoBmsOrderConsignConfirmRequest.TmsOrdersDomain>();
CainiaoBmsOrderConsignConfirmRequest.TmsOrdersDomain obj4 = new CainiaoBmsOrderConsignConfirmRequest.TmsOrdersDomain();
list3.Add(obj4);
obj4.PackageHeight = 245L;
List<CainiaoBmsOrderConsignConfirmRequest.TmsItemDomain> list6 = new List<CainiaoBmsOrderConsignConfirmRequest.TmsItemDomain>();
CainiaoBmsOrderConsignConfirmRequest.TmsItemDomain obj7 = new CainiaoBmsOrderConsignConfirmRequest.TmsItemDomain();
list6.Add(obj7);
obj7.ItemQuantity = 2L;
obj7.ItemCode = "SF889900002";
obj7.ScItemId = "af34q234q2";
obj4.TmsItems= list6;
List<CainiaoBmsOrderConsignConfirmRequest.PackageMaterialListDomain> list9 = new List<CainiaoBmsOrderConsignConfirmRequest.PackageMaterialListDomain>();
CainiaoBmsOrderConsignConfirmRequest.PackageMaterialListDomain obj10 = new CainiaoBmsOrderConsignConfirmRequest.PackageMaterialListDomain();
list9.Add(obj10);
obj10.MaterialQuantity = 3L;
obj10.MaterialType = "待定";
obj4.PackageMaterialList= list9;
obj4.PackageWidth = 13300L;
obj4.PackageLength = 13400L;
obj4.PackageWeight = 1280L;
obj4.TmsOrderCode = "32452452452";
obj4.TmsCode = "234234456";
obj4.PackageCode = "21323490";
obj1.TmsOrders= list3;
List<CainiaoBmsOrderConsignConfirmRequest.OrderItemsDomain> list12 = new List<CainiaoBmsOrderConsignConfirmRequest.OrderItemsDomain>();
CainiaoBmsOrderConsignConfirmRequest.OrderItemsDomain obj13 = new CainiaoBmsOrderConsignConfirmRequest.OrderItemsDomain();
list12.Add(obj13);
obj13.OrderItemId = 201701030354135474L;
obj13.TradeId = "2942788880724196";
obj13.TradeItemId = "2942788880724196";
obj13.ItemTag = "1001";
obj13.ScItemId = "10334384";
obj13.ItemCode = "XJD22393";
obj13.ItemQuantity = 23L;
obj13.ItemAmount = 12333L;
obj13.ItemId = "23423";
obj13.SkuId = "234234";
obj13.ScItemCode = "CN234234";
obj1.OrderItems= list12;
obj1.OrderPostFee = 500L;
obj1.OrderAmount = 12411L;
obj1.ConsignTime = "2016-11-11 11:11:11";
obj1.StoreOrderCode = "LBX239423939439";
obj1.StoreCode = "STORE_1002";
obj1.OrderSoruce = 0L;
obj1.ShopId = "2672164342";
obj1.OrderType = 201L;
obj1.ErpOrderCode = "ERP2017011012345";
obj1.ConsignCode = "BMC201612291026683018";
obj1.OrderCode = "BMS201612291026683018";
obj1.OwnerUserId = "2672164342";
obj1.LgOrderCode = "LP00697146833384";
req.Content_ = obj1;
CainiaoBmsOrderConsignConfirmResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoBmsOrderConsignConfirmRequest;
$content = new BmsConsignOrderConfirm;
$tms_orders = new TmsOrders;
$tms_orders->package_height="245";
$tms_items = new TmsItem;
$tms_items->item_quantity="2";
$tms_items->item_code="SF889900002";
$tms_items->sc_item_id="af34q234q2";
$tms_orders->tms_items = $tms_items;
$package_material_list = new PackageMaterialList;
$package_material_list->material_quantity="3";
$package_material_list->material_type="待定";
$tms_orders->package_material_list = $package_material_list;
$tms_orders->package_width="13300";
$tms_orders->package_length="13400";
$tms_orders->package_weight="1280";
$tms_orders->tms_order_code="32452452452";
$tms_orders->tms_code="234234456";
$tms_orders->package_code="21323490";
$content->tms_orders = $tms_orders;
$order_items = new OrderItems;
$order_items->order_item_id="201701030354135474";
$order_items->trade_id="2942788880724196";
$order_items->trade_item_id="2942788880724196";
$order_items->item_tag="1001";
$order_items->sc_item_id="10334384";
$order_items->item_code="XJD22393";
$order_items->item_quantity="23";
$order_items->item_amount="12333";
$order_items->item_id="23423";
$order_items->sku_id="234234";
$order_items->sc_item_code="CN234234";
$content->order_items = $order_items;
$content->order_post_fee="500";
$content->order_amount="12411";
$content->consign_time="2016-11-11 11:11:11";
$content->store_order_code="LBX239423939439";
$content->store_code="STORE_1002";
$content->order_soruce="0";
$content->shop_id="2672164342";
$content->order_type="201";
$content->erp_order_code="ERP2017011012345";
$content->consign_code="BMC201612291026683018";
$content->order_code="BMS201612291026683018";
$content->owner_user_id="2672164342";
$content->lg_order_code="LP00697146833384";
$req->setContent(json_encode($content));
$resp = $c->execute($req);

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=cainiao.bms.order.consign.confirm' \
-d 'partner_id=apidoc' \
-d 'sign=C4BAFCBE6F0FF253A9C636B123837EEF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-16+22%3A57%3A10' \
-d 'v=2.0' \
-d 'content=null'

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

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

req.content="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	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,"cainiao.bms.order.consign.confirm");
add_param(pRequest,"content","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
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('cainiao.bms.order.consign.confirm', {
	'content':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<result>
    <error_msg>错误信息</error_msg>
    <error_code>错误码</error_code>
    <success>true</success>
</result>

{
    "result":{
        "error_msg":"错误信息",
        "error_code":"错误码",
        "success":true
    }
}

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"
	}
}

错误码	错误描述	解决方案

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

开放平台

物流宝

cainiao.bms.order.consign.confirm (BMS出库通知)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ