淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
appointment_create_request	AppointmentCreateRequest	可选			预约单创建入参
└ zone_off_set String 必须 +8 时区 └ seller_id Number 必须 2206729397105 商家id sender_info ContactInfoRequest 必须发货人信息 └ country String 可选 xxxxx 国家 └ zip_code String 可选 xxxxx 邮编 └ area_id Number 可选 1111 地区id └ province String 可选 xxxxx 省份 └ phone String 必须 xxxxx 电话 └ city String 可选 xxxxx 城市 └ company_name String 可选 xxxxx 公司 └ name String 必须 xxxxx 名称 └ detail_address String 可选 xxxxx 详细地址（最大135个字符） └ email String 必须 xxxxx 邮箱 └ country_id Number 可选 101 国家id receiver_info ContactInfoRequest 必须预约大包信息列表（自送快递和自送卡车非必填） └ country String 可选 xxxxx 国家 └ zip_code String 可选 xxxxx 邮编 └ area_id Number 可选 1111 地区id └ province String 可选 xxxxx 省份 └ phone String 必须 xxxxx 电话 └ city String 可选 xxxxx 城市 └ company_name String 可选 xxxxx 公司 └ name String 必须 xxxxx 名称 └ detail_address String 必须 xxxxx 详细地址（最大135个字符） └ email String 可选 xxxxx 邮箱 └ country_id Number 可选 101 国家id handover_content_synopsis_list OrderHandoverContentSynopsisDTO [] 可选预约大包信息列表（（非自寄模式必填） └ count Number 可选 1 数量（非自寄模式必填） └ content_type String 可选 TRAY 预约大包类型：TRAY：托，SACK：麻袋（非自寄模式必填） └ content_type_name String 可选托预约大包类型名称：托、麻袋（非自寄模式必填） self_send_express_info_request SelfSendExpressInfoRequest 可选自寄快递请求参数（自寄快递模式必填） └ express_number String 可选 LP124545 快递运单号（自寄快递模式必填） └ express_company String 可选德邦快递公司（自寄快递模式必填） └ expected_arrive_time Number 可选 16545454 预计送达时间（自寄快递模式必填） └ expected_pickup_time Number 可选 16545454 预计揽收时间（自寄快递模式必填） └ store_name String 可选羊飞韩国集货测试仓接收仓资源名称 pickup_info PickupInfo 可选揽收信息（（非自寄模式必填） └ country String 可选意大利国家 └ zip_code String 可选 xxxxx 邮编 └ city String 可选 xxxxx 城市 └ company_name String 可选 xxxxx 公司（非自寄模式必填） └ resource_name String 可选 xxxxx 资源名称 └ country_id Number 可选 101 国家id（非自寄模式必填） └ area_id Number 可选 919800020043000000 菜鸟地址id（非自寄模式必填） └ resource_code String 可选 xxxxx 资源code（非自寄模式必填） └ province String 可选 xxxxx 省份 └ phone String 可选 xxxxx 电话（非自寄模式必填） └ name String 可选 xxxxx 名称（非自寄模式必填） └ detail_address String 可选 xxxxx 详细地址（最大135个字符）（非自寄模式必填） └ email String 可选 xxxxx 邮箱（非自寄模式必填） self_send_truck_info_request SelfMailTruckInfoRequest 可选自寄卡车参数（自寄卡车模式必填） └ driver_name String 可选 jiang feng 司机姓名 └ expected_arrive_time Number 可选 548547851445 预计送达时间（自寄卡车模式必填） └ driver_mobile_phone String 可选 13065487706 司机手机号 └ expected_pickup_time Number 可选 548547851445 预计揽收时间（自寄卡车模式必填） └ truck_num String 可选 xxxxx 车牌（自寄卡车模式必填） └ pickup_type String 必须 TRAN_STORE_30396858 揽收方式：TRUCK（卡车）OFFLINE_EXPRESS(自寄快递) OFFLINE_TRUCK(自派卡车) └ store_code String 必须 TRAN_STORE_30396858 接收仓资源编码 └ lg_order_list String [] 可选 [LP23232] 小包信息（自寄模式必填）

名称	类型	示例值	描述
hsf_result	HsfResult		hsfResult
appointment_create_response AppointmentCreateResponse data └ handover_order_id Number 1001 预约单id └ handover_order_code String RWXXXX 预约单code └ success Boolean false success └ error_code String xxxxx errorCode └ internal_error_code String P-088-0000-00-15-401 internalErrorCode └ error_msg String createAppointmentOrder Lp exist error errorMsg └ ext_error_map String "LP_STATUS_ABNORMAL": [ "LP00552256342023" ] 错误扩展信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest req = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest();
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.AppointmentCreateRequest obj1 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.AppointmentCreateRequest();
obj1.setZoneOffSet("+8");
obj1.setSellerId(2206729397105L);
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.ContactInfoRequest obj2 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.ContactInfoRequest();
obj2.setCountry("xxxxx");
obj2.setZipCode("xxxxx");
obj2.setAreaId(1111L);
obj2.setProvince("xxxxx");
obj2.setPhone("xxxxx");
obj2.setCity("xxxxx");
obj2.setCompanyName("xxxxx");
obj2.setName("xxxxx");
obj2.setDetailAddress("xxxxx");
obj2.setEmail("xxxxx");
obj2.setCountryId(101L);
obj1.setSenderInfo(obj2);
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.ContactInfoRequest obj3 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.ContactInfoRequest();
obj3.setCountry("xxxxx");
obj3.setZipCode("xxxxx");
obj3.setAreaId(1111L);
obj3.setProvince("xxxxx");
obj3.setPhone("xxxxx");
obj3.setCity("xxxxx");
obj3.setCompanyName("xxxxx");
obj3.setName("xxxxx");
obj3.setDetailAddress("xxxxx");
obj3.setEmail("xxxxx");
obj3.setCountryId(101L);
obj1.setReceiverInfo(obj3);
List<CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.OrderHandoverContentSynopsisDTO> list5 = new ArrayList<CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.OrderHandoverContentSynopsisDTO>();
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.OrderHandoverContentSynopsisDTO obj6 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.OrderHandoverContentSynopsisDTO();
list5.add(obj6);
obj6.setCount(1L);
obj6.setContentType("TRAY");
obj6.setContentTypeName("托");
obj1.setHandoverContentSynopsisList(list5);
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.SelfSendExpressInfoRequest obj7 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.SelfSendExpressInfoRequest();
obj7.setExpressNumber("LP124545");
obj7.setExpressCompany("德邦");
obj7.setExpectedArriveTime(16545454L);
obj7.setExpectedPickupTime(16545454L);
obj1.setSelfSendExpressInfoRequest(obj7);
obj1.setStoreName("羊飞韩国集货测试仓");
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.PickupInfo obj8 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.PickupInfo();
obj8.setCountry("意大利");
obj8.setZipCode("xxxxx");
obj8.setCity("xxxxx");
obj8.setCompanyName("xxxxx");
obj8.setResourceName("xxxxx");
obj8.setCountryId(101L);
obj8.setAreaId(919800020043000000L);
obj8.setResourceCode("xxxxx");
obj8.setProvince("xxxxx");
obj8.setPhone("xxxxx");
obj8.setName("xxxxx");
obj8.setDetailAddress("xxxxx");
obj8.setEmail("xxxxx");
obj1.setPickupInfo(obj8);
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.SelfMailTruckInfoRequest obj9 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.SelfMailTruckInfoRequest();
obj9.setDriverName("jiang feng");
obj9.setExpectedArriveTime(548547851445L);
obj9.setDriverMobilePhone("13065487706");
obj9.setExpectedPickupTime(548547851445L);
obj9.setTruckNum("xxxxx");
obj1.setSelfSendTruckInfoRequest(obj9);
obj1.setPickupType("TRAN_STORE_30396858");
obj1.setStoreCode("TRAN_STORE_30396858");
obj1.setLgOrderList("LP23232");
req.setAppointmentCreateRequest(obj1);
CainiaoGlobalImPickupAppointmentOrderInfoCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest req = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest();
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.AppointmentCreateRequestDomain obj1 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.AppointmentCreateRequestDomain();
obj1.ZoneOffSet = "+8";
obj1.SellerId = 2206729397105L;
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.ContactInfoRequestDomain obj2 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.ContactInfoRequestDomain();
obj2.Country = "xxxxx";
obj2.ZipCode = "xxxxx";
obj2.AreaId = 1111L;
obj2.Province = "xxxxx";
obj2.Phone = "xxxxx";
obj2.City = "xxxxx";
obj2.CompanyName = "xxxxx";
obj2.Name = "xxxxx";
obj2.DetailAddress = "xxxxx";
obj2.Email = "xxxxx";
obj2.CountryId = 101L;
obj1.SenderInfo= obj2;
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.ContactInfoRequestDomain obj3 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.ContactInfoRequestDomain();
obj3.Country = "xxxxx";
obj3.ZipCode = "xxxxx";
obj3.AreaId = 1111L;
obj3.Province = "xxxxx";
obj3.Phone = "xxxxx";
obj3.City = "xxxxx";
obj3.CompanyName = "xxxxx";
obj3.Name = "xxxxx";
obj3.DetailAddress = "xxxxx";
obj3.Email = "xxxxx";
obj3.CountryId = 101L;
obj1.ReceiverInfo= obj3;
List<CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.OrderHandoverContentSynopsisDTODomain> list5 = new List<CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.OrderHandoverContentSynopsisDTODomain>();
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.OrderHandoverContentSynopsisDTODomain obj6 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.OrderHandoverContentSynopsisDTODomain();
list5.Add(obj6);
obj6.Count = 1L;
obj6.ContentType = "TRAY";
obj6.ContentTypeName = "托";
obj1.HandoverContentSynopsisList= list5;
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.SelfSendExpressInfoRequestDomain obj7 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.SelfSendExpressInfoRequestDomain();
obj7.ExpressNumber = "LP124545";
obj7.ExpressCompany = "德邦";
obj7.ExpectedArriveTime = 16545454L;
obj7.ExpectedPickupTime = 16545454L;
obj1.SelfSendExpressInfoRequest= obj7;
obj1.StoreName = "羊飞韩国集货测试仓";
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.PickupInfoDomain obj8 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.PickupInfoDomain();
obj8.Country = "意大利";
obj8.ZipCode = "xxxxx";
obj8.City = "xxxxx";
obj8.CompanyName = "xxxxx";
obj8.ResourceName = "xxxxx";
obj8.CountryId = 101L;
obj8.AreaId = 919800020043000000L;
obj8.ResourceCode = "xxxxx";
obj8.Province = "xxxxx";
obj8.Phone = "xxxxx";
obj8.Name = "xxxxx";
obj8.DetailAddress = "xxxxx";
obj8.Email = "xxxxx";
obj1.PickupInfo= obj8;
CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.SelfMailTruckInfoRequestDomain obj9 = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest.SelfMailTruckInfoRequestDomain();
obj9.DriverName = "jiang feng";
obj9.ExpectedArriveTime = 548547851445L;
obj9.DriverMobilePhone = "13065487706";
obj9.ExpectedPickupTime = 548547851445L;
obj9.TruckNum = "xxxxx";
obj1.SelfSendTruckInfoRequest= obj9;
obj1.PickupType = "TRAN_STORE_30396858";
obj1.StoreCode = "TRAN_STORE_30396858";
obj1.LgOrderList = "LP23232";
req.AppointmentCreateRequest_ = obj1;
CainiaoGlobalImPickupAppointmentOrderInfoCreateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGlobalImPickupAppointmentOrderInfoCreateRequest;
$appointment_create_request = new AppointmentCreateRequest;
$appointment_create_request->zone_off_set="+8";
$appointment_create_request->seller_id="2206729397105";
$sender_info = new ContactInfoRequest;
$sender_info->country="xxxxx";
$sender_info->zip_code="xxxxx";
$sender_info->area_id="1111";
$sender_info->province="xxxxx";
$sender_info->phone="xxxxx";
$sender_info->city="xxxxx";
$sender_info->company_name="xxxxx";
$sender_info->name="xxxxx";
$sender_info->detail_address="xxxxx";
$sender_info->email="xxxxx";
$sender_info->country_id="101";
$appointment_create_request->sender_info = $sender_info;
$receiver_info = new ContactInfoRequest;
$receiver_info->country="xxxxx";
$receiver_info->zip_code="xxxxx";
$receiver_info->area_id="1111";
$receiver_info->province="xxxxx";
$receiver_info->phone="xxxxx";
$receiver_info->city="xxxxx";
$receiver_info->company_name="xxxxx";
$receiver_info->name="xxxxx";
$receiver_info->detail_address="xxxxx";
$receiver_info->email="xxxxx";
$receiver_info->country_id="101";
$appointment_create_request->receiver_info = $receiver_info;
$handover_content_synopsis_list = new OrderHandoverContentSynopsisDTO;
$handover_content_synopsis_list->count="1";
$handover_content_synopsis_list->content_type="TRAY";
$handover_content_synopsis_list->content_type_name="托";
$appointment_create_request->handover_content_synopsis_list = $handover_content_synopsis_list;
$self_send_express_info_request = new SelfSendExpressInfoRequest;
$self_send_express_info_request->express_number="LP124545";
$self_send_express_info_request->express_company="德邦";
$self_send_express_info_request->expected_arrive_time="16545454";
$self_send_express_info_request->expected_pickup_time="16545454";
$appointment_create_request->self_send_express_info_request = $self_send_express_info_request;
$appointment_create_request->store_name="羊飞韩国集货测试仓";
$pickup_info = new PickupInfo;
$pickup_info->country="意大利";
$pickup_info->zip_code="xxxxx";
$pickup_info->city="xxxxx";
$pickup_info->company_name="xxxxx";
$pickup_info->resource_name="xxxxx";
$pickup_info->country_id="101";
$pickup_info->area_id="919800020043000000";
$pickup_info->resource_code="xxxxx";
$pickup_info->province="xxxxx";
$pickup_info->phone="xxxxx";
$pickup_info->name="xxxxx";
$pickup_info->detail_address="xxxxx";
$pickup_info->email="xxxxx";
$appointment_create_request->pickup_info = $pickup_info;
$self_send_truck_info_request = new SelfMailTruckInfoRequest;
$self_send_truck_info_request->driver_name="jiang feng";
$self_send_truck_info_request->expected_arrive_time="548547851445";
$self_send_truck_info_request->driver_mobile_phone="13065487706";
$self_send_truck_info_request->expected_pickup_time="548547851445";
$self_send_truck_info_request->truck_num="xxxxx";
$appointment_create_request->self_send_truck_info_request = $self_send_truck_info_request;
$appointment_create_request->pickup_type="TRAN_STORE_30396858";
$appointment_create_request->store_code="TRAN_STORE_30396858";
$appointment_create_request->lg_order_list="[LP23232]";
$req->setAppointmentCreateRequest(json_encode($appointment_create_request));
$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.global.im.pickup.appointment.order.info.create' \
-d 'partner_id=apidoc' \
-d 'sign=8F1ED5BF78A49346D57B2D6812757B06' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-23+20%3A32%3A02' \
-d 'v=2.0' \
-d 'appointment_create_request=null'

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

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

req.appointment_create_request="数据结构示例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.global.im.pickup.appointment.order.info.create");
add_param(pRequest,"appointment_create_request","数据结构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.global.im.pickup.appointment.order.info.create', {
	'appointment_create_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_global_im_pickup_appointment_order_info_create_response>
    <hsf_result>
        <appointment_create_response>
            <handover_order_id>1001</handover_order_id>
            <handover_order_code>RWXXXX</handover_order_code>
        </appointment_create_response>
        <success>false</success>
        <error_code>xxxxx</error_code>
        <internal_error_code>P-088-0000-00-15-401</internal_error_code>
        <error_msg>createAppointmentOrder Lp exist error</error_msg>
        <ext_error_map>&quot;LP_STATUS_ABNORMAL&quot;: [             &quot;LP00552256342023&quot;         ]</ext_error_map>
    </hsf_result>
</cainiao_global_im_pickup_appointment_order_info_create_response>

{
    "cainiao_global_im_pickup_appointment_order_info_create_response":{
        "hsf_result":{
            "appointment_create_response":{
                "handover_order_id":1001,
                "handover_order_code":"RWXXXX"
            },
            "success":false,
            "error_code":"xxxxx",
            "internal_error_code":"P-088-0000-00-15-401",
            "error_msg":"createAppointmentOrder Lp exist error",
            "ext_error_map":"\"LP_STATUS_ABNORMAL\": [             \"LP00552256342023\"         ]"
        }
    }
}

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下载

开放平台

菜鸟集货API

cainiao.global.im.pickup.appointment.order.info.create (首公里揽收-预约单创建)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ