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

cainiao.pickup.business.deliver (菜鸟商家寄件发货(呼叫运力))

外部系统可能会需要将菜鸟的下单和发货场景分开的情况：下单时确定包裹的订单号、运单号等，具备打印能力的商家能够自主打印电子面单并包装好包裹，发货时再真实呼叫裹裹运力，小件员上门履约。此API仅负责发货部分。

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
mobile	String	可选	13817778888		下单操作人的手机号，用作联系，可以不填写
consign_request_list	ConsignRequest []	必须		最大列表长度：20	发货时需提供的数据列表
└ td_order_id Number 可选 2087890029817215 订单号，下单接口返回给外部的裹裹寄件订单号

响应参数

名称	类型	示例值	描述
result	TdOpenServiceResult	{}	返回对象
data_list TdInterResult [] {} 返回对象 data ConsignOrderResponse {} 返回对象 └ td_order_id Number 2111230057266095 交易单 courier_info CourierInfo {} 小件员信息 └ phone_number String 95546 电话 └ cp_name String 韵达快递 cp名称 └ name String 菜鸟指定快递员姓名 └ success Boolean true 是否成功 └ identity String 2111230057266095 交易单号 └ status_code String error 错误码 └ status_message String 系统异常错误信息 └ success Boolean true 是否操作成功 └ retry Boolean false 是否需要重试 └ status_message String error 错误码 └ status_code String 系统异常错误信息

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessDeliverRequest req = new CainiaoPickupBusinessDeliverRequest();
req.setMobile("13817778888");
List<CainiaoPickupBusinessDeliverRequest.ConsignRequest> list2 = new ArrayList<CainiaoPickupBusinessDeliverRequest.ConsignRequest>();
CainiaoPickupBusinessDeliverRequest.ConsignRequest obj3 = new CainiaoPickupBusinessDeliverRequest.ConsignRequest();
list2.add(obj3);
obj3.setTdOrderId(2087890029817215L);
req.setConsignRequestList(list2);
CainiaoPickupBusinessDeliverResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessDeliverRequest req = new CainiaoPickupBusinessDeliverRequest();
req.Mobile = "13817778888";
List<CainiaoPickupBusinessDeliverRequest.ConsignRequestDomain> list2 = new List<CainiaoPickupBusinessDeliverRequest.ConsignRequestDomain>();
CainiaoPickupBusinessDeliverRequest.ConsignRequestDomain obj3 = new CainiaoPickupBusinessDeliverRequest.ConsignRequestDomain();
list2.Add(obj3);
obj3.TdOrderId = 2087890029817215L;
req.ConsignRequestList_ = list2;
CainiaoPickupBusinessDeliverResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessDeliverRequest;
$req->setMobile("13817778888");
$consign_request_list = new ConsignRequest;
$consign_request_list->td_order_id="2087890029817215";
$req->setConsignRequestList(json_encode($consign_request_list));
$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=cainiao.pickup.business.deliver' \
-d 'partner_id=apidoc' \
-d 'session=d9cf3a1c-5de2-4357-a42f-3b98189a3350' \
-d 'sign=6887F01E20E208DB9BA8285D70796CF2' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+19%3A25%3A45' \
-d 'v=2.0' \
-d 'consign_request_list=null' \
-d 'mobile=13817778888'

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

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

req.mobile="13817778888"
req.consign_request_list=""
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,"cainiao.pickup.business.deliver");
add_param(pRequest,"mobile","13817778888");
add_param(pRequest,"consign_request_list","数据结构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('cainiao.pickup.business.deliver', {
	'mobile':'13817778888',
	'consign_request_list':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<cainiao_pickup_business_deliver_response>
    <result>
        <data_list>
            <td_inter_result>
                <data>
                    <td_order_id>2111230057266095</td_order_id>
                    <courier_info>
                        <phone_number>95546</phone_number>
                        <cp_name>韵达快递</cp_name>
                        <name>菜鸟指定快递员</name>
                    </courier_info>
                </data>
                <success>true</success>
                <identity>2111230057266095</identity>
                <status_code>error</status_code>
                <status_message>系统异常</status_message>
            </td_inter_result>
        </data_list>
        <success>true</success>
        <retry>false</retry>
        <status_message>error</status_message>
        <status_code>系统异常</status_code>
    </result>
</cainiao_pickup_business_deliver_response>

{
    "cainiao_pickup_business_deliver_response":{
        "result":{
            "data_list":{
                "td_inter_result":[
                    {
                        "data":{
                            "td_order_id":2111230057266095,
                            "courier_info":{
                                "phone_number":"95546",
                                "cp_name":"韵达快递",
                                "name":"菜鸟指定快递员"
                            }
                        },
                        "success":true,
                        "identity":"2111230057266095",
                        "status_code":"error",
                        "status_message":"系统异常"
                    }
                ]
            },
            "success":true,
            "retry":false,
            "status_message":"error",
            "status_code":"系统异常"
        }
    }
}

异常示例

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工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

物流API

cainiao.pickup.business.deliver (菜鸟商家寄件发货(呼叫运力))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ