淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
hi_erp_order_event	HiErpOrderEvent	必须			ERP推单模型
hi_erp_order_dto HiErpOrderDTO 必须主单信息 └ out_order_code String 必须 12341231 外部订单号，唯一标识 └ channel String 必须 213 渠道，比如213 └ owner_id Number 必须 1234 货主ID └ seller_nick String 必须测试商家店铺名称 └ out_seller_nick String 可选外部测试商家外部店铺名称 └ trade_id String 可选 123123 交易ID，非淘系订单，填写外部平台交易ID └ order_type String 必须 0 订单类型，目前只支持销售单，取值为0 └ order_time String 可选 2022-01-01 00:11:11 下单时间，为空则取接口调用时间 └ pay_time String 可选 2022-01-01 00:11:11 支付时间，为空则取接口调用时间 └ cipher_text Boolean 可选 false 是否加密，默认为false └ buyer_memo String 可选测试买家留言买家留言 └ store_code String 可选 T10001 仓编码，揽配业务必填 └ feature String 可选 {"key":1, "key1": "value1"} 扩展字段，json格式 └ seller_message String 可选测试卖家备注卖家备注 hi_erp_receiver_dto HiErpReceiverDTO 必须收件人信息 └ receiver_name String 必须张三收件人姓名 └ cell_phone String 可选 18900000000 手机号码 └ tele_phone String 可选 0210000000 电话号码 └ country String 必须中国国家 └ province String 必须浙江省省 └ city String 可选杭州市市，市和区二选一必填 └ area String 可选西湖区区，市和区二选一必填 └ town String 可选测试街道街道 └ detail_address String 必须测试地址详细地址 └ feature String 必须 {"key":1, "key1": "value1"} 扩展字段，json格式 hi_erp_item_dto_list HiErpItemDTO [] 必须货品明细 └ out_order_item_id String 可选 123123 外部订单明细唯一标识 └ sub_trade_id String 可选 123123 子交易单号 └ sc_item_id Number 可选 123123 后端货品ID，货品id和货品编码二选一必填，优先取货品ID └ sc_item_code String 可选 123 后端货品编码，货品id和货品编码二选一必填，优先取货品ID └ item_amount Number 必须 123 货品金额 └ item_qty Number 必须 123 货品数量 └ feature String 必须 {"key":1, "key1": "value1"} 扩展字段，json格式

名称	类型	示例值	描述
result	BaseResult		结果
└ success Boolean true false: 失败 true: 成功 result HiErpOrderResp 数据 └ out_order_code String 12341324 外部订单号 └ scp_order_code String SCP000001 SCP单号，履约单号 └ feature String {"key":1, "key1": "value1"} 扩展字段，json格式 └ error_code String 错误编码通常用于success为false时的页面错误类型判定 └ error_msg String 错误信息通常用于success为false时的页面错误信息提示 └ msg String 描述通常用于success为true时的页面提示

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTianmaoLanpeiUopCreateRequest req = new AlibabaTianmaoLanpeiUopCreateRequest();
AlibabaTianmaoLanpeiUopCreateRequest.HiErpOrderEvent obj1 = new AlibabaTianmaoLanpeiUopCreateRequest.HiErpOrderEvent();
AlibabaTianmaoLanpeiUopCreateRequest.HiErpOrderDTO obj2 = new AlibabaTianmaoLanpeiUopCreateRequest.HiErpOrderDTO();
obj2.setOutOrderCode("12341231");
obj2.setChannel("213");
obj2.setOwnerId(1234L);
obj2.setSellerNick("测试商家");
obj2.setOutSellerNick("外部测试商家");
obj2.setTradeId("123123");
obj2.setOrderType("0");
obj2.setOrderTime("2022-01-01 00:11:11");
obj2.setPayTime("2022-01-01 00:11:11");
obj2.setCipherText(false);
obj2.setBuyerMemo("测试买家留言");
obj2.setStoreCode("T10001");
obj2.setFeature("{\"key\":1, \"key1\": \"value1\"}");
obj2.setSellerMessage("测试卖家备注");
obj1.setHiErpOrderDto(obj2);
AlibabaTianmaoLanpeiUopCreateRequest.HiErpReceiverDTO obj3 = new AlibabaTianmaoLanpeiUopCreateRequest.HiErpReceiverDTO();
obj3.setReceiverName("张三");
obj3.setCellPhone("18900000000");
obj3.setTelePhone("0210000000");
obj3.setCountry("中国");
obj3.setProvince("浙江省");
obj3.setCity("杭州市");
obj3.setArea("西湖区");
obj3.setTown("测试街道");
obj3.setDetailAddress("测试地址");
obj3.setFeature("{\"key\":1, \"key1\": \"value1\"}");
obj1.setHiErpReceiverDto(obj3);
List<AlibabaTianmaoLanpeiUopCreateRequest.HiErpItemDTO> list5 = new ArrayList<AlibabaTianmaoLanpeiUopCreateRequest.HiErpItemDTO>();
AlibabaTianmaoLanpeiUopCreateRequest.HiErpItemDTO obj6 = new AlibabaTianmaoLanpeiUopCreateRequest.HiErpItemDTO();
list5.add(obj6);
obj6.setOutOrderItemId("123123");
obj6.setSubTradeId("123123");
obj6.setScItemId(123123L);
obj6.setScItemCode("123");
obj6.setItemAmount(123L);
obj6.setItemQty(123L);
obj6.setFeature("{\"key\":1, \"key1\": \"value1\"}");
obj1.setHiErpItemDtoList(list5);
req.setHiErpOrderEvent(obj1);
AlibabaTianmaoLanpeiUopCreateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTianmaoLanpeiUopCreateRequest req = new AlibabaTianmaoLanpeiUopCreateRequest();
AlibabaTianmaoLanpeiUopCreateRequest.HiErpOrderEventDomain obj1 = new AlibabaTianmaoLanpeiUopCreateRequest.HiErpOrderEventDomain();
AlibabaTianmaoLanpeiUopCreateRequest.HiErpOrderDTODomain obj2 = new AlibabaTianmaoLanpeiUopCreateRequest.HiErpOrderDTODomain();
obj2.OutOrderCode = "12341231";
obj2.Channel = "213";
obj2.OwnerId = 1234L;
obj2.SellerNick = "测试商家";
obj2.OutSellerNick = "外部测试商家";
obj2.TradeId = "123123";
obj2.OrderType = "0";
obj2.OrderTime = "2022-01-01 00:11:11";
obj2.PayTime = "2022-01-01 00:11:11";
obj2.CipherText = false;
obj2.BuyerMemo = "测试买家留言";
obj2.StoreCode = "T10001";
obj2.Feature = "{\"key\":1, \"key1\": \"value1\"}";
obj2.SellerMessage = "测试卖家备注";
obj1.HiErpOrderDto= obj2;
AlibabaTianmaoLanpeiUopCreateRequest.HiErpReceiverDTODomain obj3 = new AlibabaTianmaoLanpeiUopCreateRequest.HiErpReceiverDTODomain();
obj3.ReceiverName = "张三";
obj3.CellPhone = "18900000000";
obj3.TelePhone = "0210000000";
obj3.Country = "中国";
obj3.Province = "浙江省";
obj3.City = "杭州市";
obj3.Area = "西湖区";
obj3.Town = "测试街道";
obj3.DetailAddress = "测试地址";
obj3.Feature = "{\"key\":1, \"key1\": \"value1\"}";
obj1.HiErpReceiverDto= obj3;
List<AlibabaTianmaoLanpeiUopCreateRequest.HiErpItemDTODomain> list5 = new List<AlibabaTianmaoLanpeiUopCreateRequest.HiErpItemDTODomain>();
AlibabaTianmaoLanpeiUopCreateRequest.HiErpItemDTODomain obj6 = new AlibabaTianmaoLanpeiUopCreateRequest.HiErpItemDTODomain();
list5.Add(obj6);
obj6.OutOrderItemId = "123123";
obj6.SubTradeId = "123123";
obj6.ScItemId = 123123L;
obj6.ScItemCode = "123";
obj6.ItemAmount = 123L;
obj6.ItemQty = 123L;
obj6.Feature = "{\"key\":1, \"key1\": \"value1\"}";
obj1.HiErpItemDtoList= list5;
req.HiErpOrderEvent_ = obj1;
AlibabaTianmaoLanpeiUopCreateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTianmaoLanpeiUopCreateRequest;
$hi_erp_order_event = new HiErpOrderEvent;
$hi_erp_order_dto = new HiErpOrderDTO;
$hi_erp_order_dto->out_order_code="12341231";
$hi_erp_order_dto->channel="213";
$hi_erp_order_dto->owner_id="1234";
$hi_erp_order_dto->seller_nick="测试商家";
$hi_erp_order_dto->out_seller_nick="外部测试商家";
$hi_erp_order_dto->trade_id="123123";
$hi_erp_order_dto->order_type="0";
$hi_erp_order_dto->order_time="2022-01-01 00:11:11";
$hi_erp_order_dto->pay_time="2022-01-01 00:11:11";
$hi_erp_order_dto->cipher_text="false";
$hi_erp_order_dto->buyer_memo="测试买家留言";
$hi_erp_order_dto->store_code="T10001";
$hi_erp_order_dto->feature="{\"key\":1, \"key1\": \"value1\"}";
$hi_erp_order_dto->seller_message="测试卖家备注";
$hi_erp_order_event->hi_erp_order_dto = $hi_erp_order_dto;
$hi_erp_receiver_dto = new HiErpReceiverDTO;
$hi_erp_receiver_dto->receiver_name="张三";
$hi_erp_receiver_dto->cell_phone="18900000000";
$hi_erp_receiver_dto->tele_phone="0210000000";
$hi_erp_receiver_dto->country="中国";
$hi_erp_receiver_dto->province="浙江省";
$hi_erp_receiver_dto->city="杭州市";
$hi_erp_receiver_dto->area="西湖区";
$hi_erp_receiver_dto->town="测试街道";
$hi_erp_receiver_dto->detail_address="测试地址";
$hi_erp_receiver_dto->feature="{\"key\":1, \"key1\": \"value1\"}";
$hi_erp_order_event->hi_erp_receiver_dto = $hi_erp_receiver_dto;
$hi_erp_item_dto_list = new HiErpItemDTO;
$hi_erp_item_dto_list->out_order_item_id="123123";
$hi_erp_item_dto_list->sub_trade_id="123123";
$hi_erp_item_dto_list->sc_item_id="123123";
$hi_erp_item_dto_list->sc_item_code="123";
$hi_erp_item_dto_list->item_amount="123";
$hi_erp_item_dto_list->item_qty="123";
$hi_erp_item_dto_list->feature="{\"key\":1, \"key1\": \"value1\"}";
$hi_erp_order_event->hi_erp_item_dto_list = $hi_erp_item_dto_list;
$req->setHiErpOrderEvent(json_encode($hi_erp_order_event));
$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=alibaba.tianmao.lanpei.uop.create' \
-d 'partner_id=apidoc' \
-d 'session=5043e63a-d3b4-4bd7-aa31-87e730de18fd' \
-d 'sign=2F4FCF77C4CD486D25B97BCCF3CAB31D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+15%3A24%3A00' \
-d 'v=2.0' \
-d 'hi_erp_order_event=null'

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

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

req.hi_erp_order_event="数据结构示例JSON格式"
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,"alibaba.tianmao.lanpei.uop.create");
add_param(pRequest,"hi_erp_order_event","数据结构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('alibaba.tianmao.lanpei.uop.create', {
	'hi_erp_order_event':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_tianmao_lanpei_uop_create_response>
    <result>
        <success>true</success>
        <result>
            <out_order_code>12341324</out_order_code>
            <scp_order_code>SCP000001</scp_order_code>
            <feature>{&quot;key&quot;:1, &quot;key1&quot;: &quot;value1&quot;}</feature>
        </result>
        <error_code>错误编码</error_code>
        <error_msg>错误信息</error_msg>
        <msg>描述</msg>
    </result>
</alibaba_tianmao_lanpei_uop_create_response>

{
    "alibaba_tianmao_lanpei_uop_create_response":{
        "result":{
            "success":true,
            "result":{
                "out_order_code":"12341324",
                "scp_order_code":"SCP000001",
                "feature":"{\"key\":1, \"key1\": \"value1\"}"
            },
            "error_code":"错误编码",
            "error_msg":"错误信息",
            "msg":"描述"
        }
    }
}

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

开放平台

天猫供应链

alibaba.tianmao.lanpei.uop.create (阿里巴巴.天猫家装.揽配.履约订单.创建)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ