淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
onsite_service_purchase_info_request	OnsiteServicePurchaseInfoRequest	可选			请求
└ workcard_id Number 必须 123 工单id └ worker_id Number 必须 123 工人id └ worker_memo String 必须 xxx 工人备注 └ negotiate_price Number 可选 123 协商金额 item_infos OnsiteServicePurchaseItemInfoRequest [] 必须 xxx 下单信息 └ item_id Number 必须 1 收费项id └ quantity Number 必须 1 收费项数量

名称	类型	示例值	描述
result	Result		结果
value GetOnsiteServiceTradeOrderUrlResponse 返回数据 └ qr_code_url String xxx 下单二维码 └ success Boolean true 是否成功 └ msg_code String xxx 错误码 └ msg_info String xxx 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaHomeOnsiteserviceTradeGeturlRequest req = new AlibabaHomeOnsiteserviceTradeGeturlRequest();
AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseInfoRequest obj1 = new AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseInfoRequest();
obj1.setWorkcardId(123L);
obj1.setWorkerId(123L);
obj1.setWorkerMemo("xxx");
obj1.setNegotiatePrice(123L);
List<AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseItemInfoRequest> list3 = new ArrayList<AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseItemInfoRequest>();
AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseItemInfoRequest obj4 = new AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseItemInfoRequest();
list3.add(obj4);
obj4.setItemId(1L);
obj4.setQuantity(1L);
obj1.setItemInfos(list3);
req.setOnsiteServicePurchaseInfoRequest(obj1);
AlibabaHomeOnsiteserviceTradeGeturlResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaHomeOnsiteserviceTradeGeturlRequest req = new AlibabaHomeOnsiteserviceTradeGeturlRequest();
AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseInfoRequestDomain obj1 = new AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseInfoRequestDomain();
obj1.WorkcardId = 123L;
obj1.WorkerId = 123L;
obj1.WorkerMemo = "xxx";
obj1.NegotiatePrice = 123L;
List<AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseItemInfoRequestDomain> list3 = new List<AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseItemInfoRequestDomain>();
AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseItemInfoRequestDomain obj4 = new AlibabaHomeOnsiteserviceTradeGeturlRequest.OnsiteServicePurchaseItemInfoRequestDomain();
list3.Add(obj4);
obj4.ItemId = 1L;
obj4.Quantity = 1L;
obj1.ItemInfos= list3;
req.OnsiteServicePurchaseInfoRequest_ = obj1;
AlibabaHomeOnsiteserviceTradeGeturlResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaHomeOnsiteserviceTradeGeturlRequest;
$onsite_service_purchase_info_request = new OnsiteServicePurchaseInfoRequest;
$onsite_service_purchase_info_request->workcard_id="123";
$onsite_service_purchase_info_request->worker_id="123";
$onsite_service_purchase_info_request->worker_memo="xxx";
$onsite_service_purchase_info_request->negotiate_price="123";
$item_infos = new OnsiteServicePurchaseItemInfoRequest;
$item_infos->item_id="1";
$item_infos->quantity="1";
$onsite_service_purchase_info_request->item_infos = $item_infos;
$req->setOnsiteServicePurchaseInfoRequest(json_encode($onsite_service_purchase_info_request));
$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.home.onsiteservice.trade.geturl' \
-d 'partner_id=apidoc' \
-d 'session=e0567634-e037-414b-b59a-b1454e8c48a6' \
-d 'sign=E3FF555987AF896B7BCC4D9B8F50E855' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-03-19+18%3A40%3A33' \
-d 'v=2.0' \
-d 'onsite_service_purchase_info_request=null'

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

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

req.onsite_service_purchase_info_request="数据结构示例JSON格式"
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.home.onsiteservice.trade.geturl");
add_param(pRequest,"onsite_service_purchase_info_request","数据结构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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.home.onsiteservice.trade.geturl', {
	'onsite_service_purchase_info_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_home_onsiteservice_trade_geturl_response>
    <result>
        <value>
            <qr_code_url>xxx</qr_code_url>
        </value>
        <success>true</success>
        <msg_code>xxx</msg_code>
        <msg_info>xxx</msg_info>
    </result>
</alibaba_home_onsiteservice_trade_geturl_response>

{
    "alibaba_home_onsiteservice_trade_geturl_response":{
        "result":{
            "value":{
                "qr_code_url":"xxx"
            },
            "success":true,
            "msg_code":"xxx",
            "msg_info":"xxx"
        }
    }
}

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.home.onsiteservice.trade.geturl (增值服务线下收费线上化-获取下单二维码)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ