淘宝开放平台 - 文档中心

请求地址：

环境	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	单据编号
status	String	必须	1、确认 2、取货 3、作废	状态类型
confirm	String	可选	0-未确认 1-已确认 2-已完成	确认
confirmor	String	可选	确认人	确认人
confirmDate	String	可选	2017-11-11 10:00:00	确认日期
delivery	String	可选	0-未取货 1-已取货	取货
deliveryDate	String	可选	2017-11-11 10:00:00	取货日期
cancle	String	可选	作废	作废
canceler	String	可选	张三	作废人
cancleDate	String	可选	2017-11-11 10:00:00	作废日期
finish	String	可选	完成	完成
finishDate	String	可选	2017-11-11 10:00:00	完成日期
shippingCode	String	可选	SF	快递代码
shippingSn	String	可选	2017101010	快递单号
zf_type	String	可选	用户退货 0 是 1 其他原因	作废类型
zf_message	String	可选	不想买了	作废原因
customerid	String	必须	12222	路由参数
extendProps	String	可选	扩展属性	扩展字段

名称	类型	示例值	描述
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);
TaobaoPosSalesorderUpdateRequest req = new TaobaoPosSalesorderUpdateRequest();
req.setOrderBillCode("A123");
req.setStatus("1、确认  2、取货 3、作废");
req.setConfirm("0-未确认 1-已确认 2-已完成");
req.setConfirmor("确认人");
req.setConfirmDate("2017-11-11 10:00:00");
req.setDelivery("0-未取货 1-已取货");
req.setDeliveryDate("2017-11-11 10:00:00");
req.setCancle("作废");
req.setCanceler("张三");
req.setCancleDate("2017-11-11 10:00:00");
req.setFinish("完成");
req.setFinishDate("2017-11-11 10:00:00");
req.setShippingCode("SF");
req.setShippingSn("2017101010");
req.setZfType("用户退货 0 是  1 其他原因");
req.setZfMessage("不想买了");
req.setCustomerid("12222");
req.setExtendProps("扩展属性");
TaobaoPosSalesorderUpdateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TaobaoPosSalesorderUpdateRequest req = new TaobaoPosSalesorderUpdateRequest();
req.OrderBillCode = "A123";
req.Status = "1、确认  2、取货 3、作废";
req.Confirm = "0-未确认 1-已确认 2-已完成";
req.Confirmor = "确认人";
req.ConfirmDate = "2017-11-11 10:00:00";
req.Delivery = "0-未取货 1-已取货";
req.DeliveryDate = "2017-11-11 10:00:00";
req.Cancle = "作废";
req.Canceler = "张三";
req.CancleDate = "2017-11-11 10:00:00";
req.Finish = "完成";
req.FinishDate = "2017-11-11 10:00:00";
req.ShippingCode = "SF";
req.ShippingSn = "2017101010";
req.ZfType = "用户退货 0 是  1 其他原因";
req.ZfMessage = "不想买了";
req.Customerid = "12222";
req.ExtendProps = "扩展属性";
TaobaoPosSalesorderUpdateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TaobaoPosSalesorderUpdateRequest;
$req->setOrderBillCode("A123");
$req->setStatus("1、确认  2、取货 3、作废");
$req->setConfirm("0-未确认 1-已确认 2-已完成");
$req->setConfirmor("确认人");
$req->setConfirmDate("2017-11-11 10:00:00");
$req->setDelivery("0-未取货 1-已取货");
$req->setDeliveryDate("2017-11-11 10:00:00");
$req->setCancle("作废");
$req->setCanceler("张三");
$req->setCancleDate("2017-11-11 10:00:00");
$req->setFinish("完成");
$req->setFinishDate("2017-11-11 10:00:00");
$req->setShippingCode("SF");
$req->setShippingSn("2017101010");
$req->setZfType("用户退货 0 是  1 其他原因");
$req->setZfMessage("不想买了");
$req->setCustomerid("12222");
$req->setExtendProps("扩展属性");
$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.salesorder.update' \
-d 'partner_id=apidoc' \
-d 'session=b912473a-2cbc-4969-a6cc-9270a00fe345' \
-d 'sign=AEBF57CCF56AB38C014FB68FF63F4C2A' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+16%3A58%3A39' \
-d 'v=2.0' \
-d 'canceler=%E5%BC%A0%E4%B8%89' \
-d 'cancle=%E4%BD%9C%E5%BA%9F' \
-d 'cancleDate=2017-11-11+10%3A00%3A00' \
-d 'confirm=0-%E6%9C%AA%E7%A1%AE%E8%AE%A4+1-%E5%B7%B2%E7%A1%AE%E8%AE%A4+2-%E5%B7%B2%E5%AE%8C%E6%88%90' \
-d 'confirmDate=2017-11-11+10%3A00%3A00' \
-d 'confirmor=%E7%A1%AE%E8%AE%A4%E4%BA%BA' \
-d 'customerid=12222' \
-d 'delivery=0-%E6%9C%AA%E5%8F%96%E8%B4%A7+1-%E5%B7%B2%E5%8F%96%E8%B4%A7' \
-d 'deliveryDate=2017-11-11+10%3A00%3A00' \
-d 'extendProps=%E6%89%A9%E5%B1%95%E5%B1%9E%E6%80%A7' \
-d 'finish=%E5%AE%8C%E6%88%90' \
-d 'finishDate=2017-11-11+10%3A00%3A00' \
-d 'orderBillCode=A123' \
-d 'shippingCode=SF' \
-d 'shippingSn=2017101010' \
-d 'status=1%E3%80%81%E7%A1%AE%E8%AE%A4++2%E3%80%81%E5%8F%96%E8%B4%A7+3%E3%80%81%E4%BD%9C%E5%BA%9F' \
-d 'zf_message=%E4%B8%8D%E6%83%B3%E4%B9%B0%E4%BA%86' \
-d 'zf_type=%E7%94%A8%E6%88%B7%E9%80%80%E8%B4%A7+0+%E6%98%AF++1+%E5%85%B6%E4%BB%96%E5%8E%9F%E5%9B%A0'

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

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

req.orderBillCode="A123"
req.status="1、确认  2、取货 3、作废"
req.confirm="0-未确认 1-已确认 2-已完成"
req.confirmor="确认人"
req.confirmDate="2017-11-11 10:00:00"
req.delivery="0-未取货 1-已取货"
req.deliveryDate="2017-11-11 10:00:00"
req.cancle="作废"
req.canceler="张三"
req.cancleDate="2017-11-11 10:00:00"
req.finish="完成"
req.finishDate="2017-11-11 10:00:00"
req.shippingCode="SF"
req.shippingSn="2017101010"
req.zf_type="用户退货 0 是  1 其他原因"
req.zf_message="不想买了"
req.customerid="12222"
req.extendProps="扩展属性"
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.salesorder.update");
add_param(pRequest,"orderBillCode","A123");
add_param(pRequest,"status","1、确认  2、取货 3、作废");
add_param(pRequest,"confirm","0-未确认 1-已确认 2-已完成");
add_param(pRequest,"confirmor","确认人");
add_param(pRequest,"confirmDate","2017-11-11 10:00:00");
add_param(pRequest,"delivery","0-未取货 1-已取货");
add_param(pRequest,"deliveryDate","2017-11-11 10:00:00");
add_param(pRequest,"cancle","作废");
add_param(pRequest,"canceler","张三");
add_param(pRequest,"cancleDate","2017-11-11 10:00:00");
add_param(pRequest,"finish","完成");
add_param(pRequest,"finishDate","2017-11-11 10:00:00");
add_param(pRequest,"shippingCode","SF");
add_param(pRequest,"shippingSn","2017101010");
add_param(pRequest,"zf_type","用户退货 0 是  1 其他原因");
add_param(pRequest,"zf_message","不想买了");
add_param(pRequest,"customerid","12222");
add_param(pRequest,"extendProps","扩展属性");
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.salesorder.update', {
	'orderBillCode':'A123',
	'status':'1、确认  2、取货 3、作废',
	'confirm':'0-未确认 1-已确认 2-已完成',
	'confirmor':'确认人',
	'confirmDate':'2017-11-11 10:00:00',
	'delivery':'0-未取货 1-已取货',
	'deliveryDate':'2017-11-11 10:00:00',
	'cancle':'作废',
	'canceler':'张三',
	'cancleDate':'2017-11-11 10:00:00',
	'finish':'完成',
	'finishDate':'2017-11-11 10:00:00',
	'shippingCode':'SF',
	'shippingSn':'2017101010',
	'zf_type':'用户退货 0 是  1 其他原因',
	'zf_message':'不想买了',
	'customerid':'12222',
	'extendProps':'扩展属性'
}, 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.salesorder.update (更新ERP订单状态)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ