淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
pos_order	PosOrderDto	必须			订单数据
└ extend_params String 可选 {"abc":"123"} 扩展信息。 └ logistics_way Number 必须 1 配送方式：1 : 门店自提，2 ：物流到家 └ mall_no String 必须 HZ01 门店号 └ member_card_no String 可选 111111122222 会员卡号 └ operator String 可选 111 操作员 └ order_type Number 必须 0 交易类别：0 : 收银 1 ：退款 └ out_trade_no String 必须 HZ01111222333 POS交易流水号 payments PosPaymentDto [] 必须支付列表 └ extend_params String 可选 {"abc":"123",isManual:true} 扩展参数。注：POS中的支付大类、小类，通过extendParams传。支付大类属性名： paymentType，支付小类属性名： paymentSubType。 └ payment_amount Number 必须 9000 支付/优惠金额,单位：分 └ payment_code String 必须 C01 支付代码 └ payment_line_no Number 必须 1 支付行号 └ payment_name String 可选现金支付名称 └ payment_no String 可选 2017032100001111 支付流水号 └ pay_type Number 可选 1 1:支付，2:优惠 sale_items PosSaleItemDto [] 必须订单商品列表 └ discount_amount Number 必须 1000 折扣金额，单位：分 └ extend_params String 可选 {"abc":"123"} 扩展参数 └ goods_id String 必须 111 商品ID └ goods_line_no Number 必须 1 商品行号 └ goods_name String 可选测试商品商品名称 └ item_type String 必须 C 商品类型： N：老单品；Y：喵货；C：云单品；M：零售+ └ mall_no String 必须 HZ01 门店号 └ ori_price Number 必须 10000 商品原价，单位：分 └ pay_amount Number 必须 9000 应付金额，单位：分 └ quantity String 必须 1 数量，可小数点 └ sale_ticket_no String 可选 A111 开票单号（） └ settle_code String 可选 111222 结算码（退款的时候必须有） └ shop_no String 必须 1001 专柜号 └ unique_code String 可选 1112222 唯一码 split_promotions PosSplitPromotionDto [] 可选优惠分摊列表 └ coupon_code String 可选 1002 券码 └ goods_line_no Number 可选 1 商品行号，必须 └ payment_line_no Number 可选 1 支付行号,必须 └ settle_code String 可选 1111 结算码 └ split_amount Number 可选 1000 分摊金额，必须 └ pay_time String 可选 2017-03-21 12:12:12 该支付方式支付时间 └ payment String 可选 E0 大支付方式 └ sub_payment String 可选 22 小支付方式 └ pay_type Number 可选 1 1:支付，2:优惠 └ extend_params String 可选 {iaManual:true} 是否压卡 └ total_amount Number 可选 100000 订单金额，单位分 └ trade_no String 可选 201703210000111112 OC交易流水号 └ pay_time String 必须 2017-03-21 12:12:12 付款/退款时间 └ out_refund_no String 可选 11112222 退款流水号（退款时必须有） └ member_mobile_phone String 可选 18900008888 会员手机号 └ sale_channle Number 可选 1 订单来源 └ terminal_no String 可选 344 收银机号

名称	类型	示例值	描述
out_trade_no	String	HZ011000011111	POS交易号
ex_code	Number		errCode
ex_msg	String		errMsg
is_success	Boolean	true	success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMjOcPayRequest req = new AlibabaMjOcPayRequest();
AlibabaMjOcPayRequest.PosOrderDto obj1 = new AlibabaMjOcPayRequest.PosOrderDto();
obj1.setExtendParams("{\"abc\":\"123\"}");
obj1.setLogisticsWay(1L);
obj1.setMallNo("HZ01");
obj1.setMemberCardNo("111111122222");
obj1.setOperator("111");
obj1.setOrderType(0L);
obj1.setOutTradeNo("HZ01111222333");
List<AlibabaMjOcPayRequest.PosPaymentDto> list3 = new ArrayList<AlibabaMjOcPayRequest.PosPaymentDto>();
AlibabaMjOcPayRequest.PosPaymentDto obj4 = new AlibabaMjOcPayRequest.PosPaymentDto();
list3.add(obj4);
obj4.setExtendParams("{\"abc\":\"123\",isManual:true}");
obj4.setPaymentAmount(9000L);
obj4.setPaymentCode("C01");
obj4.setPaymentLineNo(1L);
obj4.setPaymentName("现金");
obj4.setPaymentNo("2017032100001111");
obj4.setPayType(1L);
obj1.setPayments(list3);
List<AlibabaMjOcPayRequest.PosSaleItemDto> list6 = new ArrayList<AlibabaMjOcPayRequest.PosSaleItemDto>();
AlibabaMjOcPayRequest.PosSaleItemDto obj7 = new AlibabaMjOcPayRequest.PosSaleItemDto();
list6.add(obj7);
obj7.setDiscountAmount(1000L);
obj7.setExtendParams("{\"abc\":\"123\"}");
obj7.setGoodsId("111");
obj7.setGoodsLineNo(1L);
obj7.setGoodsName("测试商品");
obj7.setItemType("C");
obj7.setMallNo("HZ01");
obj7.setOriPrice(10000L);
obj7.setPayAmount(9000L);
obj7.setQuantity("1");
obj7.setSaleTicketNo("A111");
obj7.setSettleCode("111222");
obj7.setShopNo("1001");
obj7.setUniqueCode("1112222");
obj1.setSaleItems(list6);
List<AlibabaMjOcPayRequest.PosSplitPromotionDto> list9 = new ArrayList<AlibabaMjOcPayRequest.PosSplitPromotionDto>();
AlibabaMjOcPayRequest.PosSplitPromotionDto obj10 = new AlibabaMjOcPayRequest.PosSplitPromotionDto();
list9.add(obj10);
obj10.setCouponCode("1002");
obj10.setGoodsLineNo(1L);
obj10.setPaymentLineNo(1L);
obj10.setSettleCode("1111");
obj10.setSplitAmount(1000L);
obj10.setPayTime("2017-03-21 12:12:12");
obj10.setPayment("E0");
obj10.setSubPayment("22");
obj10.setPayType(1L);
obj10.setExtendParams("{iaManual:true}");
obj1.setSplitPromotions(list9);
obj1.setTotalAmount(100000L);
obj1.setTradeNo("201703210000111112");
obj1.setPayTime("2017-03-21 12:12:12");
obj1.setOutRefundNo("11112222");
obj1.setMemberMobilePhone("18900008888");
obj1.setSaleChannle(1L);
obj1.setTerminalNo("344");
req.setPosOrder(obj1);
AlibabaMjOcPayResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMjOcPayRequest req = new AlibabaMjOcPayRequest();
AlibabaMjOcPayRequest.PosOrderDtoDomain obj1 = new AlibabaMjOcPayRequest.PosOrderDtoDomain();
obj1.ExtendParams = "{\"abc\":\"123\"}";
obj1.LogisticsWay = 1L;
obj1.MallNo = "HZ01";
obj1.MemberCardNo = "111111122222";
obj1.Operator = "111";
obj1.OrderType = 0L;
obj1.OutTradeNo = "HZ01111222333";
List<AlibabaMjOcPayRequest.PosPaymentDtoDomain> list3 = new List<AlibabaMjOcPayRequest.PosPaymentDtoDomain>();
AlibabaMjOcPayRequest.PosPaymentDtoDomain obj4 = new AlibabaMjOcPayRequest.PosPaymentDtoDomain();
list3.Add(obj4);
obj4.ExtendParams = "{\"abc\":\"123\",isManual:true}";
obj4.PaymentAmount = 9000L;
obj4.PaymentCode = "C01";
obj4.PaymentLineNo = 1L;
obj4.PaymentName = "现金";
obj4.PaymentNo = "2017032100001111";
obj4.PayType = 1L;
obj1.Payments= list3;
List<AlibabaMjOcPayRequest.PosSaleItemDtoDomain> list6 = new List<AlibabaMjOcPayRequest.PosSaleItemDtoDomain>();
AlibabaMjOcPayRequest.PosSaleItemDtoDomain obj7 = new AlibabaMjOcPayRequest.PosSaleItemDtoDomain();
list6.Add(obj7);
obj7.DiscountAmount = 1000L;
obj7.ExtendParams = "{\"abc\":\"123\"}";
obj7.GoodsId = "111";
obj7.GoodsLineNo = 1L;
obj7.GoodsName = "测试商品";
obj7.ItemType = "C";
obj7.MallNo = "HZ01";
obj7.OriPrice = 10000L;
obj7.PayAmount = 9000L;
obj7.Quantity = "1";
obj7.SaleTicketNo = "A111";
obj7.SettleCode = "111222";
obj7.ShopNo = "1001";
obj7.UniqueCode = "1112222";
obj1.SaleItems= list6;
List<AlibabaMjOcPayRequest.PosSplitPromotionDtoDomain> list9 = new List<AlibabaMjOcPayRequest.PosSplitPromotionDtoDomain>();
AlibabaMjOcPayRequest.PosSplitPromotionDtoDomain obj10 = new AlibabaMjOcPayRequest.PosSplitPromotionDtoDomain();
list9.Add(obj10);
obj10.CouponCode = "1002";
obj10.GoodsLineNo = 1L;
obj10.PaymentLineNo = 1L;
obj10.SettleCode = "1111";
obj10.SplitAmount = 1000L;
obj10.PayTime = "2017-03-21 12:12:12";
obj10.Payment = "E0";
obj10.SubPayment = "22";
obj10.PayType = 1L;
obj10.ExtendParams = "{iaManual:true}";
obj1.SplitPromotions= list9;
obj1.TotalAmount = 100000L;
obj1.TradeNo = "201703210000111112";
obj1.PayTime = "2017-03-21 12:12:12";
obj1.OutRefundNo = "11112222";
obj1.MemberMobilePhone = "18900008888";
obj1.SaleChannle = 1L;
obj1.TerminalNo = "344";
req.PosOrder_ = obj1;
AlibabaMjOcPayResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMjOcPayRequest;
$pos_order = new PosOrderDto;
$pos_order->extend_params="{\"abc\":\"123\"}";
$pos_order->logistics_way="1";
$pos_order->mall_no="HZ01";
$pos_order->member_card_no="111111122222";
$pos_order->operator="111";
$pos_order->order_type="0";
$pos_order->out_trade_no="HZ01111222333";
$payments = new PosPaymentDto;
$payments->extend_params="{\"abc\":\"123\",isManual:true}";
$payments->payment_amount="9000";
$payments->payment_code="C01";
$payments->payment_line_no="1";
$payments->payment_name="现金";
$payments->payment_no="2017032100001111";
$payments->pay_type="1";
$pos_order->payments = $payments;
$sale_items = new PosSaleItemDto;
$sale_items->discount_amount="1000";
$sale_items->extend_params="{\"abc\":\"123\"}";
$sale_items->goods_id="111";
$sale_items->goods_line_no="1";
$sale_items->goods_name="测试商品";
$sale_items->item_type="C";
$sale_items->mall_no="HZ01";
$sale_items->ori_price="10000";
$sale_items->pay_amount="9000";
$sale_items->quantity="1";
$sale_items->sale_ticket_no="A111";
$sale_items->settle_code="111222";
$sale_items->shop_no="1001";
$sale_items->unique_code="1112222";
$pos_order->sale_items = $sale_items;
$split_promotions = new PosSplitPromotionDto;
$split_promotions->coupon_code="1002";
$split_promotions->goods_line_no="1";
$split_promotions->payment_line_no="1";
$split_promotions->settle_code="1111";
$split_promotions->split_amount="1000";
$split_promotions->pay_time="2017-03-21 12:12:12";
$split_promotions->payment="E0";
$split_promotions->sub_payment="22";
$split_promotions->pay_type="1";
$split_promotions->extend_params="{iaManual:true}";
$pos_order->split_promotions = $split_promotions;
$pos_order->total_amount="100000";
$pos_order->trade_no="201703210000111112";
$pos_order->pay_time="2017-03-21 12:12:12";
$pos_order->out_refund_no="11112222";
$pos_order->member_mobile_phone="18900008888";
$pos_order->sale_channle="1";
$pos_order->terminal_no="344";
$req->setPosOrder(json_encode($pos_order));
$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.mj.oc.pay' \
-d 'partner_id=apidoc' \
-d 'session=ca8cd5e5-47a6-40ff-8adb-531d0fcded07' \
-d 'sign=54CC08AA1F366147E95A55B0FD9888AC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-04+12%3A05%3A00' \
-d 'v=2.0' \
-d 'pos_order=null'

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

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

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

XML示例
JSON示例

<alibaba_mj_oc_pay_response>
    <out_trade_no>HZ011000011111</out_trade_no>
    <ex_code></ex_code>
    <ex_msg></ex_msg>
    <is_success>true</is_success>
</alibaba_mj_oc_pay_response>

{
    "alibaba_mj_oc_pay_response":{
        "out_trade_no":"HZ011000011111",
        "ex_code":,
        "ex_msg":"",
        "is_success":true
    }
}

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.mj.oc.pay (POS收银成功后订单同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ