阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
receipt_order	ReceiptOrderDO	必须			订单
└ actual_amt Number 必须 1800 实收金额，单位分 └ ask_amt Number 可选 1800 应收金额 └ change_amt Number 可选 0 找零金额 └ discount_amt Number 可选 200 折扣优惠金额 └ member_card_num String 可选 HY123456 会员卡号 └ member_discount String 可选 0 会员优惠 └ op_name String 必须收银员收银员姓名 └ op_num String 必须 123 收银员工号 └ original_pos_no String 可选 POS001 原款机号 └ original_serial_num String 可选 2018010110001 原流水号 └ original_trd_time Date 可选 2017-07-12 00:00:00 原交易时间 └ overflow_amt Number 可选 0 损溢金额 pay_channels ReceiptPayChannelDo [] 可选支付渠道 └ index Number 可选 1 序号 └ pay_amount Number 可选 1800 付款金额 └ pay_type String 必须 01 付款类型，现金、支票、银行卡、支付宝、微信 └ pos_no String 可选 POS001 款机号 └ serial_num String 必须 2018010110002 流水号 └ store_id String 可选 33571001 门店号 └ channel_order_id String 可选 2018010110002 外部支付单号 └ pay_code String 可选 201811010201032013020103021 付款码 └ pos_no String 必须 POS001 款机号 └ serial_num String 必须 20180101000002 流水号 └ store_id String 必须 33571001 门店号 sub_orders ReceiptSubOrderDo [] 可选子订单信息 └ deal_amt Number 必须 1800 成交金额 └ deal_price Number 可选 900 成交单价 └ index Number 可选 1 序号 └ item_barcode String 可选 104142058 商品条码 └ item_code String 必须 104142058 商品编码 └ item_name String 可选水果商品名称 └ member_discount Number 可选 0 会员优惠 └ original_price Number 必须 1000 商品原售价 └ pos_no String 可选 POS001 款机号 └ promotion_discount Number 必须 200 子订单优惠总金额 └ quantity String 必须 2 数量 └ scan_barcode String 可选 104142058 扫描条码 └ selling_price Number 可选 1800 售价金额 └ serial_num String 必须 2018010110002_1 流水号 └ store_id String 可选 33571001 门店号 └ temporary_discount Number 可选 0 临时折扣 └ unit String 可选 kg 单位 └ trd_time Date 可选 2017-07-12 00:00:00 成交时间 └ trd_type Number 可选 1 交易类型 └ order_from String 可选 RENRENLE 来源，商家级别，当前取值：RENRENLE / SANJIANG └ merchant_code String 可选 HM 默认值：HM 商户码 └ ali_userid String 可选 AAA_12345 阿里用户ID

名称	类型	示例值	描述
is_success	Boolean	true	是否成功
return_code	Number		返回码
message	String		描述
target	String	482918113761640789	订单号

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkOrderSyncRequest req = new AlibabaWdkOrderSyncRequest();
AlibabaWdkOrderSyncRequest.ReceiptOrderDO obj1 = new AlibabaWdkOrderSyncRequest.ReceiptOrderDO();
obj1.setActualAmt(1800L);
obj1.setAskAmt(1800L);
obj1.setChangeAmt(0L);
obj1.setDiscountAmt(200L);
obj1.setMemberCardNum("HY123456");
obj1.setMemberDiscount("0");
obj1.setOpName("收银员");
obj1.setOpNum("123");
obj1.setOriginalPosNo("POS001");
obj1.setOriginalSerialNum("2018010110001");
obj1.setOriginalTrdTime(StringUtils.parseDateTime("2017-07-12 00:00:00"));
obj1.setOverflowAmt(0L);
List<AlibabaWdkOrderSyncRequest.ReceiptPayChannelDo> list3 = new ArrayList<AlibabaWdkOrderSyncRequest.ReceiptPayChannelDo>();
AlibabaWdkOrderSyncRequest.ReceiptPayChannelDo obj4 = new AlibabaWdkOrderSyncRequest.ReceiptPayChannelDo();
list3.add(obj4);
obj4.setIndex(1L);
obj4.setPayAmount(1800L);
obj4.setPayType("01");
obj4.setPosNo("POS001");
obj4.setSerialNum("2018010110002");
obj4.setStoreId("33571001");
obj4.setChannelOrderId("2018010110002");
obj4.setPayCode("201811010201032013020103021");
obj1.setPayChannels(list3);
obj1.setPosNo("POS001");
obj1.setSerialNum("20180101000002");
obj1.setStoreId("33571001");
List<AlibabaWdkOrderSyncRequest.ReceiptSubOrderDo> list6 = new ArrayList<AlibabaWdkOrderSyncRequest.ReceiptSubOrderDo>();
AlibabaWdkOrderSyncRequest.ReceiptSubOrderDo obj7 = new AlibabaWdkOrderSyncRequest.ReceiptSubOrderDo();
list6.add(obj7);
obj7.setDealAmt(1800L);
obj7.setDealPrice(900L);
obj7.setIndex(1L);
obj7.setItemBarcode("104142058");
obj7.setItemCode("104142058");
obj7.setItemName("水果");
obj7.setMemberDiscount(0L);
obj7.setOriginalPrice(1000L);
obj7.setPosNo("POS001");
obj7.setPromotionDiscount(200L);
obj7.setQuantity("2");
obj7.setScanBarcode("104142058");
obj7.setSellingPrice(1800L);
obj7.setSerialNum("2018010110002_1");
obj7.setStoreId("33571001");
obj7.setTemporaryDiscount(0L);
obj7.setUnit("kg");
obj1.setSubOrders(list6);
obj1.setTrdTime(StringUtils.parseDateTime("2017-07-12 00:00:00"));
obj1.setTrdType(1L);
obj1.setOrderFrom("RENRENLE");
obj1.setMerchantCode("HM");
obj1.setAliUserid("AAA_12345");
req.setReceiptOrder(obj1);
AlibabaWdkOrderSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkOrderSyncRequest req = new AlibabaWdkOrderSyncRequest();
AlibabaWdkOrderSyncRequest.ReceiptOrderDODomain obj1 = new AlibabaWdkOrderSyncRequest.ReceiptOrderDODomain();
obj1.ActualAmt = 1800L;
obj1.AskAmt = 1800L;
obj1.ChangeAmt = 0L;
obj1.DiscountAmt = 200L;
obj1.MemberCardNum = "HY123456";
obj1.MemberDiscount = "0";
obj1.OpName = "收银员";
obj1.OpNum = "123";
obj1.OriginalPosNo = "POS001";
obj1.OriginalSerialNum = "2018010110001";
obj1.OriginalTrdTime = DateTime.Parse(2017-07-12 00:00:00");
obj1.OverflowAmt = 0L;
List<AlibabaWdkOrderSyncRequest.ReceiptPayChannelDoDomain> list3 = new List<AlibabaWdkOrderSyncRequest.ReceiptPayChannelDoDomain>();
AlibabaWdkOrderSyncRequest.ReceiptPayChannelDoDomain obj4 = new AlibabaWdkOrderSyncRequest.ReceiptPayChannelDoDomain();
list3.Add(obj4);
obj4.Index = 1L;
obj4.PayAmount = 1800L;
obj4.PayType = "01";
obj4.PosNo = "POS001";
obj4.SerialNum = "2018010110002";
obj4.StoreId = "33571001";
obj4.ChannelOrderId = "2018010110002";
obj4.PayCode = "201811010201032013020103021";
obj1.PayChannels= list3;
obj1.PosNo = "POS001";
obj1.SerialNum = "20180101000002";
obj1.StoreId = "33571001";
List<AlibabaWdkOrderSyncRequest.ReceiptSubOrderDoDomain> list6 = new List<AlibabaWdkOrderSyncRequest.ReceiptSubOrderDoDomain>();
AlibabaWdkOrderSyncRequest.ReceiptSubOrderDoDomain obj7 = new AlibabaWdkOrderSyncRequest.ReceiptSubOrderDoDomain();
list6.Add(obj7);
obj7.DealAmt = 1800L;
obj7.DealPrice = 900L;
obj7.Index = 1L;
obj7.ItemBarcode = "104142058";
obj7.ItemCode = "104142058";
obj7.ItemName = "水果";
obj7.MemberDiscount = 0L;
obj7.OriginalPrice = 1000L;
obj7.PosNo = "POS001";
obj7.PromotionDiscount = 200L;
obj7.Quantity = "2";
obj7.ScanBarcode = "104142058";
obj7.SellingPrice = 1800L;
obj7.SerialNum = "2018010110002_1";
obj7.StoreId = "33571001";
obj7.TemporaryDiscount = 0L;
obj7.Unit = "kg";
obj1.SubOrders= list6;
obj1.TrdTime = DateTime.Parse(2017-07-12 00:00:00");
obj1.TrdType = 1L;
obj1.OrderFrom = "RENRENLE";
obj1.MerchantCode = "HM";
obj1.AliUserid = "AAA_12345";
req.ReceiptOrder_ = obj1;
AlibabaWdkOrderSyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkOrderSyncRequest;
$receipt_order = new ReceiptOrderDO;
$receipt_order->actual_amt="1800";
$receipt_order->ask_amt="1800";
$receipt_order->change_amt="0";
$receipt_order->discount_amt="200";
$receipt_order->member_card_num="HY123456";
$receipt_order->member_discount="0";
$receipt_order->op_name="收银员";
$receipt_order->op_num="123";
$receipt_order->original_pos_no="POS001";
$receipt_order->original_serial_num="2018010110001";
$receipt_order->original_trd_time="2017-07-12 00:00:00";
$receipt_order->overflow_amt="0";
$pay_channels = new ReceiptPayChannelDo;
$pay_channels->index="1";
$pay_channels->pay_amount="1800";
$pay_channels->pay_type="01";
$pay_channels->pos_no="POS001";
$pay_channels->serial_num="2018010110002";
$pay_channels->store_id="33571001";
$pay_channels->channel_order_id="2018010110002";
$pay_channels->pay_code="201811010201032013020103021";
$receipt_order->pay_channels = $pay_channels;
$receipt_order->pos_no="POS001";
$receipt_order->serial_num="20180101000002";
$receipt_order->store_id="33571001";
$sub_orders = new ReceiptSubOrderDo;
$sub_orders->deal_amt="1800";
$sub_orders->deal_price="900";
$sub_orders->index="1";
$sub_orders->item_barcode="104142058";
$sub_orders->item_code="104142058";
$sub_orders->item_name="水果";
$sub_orders->member_discount="0";
$sub_orders->original_price="1000";
$sub_orders->pos_no="POS001";
$sub_orders->promotion_discount="200";
$sub_orders->quantity="2";
$sub_orders->scan_barcode="104142058";
$sub_orders->selling_price="1800";
$sub_orders->serial_num="2018010110002_1";
$sub_orders->store_id="33571001";
$sub_orders->temporary_discount="0";
$sub_orders->unit="kg";
$receipt_order->sub_orders = $sub_orders;
$receipt_order->trd_time="2017-07-12 00:00:00";
$receipt_order->trd_type="1";
$receipt_order->order_from="RENRENLE";
$receipt_order->merchant_code="HM";
$receipt_order->ali_userid="AAA_12345";
$req->setReceiptOrder(json_encode($receipt_order));
$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=alibaba.wdk.order.sync' \
-d 'partner_id=apidoc' \
-d 'sign=EB8EA6AA6C9EAEBD1B29AF81C79F96B6' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+22%3A20%3A36' \
-d 'v=2.0' \
-d 'receipt_order=null'

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

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

req.receipt_order=""
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,"alibaba.wdk.order.sync");
add_param(pRequest,"receipt_order","数据结构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('alibaba.wdk.order.sync', {
	'receipt_order':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_order_sync_response>
    <is_success>true</is_success>
    <return_code></return_code>
    <message></message>
    <target>482918113761640789</target>
</alibaba_wdk_order_sync_response>

{
    "alibaba_wdk_order_sync_response":{
        "is_success":true,
        "return_code":,
        "message":"",
        "target":"482918113761640789"
    }
}

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

alibaba.wdk.order.sync (五道口外部订单同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈