淘宝开放平台 - 文档中心

请求地址：

环境	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	Struct []	可选		最大列表长度：20
orderInfo Struct 可选 └ orderCode String 必须 code2949384 小票编码 └ posCode String 必须 TERMINAL2425 POS终端编码 └ storeCode String 必须 STORECODE03275083 门店编码 └ orgCode String 可选 hz0001 组织编码 └ operatorCode String 可选 employee0012 收银员编码 └ operatorName String 可选 bobo 收银员名称 └ VIPCode String 必须 vip2750275 VIP会员编码 └ VIPCardNo String 可选 card23652965 VIP的卡号编码 └ VIPName String 可选 snow VIP名称 └ totalAmount String 必须 1000 整单金额 └ totalQty Number 必须 2 整单的商品总数 └ discount String 必须 0.9000 折扣 └ standardAmount String 必须 200 标准金额 └ roundingAmount String 必须 200 抹零金额 └ paidAmount String 必须 200 收款金额 └ change String 必须 0 找零金额 └ saleDate String 可选 YYYY-MM-DD 销售日期 └ orderDate String 可选 YYYY-MM-DD 开票日期 └ orderCreateTime String 可选 YYYY-MM-DD HH:MM:SS 单据创建时间 orderLine Struct [] 可选 └ orderLineNo String 可选 1479247 单据行号 └ productCode String 可选 SPU178673 商品spu编码 └ itemCode String 必须 SKUEWRYU178673 商品sku编码 └ itemName String 可选女夏季短袖商品名称 └ skuProperty String 必须如红色 XXL 商品属性 └ color String 可选 red 颜色编码 └ size String 可选 XXL 尺码编码 └ standardPrice String 必须 200 标准价 └ referencePrice String 必须 150 参考价 └ retailPrice String 可选 120 零售价 └ discount String 可选 0.9000 折扣 └ quantity Number 必须 50 销售数量 └ standardAmount String 必须 1000 标准金额 └ settlementAmount String 可选 900 结算金额 └ locationCode String 可选 eroueo13141 门店商品的库位 payment Struct [] 可选 └ paymentType String 必须 CASH=现金 ALIPAY=支付宝 WECHATPAY=微信支付 UNIONPAY=银联 OTHER=其他支付类型 └ amount String 必须 900 结算金额 └ paidAmount String 必须 900 收款金额 └ currency String 可选 RMB=人民币USD=美元币制
customerid	String	必须	A12345	最大长度：50	指定路由参数

名称	类型	示例值	描述
flag	String	success\|failure	响应结果
code	String	errorcode	响应码
message	String	msg	响应信息
receipt	Struct []
orderInfo Struct └ orderCode String code2949384 小票编码 └ posCode String TERMINAL2425 POS终端编码 └ storeCode String STORECODE03275083 门店编码

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
TaobaoPosReceiptSynchronizeRequest req = new TaobaoPosReceiptSynchronizeRequest();
List<TaobaoPosReceiptSynchronizeRequest.Struct> list2 = new ArrayList<TaobaoPosReceiptSynchronizeRequest.Struct>();
TaobaoPosReceiptSynchronizeRequest.Struct obj3 = new TaobaoPosReceiptSynchronizeRequest.Struct();
list2.add(obj3);
TaobaoPosReceiptSynchronizeRequest.Struct obj5 = new TaobaoPosReceiptSynchronizeRequest.Struct();
obj5.setOrderCode("code2949384");
obj5.setPosCode("TERMINAL2425");
obj5.setStoreCode("STORECODE03275083");
obj5.setOrgCode("hz0001");
obj5.setOperatorCode("employee0012");
obj5.setOperatorName("bobo");
obj5.setIPCode("vip2750275");
obj5.setIPCardNo("card23652965");
obj5.setIPName("snow");
obj5.setTotalAmount("1000");
obj5.setTotalQty(2L);
obj5.setDiscount("0.9000");
obj5.setStandardAmount("200");
obj5.setRoundingAmount("200");
obj5.setPaidAmount("200");
obj5.setChange("0");
obj5.setSaleDate("YYYY-MM-DD");
obj5.setOrderDate("YYYY-MM-DD");
obj5.setOrderCreateTime("YYYY-MM-DD HH:MM:SS");
list4.setOrderInfo(obj5);
List<TaobaoPosReceiptSynchronizeRequest.Struct> list8 = new ArrayList<TaobaoPosReceiptSynchronizeRequest.Struct>();
TaobaoPosReceiptSynchronizeRequest.Struct obj9 = new TaobaoPosReceiptSynchronizeRequest.Struct();
list8.add(obj9);
obj9.setOrderLineNo("1479247");
obj9.setProductCode("SPU178673");
obj9.setItemCode("SKUEWRYU178673");
obj9.setItemName("女夏季短袖");
obj9.setSkuProperty("如红色 XXL");
obj9.setColor("red");
obj9.setSize("XXL");
obj9.setStandardPrice("200");
obj9.setReferencePrice("150");
obj9.setRetailPrice("120");
obj9.setDiscount("0.9000");
obj9.setQuantity(50L);
obj9.setStandardAmount("1000");
obj9.setSettlementAmount("900");
obj9.setLocationCode("eroueo13141");
list6.setOrderLine(list8);
List<TaobaoPosReceiptSynchronizeRequest.Struct> list12 = new ArrayList<TaobaoPosReceiptSynchronizeRequest.Struct>();
TaobaoPosReceiptSynchronizeRequest.Struct obj13 = new TaobaoPosReceiptSynchronizeRequest.Struct();
list12.add(obj13);
obj13.setPaymentType("CASH=现金 ALIPAY=支付宝 WECHATPAY=微信支付 UNIONPAY=银联 OTHER=其他");
obj13.setAmount("900");
obj13.setPaidAmount("900");
obj13.setCurrency("RMB=人民币USD=美元");
list10.setPayment(list12);
req.setReceipt(list2);
req.setCustomerid("A12345");
TaobaoPosReceiptSynchronizeResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TaobaoPosReceiptSynchronizeRequest req = new TaobaoPosReceiptSynchronizeRequest();
List<TaobaoPosReceiptSynchronizeRequest.StructDomain> list2 = new List<TaobaoPosReceiptSynchronizeRequest.StructDomain>();
TaobaoPosReceiptSynchronizeRequest.StructDomain obj3 = new TaobaoPosReceiptSynchronizeRequest.StructDomain();
list2.Add(obj3);
TaobaoPosReceiptSynchronizeRequest.StructDomain obj4 = new TaobaoPosReceiptSynchronizeRequest.StructDomain();
obj4.OrderCode = "code2949384";
obj4.PosCode = "TERMINAL2425";
obj4.StoreCode = "STORECODE03275083";
obj4.OrgCode = "hz0001";
obj4.OperatorCode = "employee0012";
obj4.OperatorName = "bobo";
obj4.IPCode = "vip2750275";
obj4.IPCardNo = "card23652965";
obj4.IPName = "snow";
obj4.TotalAmount = "1000";
obj4.TotalQty = 2L;
obj4.Discount = "0.9000";
obj4.StandardAmount = "200";
obj4.RoundingAmount = "200";
obj4.PaidAmount = "200";
obj4.Change = "0";
obj4.SaleDate = "YYYY-MM-DD";
obj4.OrderDate = "YYYY-MM-DD";
obj4.OrderCreateTime = "YYYY-MM-DD HH:MM:SS";
obj3.OrderInfo= obj4;
List<TaobaoPosReceiptSynchronizeRequest.StructDomain> list6 = new List<TaobaoPosReceiptSynchronizeRequest.StructDomain>();
TaobaoPosReceiptSynchronizeRequest.StructDomain obj7 = new TaobaoPosReceiptSynchronizeRequest.StructDomain();
list6.Add(obj7);
obj7.OrderLineNo = "1479247";
obj7.ProductCode = "SPU178673";
obj7.ItemCode = "SKUEWRYU178673";
obj7.ItemName = "女夏季短袖";
obj7.SkuProperty = "如红色 XXL";
obj7.Color = "red";
obj7.Size = "XXL";
obj7.StandardPrice = "200";
obj7.ReferencePrice = "150";
obj7.RetailPrice = "120";
obj7.Discount = "0.9000";
obj7.Quantity = 50L;
obj7.StandardAmount = "1000";
obj7.SettlementAmount = "900";
obj7.LocationCode = "eroueo13141";
obj3.OrderLine= list6;
List<TaobaoPosReceiptSynchronizeRequest.StructDomain> list9 = new List<TaobaoPosReceiptSynchronizeRequest.StructDomain>();
TaobaoPosReceiptSynchronizeRequest.StructDomain obj10 = new TaobaoPosReceiptSynchronizeRequest.StructDomain();
list9.Add(obj10);
obj10.PaymentType = "CASH=现金 ALIPAY=支付宝 WECHATPAY=微信支付 UNIONPAY=银联 OTHER=其他";
obj10.Amount = "900";
obj10.PaidAmount = "900";
obj10.Currency = "RMB=人民币USD=美元";
obj3.Payment= list9;
req.Receipt_ = list2;
req.Customerid = "A12345";
TaobaoPosReceiptSynchronizeResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TaobaoPosReceiptSynchronizeRequest;
$receipt = new Struct;
$orderInfo = new Struct;
$orderInfo->order_code="code2949384";
$orderInfo->pos_code="TERMINAL2425";
$orderInfo->store_code="STORECODE03275083";
$orderInfo->org_code="hz0001";
$orderInfo->operator_code="employee0012";
$orderInfo->operator_name="bobo";
$orderInfo->v_i_p_code="vip2750275";
$orderInfo->v_i_p_card_no="card23652965";
$orderInfo->v_i_p_name="snow";
$orderInfo->total_amount="1000";
$orderInfo->total_qty="2";
$orderInfo->discount="0.9000";
$orderInfo->standard_amount="200";
$orderInfo->rounding_amount="200";
$orderInfo->paid_amount="200";
$orderInfo->change="0";
$orderInfo->sale_date="YYYY-MM-DD";
$orderInfo->order_date="YYYY-MM-DD";
$orderInfo->order_create_time="YYYY-MM-DD HH:MM:SS";
$receipt->orderInfo = $orderInfo;
$orderLine = new Struct;
$orderLine->order_line_no="1479247";
$orderLine->product_code="SPU178673";
$orderLine->item_code="SKUEWRYU178673";
$orderLine->item_name="女夏季短袖";
$orderLine->sku_property="如红色 XXL";
$orderLine->color="red";
$orderLine->size="XXL";
$orderLine->standard_price="200";
$orderLine->reference_price="150";
$orderLine->retail_price="120";
$orderLine->discount="0.9000";
$orderLine->quantity="50";
$orderLine->standard_amount="1000";
$orderLine->settlement_amount="900";
$orderLine->location_code="eroueo13141";
$receipt->orderLine = $orderLine;
$payment = new Struct;
$payment->payment_type="CASH=现金 ALIPAY=支付宝 WECHATPAY=微信支付 UNIONPAY=银联 OTHER=其他";
$payment->amount="900";
$payment->paid_amount="900";
$payment->currency="RMB=人民币USD=美元";
$receipt->payment = $payment;
$req->setReceipt(json_encode($receipt));
$req->setCustomerid("A12345");
$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.receipt.synchronize' \
-d 'partner_id=apidoc' \
-d 'session=aefc7031-f08f-400a-9e3f-e19785c67830' \
-d 'sign=A754B5F2BA4EBC1ED227EB73EF94CEDB' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+16%3A46%3A59' \
-d 'v=2.0' \
-d 'customerid=A12345' \
-d 'receipt=null'

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

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

req.receipt="null"
req.customerid="A12345"
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.receipt.synchronize");
add_param(pRequest,"receipt","数据结构JSON示例");
add_param(pRequest,"customerid","A12345");
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.receipt.synchronize', {
	'receipt':'数据结构JSON示例',
	'customerid':'A12345'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<flag>success|failure</flag>
<code>errorcode</code>
<message>msg</message>
<receipt>
    <struct>
        <orderInfo>
            <orderCode>code2949384</orderCode>
            <posCode>TERMINAL2425</posCode>
            <storeCode>STORECODE03275083</storeCode>
        </orderInfo>
    </struct>
</receipt>

{
    "flag":"success|failure",
    "code":"errorcode",
    "message":"msg",
    "receipt":{
        "struct":[
            {
                "orderInfo":{
                    "orderCode":"code2949384",
                    "posCode":"TERMINAL2425",
                    "storeCode":"STORECODE03275083"
                }
            }
        ]
    }
}

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.receipt.synchronize (小票同步接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ