淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
orderBillCode	String	必须	A123		单据编号
orderWebCod	String	必须	A123		原单据号
shopCode	String	必须	HZ01		门店代码
billTime	String	必须	20171010		营业日期
quantity	Number	必须	100		数量
money	String	必须	100		标准价格
realMoney	String	必须	100		金额
discount	String	必须	9		折扣
paymethod	String	必须	支付方式：0-线上支付 1-线下支付',		支付方式
name	String	必须	张三		姓名
phone	String	必须	13000000000		手机号
province	String	可选	浙江省		省
city	String	可选	杭州市		市
district	String	可选	余杭区		区
addres	String	可选	文一西路		街道
shippingAddress	String	可选	969号		快递地址
creater	String	可选	张三		制单人
creationDate	String	可选	2017-11-11 12:00:00		制单日期
note	String	可选	备注信息		备注
shippingCode	String	可选	SF		快递代码
shippingSn	String	可选	201711110011		快递单号
salerEmployeeNo	String	可选	001		店员代码
th_act	String	必须	退单		退单
system	String	必须	来源系统 0-POS、1-中台、2-Retail、3-OMS、4-其他		来源系统
item	Item []	可选		最大列表长度：999	商品明细
└ status String 可选 0-正常 1-促销 2-换购 3-赠品 4-让利 5-补差优惠 6-VIP叠加优惠 7-生日优惠 8-整单叠加优惠 9-积分换购 11-换货，12-已换货,13-打折状态 └ amount String 必须 1000 金额 └ referenceAmount String 可选 1000 参考金额 └ quantity String 必须 1000 数量 └ discount String 必须 8 折扣 └ price String 必须 80 单价 └ referencePrice String 必须 100 参考价 └ sizeCode String 必须 L 尺码代码 └ colorCode String 必须 A001 颜色代码 └ goodsCode String 必须 A001 商品代码 └ skuCode String 可选 A001 商品条码
extend_props	String	可选	{"name":"名字"}		扩展属性
lypt	String	必须	来源平台：0-后台1-淘宝2-拍拍3-OS主站4-分销商5-京东11-亚马逊13-一号店等'		来源平台
lyzd_dm	String	必须	'来源店铺代码		'来源店铺代码
lyzd_mc	String	必须	'来源店铺名称		'来源店铺名称
lyorg_dm	String	必须	'来源渠道代码		'来源渠道代码
lyorg_mc	String	必须	'来源渠道名称		'来源渠道名称
xdzd_dm	String	必须	'下单门店代码		'下单门店代码
gkly	String	必须	'顾客留言		'顾客留言
kfbz	String	必须	'客服备注		'客服备注
pos_outer_code	String	必须	'结算代码		'结算代码
customerid	String	可选	customerid		customerid
customerid	String	可选	customerid		customerid
oaid	String	可选	oaid		oaid
oaidOrderSourceCode	String	可选	12233		oaid订单号

名称	类型	示例值	描述
flag	String	success\|failure	响应结果
code	String	1	1：成功；其他：失败
message	String	msg	响应信息

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
TaobaoPosWeborderSyncRequest req = new TaobaoPosWeborderSyncRequest();
req.setOrderBillCode("A123");
req.setOrderWebCod("A123");
req.setShopCode("HZ01");
req.setBillTime("20171010");
req.setQuantity(100L);
req.setMoney("100");
req.setRealMoney("100");
req.setDiscount("9");
req.setPaymethod("支付方式：0-线上支付 1-线下支付',");
req.setName("张三");
req.setPhone("13000000000");
req.setProvince("浙江省");
req.setCity("杭州市");
req.setDistrict("余杭区");
req.setAddres("文一西路");
req.setShippingAddress("969号");
req.setCreater("张三");
req.setCreationDate("2017-11-11 12:00:00");
req.setNote("备注信息");
req.setShippingCode("SF");
req.setShippingSn("201711110011");
req.setSalerEmployeeNo("001");
req.setThAct("退单");
req.setSystem("来源系统 0-POS、1-中台、2-Retail、3-OMS、4-其他");
List<TaobaoPosWeborderSyncRequest.Item> list2 = new ArrayList<TaobaoPosWeborderSyncRequest.Item>();
TaobaoPosWeborderSyncRequest.Item obj3 = new TaobaoPosWeborderSyncRequest.Item();
list2.add(obj3);
obj3.setStatus("0-正常 1-促销 2-换购 3-赠品 4-让利 5-补差优惠 6-VIP叠加优惠 7-生日优惠 8-整单叠加优惠  9-积分换购 11-换货，12-已换货,13-打折");
obj3.setAmount("1000");
obj3.setReferenceAmount("1000");
obj3.setQuantity("1000");
obj3.setDiscount("8");
obj3.setPrice("80");
obj3.setReferencePrice("100");
obj3.setSizeCode("L");
obj3.setColorCode("A001");
obj3.setGoodsCode("A001");
obj3.setSkuCode("A001");
req.setItem(list2);
req.setExtendProps("{\"name\":\"名字\"}");
req.setLypt("来源平台：0-后台1-淘宝2-拍拍3-OS主站4-分销商5-京东11-亚马逊13-一号店等'");
req.setLyzdDm("'来源店铺代码");
req.setLyzdMc("'来源店铺名称");
req.setLyorgDm("'来源渠道代码");
req.setLyorgMc("'来源渠道名称");
req.setXdzdDm("'下单门店代码");
req.setGkly("'顾客留言");
req.setKfbz("'客服备注");
req.setPosOuterCode("'结算代码");
req.setCustomerid("customerid");
req.setCustomerid("customerid");
req.setOaid("oaid");
req.setOaidOrderSourceCode("12233");
TaobaoPosWeborderSyncResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TaobaoPosWeborderSyncRequest req = new TaobaoPosWeborderSyncRequest();
req.OrderBillCode = "A123";
req.OrderWebCod = "A123";
req.ShopCode = "HZ01";
req.BillTime = "20171010";
req.Quantity = 100L;
req.Money = "100";
req.RealMoney = "100";
req.Discount = "9";
req.Paymethod = "支付方式：0-线上支付 1-线下支付',";
req.Name = "张三";
req.Phone = "13000000000";
req.Province = "浙江省";
req.City = "杭州市";
req.District = "余杭区";
req.Addres = "文一西路";
req.ShippingAddress = "969号";
req.Creater = "张三";
req.CreationDate = "2017-11-11 12:00:00";
req.Note = "备注信息";
req.ShippingCode = "SF";
req.ShippingSn = "201711110011";
req.SalerEmployeeNo = "001";
req.ThAct = "退单";
req.System = "来源系统 0-POS、1-中台、2-Retail、3-OMS、4-其他";
List<TaobaoPosWeborderSyncRequest.ItemDomain> list2 = new List<TaobaoPosWeborderSyncRequest.ItemDomain>();
TaobaoPosWeborderSyncRequest.ItemDomain obj3 = new TaobaoPosWeborderSyncRequest.ItemDomain();
list2.Add(obj3);
obj3.Status = "0-正常 1-促销 2-换购 3-赠品 4-让利 5-补差优惠 6-VIP叠加优惠 7-生日优惠 8-整单叠加优惠  9-积分换购 11-换货，12-已换货,13-打折";
obj3.Amount = "1000";
obj3.ReferenceAmount = "1000";
obj3.Quantity = "1000";
obj3.Discount = "8";
obj3.Price = "80";
obj3.ReferencePrice = "100";
obj3.SizeCode = "L";
obj3.ColorCode = "A001";
obj3.GoodsCode = "A001";
obj3.SkuCode = "A001";
req.Item_ = list2;
req.ExtendProps = "{\"name\":\"名字\"}";
req.Lypt = "来源平台：0-后台1-淘宝2-拍拍3-OS主站4-分销商5-京东11-亚马逊13-一号店等'";
req.LyzdDm = "'来源店铺代码";
req.LyzdMc = "'来源店铺名称";
req.LyorgDm = "'来源渠道代码";
req.LyorgMc = "'来源渠道名称";
req.XdzdDm = "'下单门店代码";
req.Gkly = "'顾客留言";
req.Kfbz = "'客服备注";
req.PosOuterCode = "'结算代码";
req.Customerid = "customerid";
req.Customerid = "customerid";
req.Oaid = "oaid";
req.OaidOrderSourceCode = "12233";
TaobaoPosWeborderSyncResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TaobaoPosWeborderSyncRequest;
$req->setOrderBillCode("A123");
$req->setOrderWebCod("A123");
$req->setShopCode("HZ01");
$req->setBillTime("20171010");
$req->setQuantity("100");
$req->setMoney("100");
$req->setRealMoney("100");
$req->setDiscount("9");
$req->setPaymethod("支付方式：0-线上支付 1-线下支付',");
$req->setName("张三");
$req->setPhone("13000000000");
$req->setProvince("浙江省");
$req->setCity("杭州市");
$req->setDistrict("余杭区");
$req->setAddres("文一西路");
$req->setShippingAddress("969号");
$req->setCreater("张三");
$req->setCreationDate("2017-11-11 12:00:00");
$req->setNote("备注信息");
$req->setShippingCode("SF");
$req->setShippingSn("201711110011");
$req->setSalerEmployeeNo("001");
$req->setThAct("退单");
$req->setSystem("来源系统 0-POS、1-中台、2-Retail、3-OMS、4-其他");
$item = new Item;
$item->status="0-正常 1-促销 2-换购 3-赠品 4-让利 5-补差优惠 6-VIP叠加优惠 7-生日优惠 8-整单叠加优惠  9-积分换购 11-换货，12-已换货,13-打折";
$item->amount="1000";
$item->reference_amount="1000";
$item->quantity="1000";
$item->discount="8";
$item->price="80";
$item->reference_price="100";
$item->size_code="L";
$item->color_code="A001";
$item->goods_code="A001";
$item->sku_code="A001";
$req->setItem(json_encode($item));
$req->setExtendProps("{\"name\":\"名字\"}");
$req->setLypt("来源平台：0-后台1-淘宝2-拍拍3-OS主站4-分销商5-京东11-亚马逊13-一号店等'");
$req->setLyzdDm("'来源店铺代码");
$req->setLyzdMc("'来源店铺名称");
$req->setLyorgDm("'来源渠道代码");
$req->setLyorgMc("'来源渠道名称");
$req->setXdzdDm("'下单门店代码");
$req->setGkly("'顾客留言");
$req->setKfbz("'客服备注");
$req->setPosOuterCode("'结算代码");
$req->setCustomerid("customerid");
$req->setCustomerid("customerid");
$req->setOaid("oaid");
$req->setOaidOrderSourceCode("12233");
$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=qimen.taobao.pos.weborder.sync' \
-d 'partner_id=apidoc' \
-d 'session=e43cfb05-7ec2-45f3-bf29-1afb35630ecc' \
-d 'sign=2BD5CB53730B973067B066A1053D6894' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+11%3A44%3A56' \
-d 'v=2.0' \
-d 'addres=%E6%96%87%E4%B8%80%E8%A5%BF%E8%B7%AF' \
-d 'billTime=20171010' \
-d 'city=%E6%9D%AD%E5%B7%9E%E5%B8%82' \
-d 'creater=%E5%BC%A0%E4%B8%89' \
-d 'creationDate=2017-11-11+12%3A00%3A00' \
-d 'customerid=customerid' \
-d 'discount=9' \
-d 'district=%E4%BD%99%E6%9D%AD%E5%8C%BA' \
-d 'extend_props=%7B%5C%22name%5C%22%3A%5C%22%E5%90%8D%E5%AD%97%5C%22%7D' \
-d 'gkly=%27%E9%A1%BE%E5%AE%A2%E7%95%99%E8%A8%80' \
-d 'item=null' \
-d 'kfbz=%27%E5%AE%A2%E6%9C%8D%E5%A4%87%E6%B3%A8' \
-d 'lyorg_dm=%27%E6%9D%A5%E6%BA%90%E6%B8%A0%E9%81%93%E4%BB%A3%E7%A0%81' \
-d 'lyorg_mc=%27%E6%9D%A5%E6%BA%90%E6%B8%A0%E9%81%93%E5%90%8D%E7%A7%B0' \
-d 'lypt=%E6%9D%A5%E6%BA%90%E5%B9%B3%E5%8F%B0%EF%BC%9A0-%E5%90%8E%E5%8F%B01-%E6%B7%98%E5%AE%9D2-%E6%8B%8D%E6%8B%8D3-OS%E4%B8%BB%E7%AB%994-%E5%88%86%E9%94%80%E5%95%865-%E4%BA%AC%E4%B8%9C11-%E4%BA%9A%E9%A9%AC%E9%80%8A13-%E4%B8%80%E5%8F%B7%E5%BA%97%E7%AD%89%27' \
-d 'lyzd_dm=%27%E6%9D%A5%E6%BA%90%E5%BA%97%E9%93%BA%E4%BB%A3%E7%A0%81' \
-d 'lyzd_mc=%27%E6%9D%A5%E6%BA%90%E5%BA%97%E9%93%BA%E5%90%8D%E7%A7%B0' \
-d 'money=100' \
-d 'name=%E5%BC%A0%E4%B8%89' \
-d 'note=%E5%A4%87%E6%B3%A8%E4%BF%A1%E6%81%AF' \
-d 'oaid=oaid' \
-d 'oaidOrderSourceCode=12233' \
-d 'orderBillCode=A123' \
-d 'orderWebCod=A123' \
-d 'paymethod=%E6%94%AF%E4%BB%98%E6%96%B9%E5%BC%8F%EF%BC%9A0-%E7%BA%BF%E4%B8%8A%E6%94%AF%E4%BB%98+1-%E7%BA%BF%E4%B8%8B%E6%94%AF%E4%BB%98%27%2C' \
-d 'phone=13000000000' \
-d 'pos_outer_code=%27%E7%BB%93%E7%AE%97%E4%BB%A3%E7%A0%81' \
-d 'province=%E6%B5%99%E6%B1%9F%E7%9C%81' \
-d 'quantity=100' \
-d 'realMoney=100' \
-d 'salerEmployeeNo=001' \
-d 'shippingAddress=969%E5%8F%B7' \
-d 'shippingCode=SF' \
-d 'shippingSn=201711110011' \
-d 'shopCode=HZ01' \
-d 'system=%E6%9D%A5%E6%BA%90%E7%B3%BB%E7%BB%9F+0-POS%E3%80%811-%E4%B8%AD%E5%8F%B0%E3%80%812-Retail%E3%80%813-OMS%E3%80%814-%E5%85%B6%E4%BB%96' \
-d 'th_act=%E9%80%80%E5%8D%95' \
-d 'xdzd_dm=%27%E4%B8%8B%E5%8D%95%E9%97%A8%E5%BA%97%E4%BB%A3%E7%A0%81'

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

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

req.orderBillCode="A123"
req.orderWebCod="A123"
req.shopCode="HZ01"
req.billTime="20171010"
req.quantity=100
req.money="100"
req.realMoney="100"
req.discount="9"
req.paymethod="支付方式：0-线上支付 1-线下支付',"
req.name="张三"
req.phone="13000000000"
req.province="浙江省"
req.city="杭州市"
req.district="余杭区"
req.addres="文一西路"
req.shippingAddress="969号"
req.creater="张三"
req.creationDate="2017-11-11 12:00:00"
req.note="备注信息"
req.shippingCode="SF"
req.shippingSn="201711110011"
req.salerEmployeeNo="001"
req.th_act="退单"
req.system="来源系统 0-POS、1-中台、2-Retail、3-OMS、4-其他"
req.item="null"
req.extend_props="{\"name\":\"名字\"}"
req.lypt="来源平台：0-后台1-淘宝2-拍拍3-OS主站4-分销商5-京东11-亚马逊13-一号店等'"
req.lyzd_dm="'来源店铺代码"
req.lyzd_mc="'来源店铺名称"
req.lyorg_dm="'来源渠道代码"
req.lyorg_mc="'来源渠道名称"
req.xdzd_dm="'下单门店代码"
req.gkly="'顾客留言"
req.kfbz="'客服备注"
req.pos_outer_code="'结算代码"
req.customerid="customerid"
req.customerid="customerid"
req.oaid="oaid"
req.oaidOrderSourceCode="12233"
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,"qimen.taobao.pos.weborder.sync");
add_param(pRequest,"orderBillCode","A123");
add_param(pRequest,"orderWebCod","A123");
add_param(pRequest,"shopCode","HZ01");
add_param(pRequest,"billTime","20171010");
add_param(pRequest,"quantity","100");
add_param(pRequest,"money","100");
add_param(pRequest,"realMoney","100");
add_param(pRequest,"discount","9");
add_param(pRequest,"paymethod","支付方式：0-线上支付 1-线下支付',");
add_param(pRequest,"name","张三");
add_param(pRequest,"phone","13000000000");
add_param(pRequest,"province","浙江省");
add_param(pRequest,"city","杭州市");
add_param(pRequest,"district","余杭区");
add_param(pRequest,"addres","文一西路");
add_param(pRequest,"shippingAddress","969号");
add_param(pRequest,"creater","张三");
add_param(pRequest,"creationDate","2017-11-11 12:00:00");
add_param(pRequest,"note","备注信息");
add_param(pRequest,"shippingCode","SF");
add_param(pRequest,"shippingSn","201711110011");
add_param(pRequest,"salerEmployeeNo","001");
add_param(pRequest,"th_act","退单");
add_param(pRequest,"system","来源系统 0-POS、1-中台、2-Retail、3-OMS、4-其他");
add_param(pRequest,"item","数据结构JSON示例");
add_param(pRequest,"extend_props","{\"name\":\"名字\"}");
add_param(pRequest,"lypt","来源平台：0-后台1-淘宝2-拍拍3-OS主站4-分销商5-京东11-亚马逊13-一号店等'");
add_param(pRequest,"lyzd_dm","'来源店铺代码");
add_param(pRequest,"lyzd_mc","'来源店铺名称");
add_param(pRequest,"lyorg_dm","'来源渠道代码");
add_param(pRequest,"lyorg_mc","'来源渠道名称");
add_param(pRequest,"xdzd_dm","'下单门店代码");
add_param(pRequest,"gkly","'顾客留言");
add_param(pRequest,"kfbz","'客服备注");
add_param(pRequest,"pos_outer_code","'结算代码");
add_param(pRequest,"customerid","customerid");
add_param(pRequest,"customerid","customerid");
add_param(pRequest,"oaid","oaid");
add_param(pRequest,"oaidOrderSourceCode","12233");
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('qimen.taobao.pos.weborder.sync', {
	'orderBillCode':'A123',
	'orderWebCod':'A123',
	'shopCode':'HZ01',
	'billTime':'20171010',
	'quantity':'100',
	'money':'100',
	'realMoney':'100',
	'discount':'9',
	'paymethod':'支付方式：0-线上支付 1-线下支付',',
	'name':'张三',
	'phone':'13000000000',
	'province':'浙江省',
	'city':'杭州市',
	'district':'余杭区',
	'addres':'文一西路',
	'shippingAddress':'969号',
	'creater':'张三',
	'creationDate':'2017-11-11 12:00:00',
	'note':'备注信息',
	'shippingCode':'SF',
	'shippingSn':'201711110011',
	'salerEmployeeNo':'001',
	'th_act':'退单',
	'system':'来源系统 0-POS、1-中台、2-Retail、3-OMS、4-其他',
	'item':'数据结构JSON示例',
	'extend_props':'{\"name\":\"名字\"}',
	'lypt':'来源平台：0-后台1-淘宝2-拍拍3-OS主站4-分销商5-京东11-亚马逊13-一号店等'',
	'lyzd_dm':''来源店铺代码',
	'lyzd_mc':''来源店铺名称',
	'lyorg_dm':''来源渠道代码',
	'lyorg_mc':''来源渠道名称',
	'xdzd_dm':''下单门店代码',
	'gkly':''顾客留言',
	'kfbz':''客服备注',
	'pos_outer_code':''结算代码',
	'customerid':'customerid',
	'customerid':'customerid',
	'oaid':'oaid',
	'oaidOrderSourceCode':'12233'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<flag>success|failure</flag>
<code>1</code>
<message>msg</message>

{
    "flag":"success|failure",
    "code":"1",
    "message":"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下载

开放平台

奇门POS接口

qimen.taobao.pos.weborder.sync (线上销售单信息同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ