淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
service_store_id	Number	可选	123	门店/网点id
identify_code	String	可选	123456789	核销码
id	Number	可选	123456	工单id
gmt_create_start	Date	可选	2019-02-24 10:00:00	工单创建开始时间
gmt_create_end	Date	可选	2019-02-24 10:15:00	工单创建结束时间，必须与工单创建开始时间一起传入，且间隔不超过15分钟
biz_order_id	Number	可选	1234567	淘宝交易订单号。主订单或子订单均可
current_page	Number	可选	1	当前页数
page_size	Number	可选	50	每页大小

名称	类型	示例值	描述
result	Result		接口返回model
result_data PagedResult 分页数据 data_list Workcard [] 工单列表 └ gmt_sign_in Date 1550669060000 签到时间 └ used_service_count Number 0 已使用的次数 service_trade_order ServiceTradeOrder 服务订单数据 └ outer_id_sku String 123 服务商品的商家编码 └ sku_desc String 颜色:红色服务商品的sku描述 └ sku_id Number 123 服务商品的sku id └ order_id Number 1312322222 订单id └ buy_amount Number 5 购买数量 └ b2b_price_unit Number 服务的售卖价 └ parent_order_id Number 主订单号 └ outer_id_p String 商家编码 └ price Number 商品价格 └ purchase_price_unit Number 11 服务的采购价 └ service_count Number 1 工单服务总次数 └ status_code String create 工单状态编码 └ id Number 3203003 工单id └ left_service_count Number 1 剩余次数 └ parent_biz_order_id Number 1213132343232 主订单号 service_provider ServiceProvider 服务提供者 └ tp_nick String tbtest1063 服务商昵称 └ tp_id Number 65753805 服务商id └ isv_tp_id Number abc isv服务商 └ isv_tp_name String 331 isv服务商 └ gmt_identify Date 1550669060000 核销时间 └ gmt_reserve_start Date 1550669060000 预约时间开始 master_trade_order MasterTradeOrder 实物订单信息 └ outer_id_sku String 123 商家编码 └ sku_desc String 颜色:红色 sku描述 └ sku_id Number 123 sku id └ outer_id_p String 12345 商品编码 └ parent_order_id Number 主订单号 └ order_id Number 12343 订单id └ buy_amount Number 5 购买数量 └ price Number 商品价格 service_definition ServiceDefinition 服务定义 └ biz_code String car_accessory_install 业务类型 └ service_code String 轮胎安装服务类型 └ buyer_expect_date Date 买家期望服务时间 └ sequence Number 1 核销/工单完结请求中直接带回该字段 └ sp_service_order_id Number 12345 服务单id └ gmt_assign_worker Date 分配工人时间 └ gmt_reserve_end Date 1550669060000 预约结束时间 └ gmt_create Date 工单创建时间 └ attribute_map String { servPrice: 5696, newService: true, lbxNo: LP00456451474997, discountFee: 0, reserveSource: tp, serviceDate: 1625720400000, gmtExpire: 2031-07-0516: 10: 31, bizCode: ikea_service, 型号: IKEA00000237S, serviceAuctionTitle: 上门安装, reserveTimeEnd: 1625734800000, reassign: false, masterSkuId: 4481237091387, serviceSkuDesc: , operator: 2, settlement: true, mainServiceOrder: true, signedTime: WedJul0715: 07: 27CST2021, masterAuctionTitle: IKEA宜家BILLY毕利OXBERG奥克伯落地书架置物柜书柜带门现代简约, msfRervDate: 2021-07-08, 类目: 书架, 品牌: IKEA/宜家, auctionImageUrl: https: //img.alicdn.com/imgextra/i4/2207239419714/O1CN011IWwRA2Ld3y2vIubI_!!2207239419714.jpg, masterSkuDesc: 颜色分类: 白色, af: 6000, auto_dispatch_order: false, usedServiceCount: 0, reserveTimeStart: 1625720400000, masterParentOrderId: 1345315513309428776, address_city: 青岛市, reserveRemark: JO21070659183965已调度, 父类目: 架类, arrivalTimeNum: 1625641647000, outerIdSKU: 09184486 } 额外属性，包含：{ servPrice: 服务采购价, newService: 切服务化之后的服务单标识, lbxNo: 淘宝的物流订单号, discountFee: 优惠金额, reserveSource: 预约来源, serviceDate: 预约时间, gmtExpire: 过期时间, bizCode: 业务身份, 型号: IKEA00000237S, serviceAuctionTitle: 服务商品标题, reserveTimeEnd: 预约时间段的结束时间, reassign: 是否是改派工单, masterSkuId: 实物sku id, serviceSkuDesc: 服务sku描述, operator: 工单预约操作者 1表示消费者主动预约，2表示服务回传预约时间, settlement: 是否进行线上结算, mainServiceOrder: 双主服务主订单key, signedTime: 签收时间, masterAuctionTitle: 实物商品标题, msfRervDate: 瞄师傅预约日期, 类目: 书架, 品牌: IKEA/宜家, auctionImageUrl: 实物图片链接, masterSkuDesc: 实物sku描述, af: 交易订单实付金额, auto_dispatch_order: 是否智能派单, usedServiceCount: "工单总使用次数", reserveTimeStart: 预约时间段的开始时间, masterParentOrderId: 实物订单主订单, address_city: 买家城市, reserveRemark: 预约备注, 父类目: 架类, arrivalTimeNum: 物品签收时间, outerIdSKU: 商家编码 } └ total_page_count Number 1 总页数 └ total_count Number 1 总数 └ page_size Number 20 每页大小 └ msg_code String xxx 错误码 └ msg_info String xxx 错误信息 └ success Boolean true 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallServicecenterWorkcardQuerybysellerRequest req = new TmallServicecenterWorkcardQuerybysellerRequest();
req.setServiceStoreId(123L);
req.setIdentifyCode("123456789");
req.setId(123456L);
req.setGmtCreateStart(StringUtils.parseDateTime("2019-02-24 10:00:00"));
req.setGmtCreateEnd(StringUtils.parseDateTime("2019-02-24 10:15:00"));
req.setBizOrderId(1234567L);
req.setCurrentPage(1L);
req.setPageSize(50L);
TmallServicecenterWorkcardQuerybysellerResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallServicecenterWorkcardQuerybysellerRequest req = new TmallServicecenterWorkcardQuerybysellerRequest();
req.ServiceStoreId = 123L;
req.IdentifyCode = "123456789";
req.Id = 123456L;
req.GmtCreateStart = DateTime.Parse("2019-02-24 10:00:00");
req.GmtCreateEnd = DateTime.Parse("2019-02-24 10:15:00");
req.BizOrderId = 1234567L;
req.CurrentPage = 1L;
req.PageSize = 50L;
TmallServicecenterWorkcardQuerybysellerResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallServicecenterWorkcardQuerybysellerRequest;
$req->setServiceStoreId("123");
$req->setIdentifyCode("123456789");
$req->setId("123456");
$req->setGmtCreateStart("2019-02-24 10:00:00");
$req->setGmtCreateEnd("2019-02-24 10:15:00");
$req->setBizOrderId("1234567");
$req->setCurrentPage("1");
$req->setPageSize("50");
$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=tmall.servicecenter.workcard.querybyseller' \
-d 'partner_id=apidoc' \
-d 'session=1a741f9b-5cf2-4a05-a920-fcdd6e427539' \
-d 'sign=B2B09082024D2CC5AC5118EC340DB1BA' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A45%3A41' \
-d 'v=2.0' \
-d 'biz_order_id=1234567' \
-d 'current_page=1' \
-d 'gmt_create_end=2019-02-24+10%3A15%3A00' \
-d 'gmt_create_start=2019-02-24+10%3A00%3A00' \
-d 'id=123456' \
-d 'identify_code=123456789' \
-d 'page_size=50' \
-d 'service_store_id=123'

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

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

req.service_store_id=123
req.identify_code="123456789"
req.id=123456
req.gmt_create_start="2019-02-24 10:00:00"
req.gmt_create_end="2019-02-24 10:15:00"
req.biz_order_id=1234567
req.current_page=1
req.page_size=50
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,"tmall.servicecenter.workcard.querybyseller");
add_param(pRequest,"service_store_id","123");
add_param(pRequest,"identify_code","123456789");
add_param(pRequest,"id","123456");
add_param(pRequest,"gmt_create_start","2019-02-24 10:00:00");
add_param(pRequest,"gmt_create_end","2019-02-24 10:15:00");
add_param(pRequest,"biz_order_id","1234567");
add_param(pRequest,"current_page","1");
add_param(pRequest,"page_size","50");
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('tmall.servicecenter.workcard.querybyseller', {
	'service_store_id':'123',
	'identify_code':'123456789',
	'id':'123456',
	'gmt_create_start':'2019-02-24 10:00:00',
	'gmt_create_end':'2019-02-24 10:15:00',
	'biz_order_id':'1234567',
	'current_page':'1',
	'page_size':'50'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_servicecenter_workcard_querybyseller_response>
    <result>
        <result_data>
            <data_list>
                <workcard>
                    <gmt_sign_in>1550669060000</gmt_sign_in>
                    <used_service_count>0</used_service_count>
                    <service_trade_order>
                        <outer_id_sku>123</outer_id_sku>
                        <sku_desc>颜色:红色</sku_desc>
                        <sku_id>123</sku_id>
                        <order_id>1312322222</order_id>
                        <buy_amount>5</buy_amount>
                        <b2b_price_unit></b2b_price_unit>
                        <parent_order_id></parent_order_id>
                        <outer_id_p></outer_id_p>
                        <price></price>
                        <purchase_price_unit>11</purchase_price_unit>
                    </service_trade_order>
                    <service_count>1</service_count>
                    <status_code>create</status_code>
                    <id>3203003</id>
                    <left_service_count>1</left_service_count>
                    <parent_biz_order_id>1213132343232</parent_biz_order_id>
                    <service_provider>
                        <tp_nick>tbtest1063</tp_nick>
                        <tp_id>65753805</tp_id>
                        <isv_tp_id>abc</isv_tp_id>
                        <isv_tp_name>331</isv_tp_name>
                    </service_provider>
                    <gmt_identify>1550669060000</gmt_identify>
                    <gmt_reserve_start>1550669060000</gmt_reserve_start>
                    <master_trade_order>
                        <outer_id_sku>123</outer_id_sku>
                        <sku_desc>颜色:红色</sku_desc>
                        <sku_id>123</sku_id>
                        <outer_id_p>12345</outer_id_p>
                        <parent_order_id></parent_order_id>
                        <order_id>12343</order_id>
                        <buy_amount>5</buy_amount>
                        <price></price>
                    </master_trade_order>
                    <service_definition>
                        <biz_code>car_accessory_install</biz_code>
                        <service_code>轮胎安装</service_code>
                    </service_definition>
                    <buyer_expect_date></buyer_expect_date>
                    <sequence>1</sequence>
                    <sp_service_order_id>12345</sp_service_order_id>
                    <gmt_assign_worker></gmt_assign_worker>
                    <gmt_reserve_end>1550669060000</gmt_reserve_end>
                    <gmt_create></gmt_create>
                    <attribute_map>{   servPrice: 5696,   newService: true,   lbxNo: LP00456451474997,   discountFee: 0,   reserveSource: tp,   serviceDate: 1625720400000,   gmtExpire: 2031-07-0516: 10: 31,   bizCode: ikea_service,   型号: IKEA00000237S,   serviceAuctionTitle: 上门安装,   reserveTimeEnd: 1625734800000,   reassign: false,   masterSkuId: 4481237091387,   serviceSkuDesc: ,   operator: 2,   settlement: true,   mainServiceOrder: true,   signedTime: WedJul0715: 07: 27CST2021,   masterAuctionTitle: IKEA宜家BILLY毕利OXBERG奥克伯落地书架置物柜书柜带门现代简约,   msfRervDate: 2021-07-08,   类目: 书架,   品牌: IKEA/宜家,   auctionImageUrl: https: //img.alicdn.com/imgextra/i4/2207239419714/O1CN011IWwRA2Ld3y2vIubI_!!2207239419714.jpg,   masterSkuDesc: 颜色分类: 白色,   af: 6000,   auto_dispatch_order: false,   usedServiceCount: 0,   reserveTimeStart: 1625720400000,   masterParentOrderId: 1345315513309428776,   address_city: 青岛市,   reserveRemark: JO21070659183965已调度,   父类目: 架类,   arrivalTimeNum: 1625641647000,   outerIdSKU: 09184486 }</attribute_map>
                </workcard>
            </data_list>
            <total_page_count>1</total_page_count>
            <total_count>1</total_count>
            <page_size>20</page_size>
        </result_data>
        <msg_code>xxx</msg_code>
        <msg_info>xxx</msg_info>
        <success>true</success>
    </result>
</tmall_servicecenter_workcard_querybyseller_response>

{
    "tmall_servicecenter_workcard_querybyseller_response":{
        "result":{
            "result_data":{
                "data_list":{
                    "workcard":[
                        {
                            "gmt_sign_in":"1550669060000",
                            "used_service_count":0,
                            "service_trade_order":{
                                "outer_id_sku":"123",
                                "sku_desc":"颜色:红色",
                                "sku_id":123,
                                "order_id":1312322222,
                                "buy_amount":5,
                                "b2b_price_unit":,
                                "parent_order_id":,
                                "outer_id_p":"",
                                "price":,
                                "purchase_price_unit":11
                            },
                            "service_count":1,
                            "status_code":"create",
                            "id":3203003,
                            "left_service_count":1,
                            "parent_biz_order_id":1213132343232,
                            "service_provider":{
                                "tp_nick":"tbtest1063",
                                "tp_id":65753805,
                                "isv_tp_id":abc,
                                "isv_tp_name":"331"
                            },
                            "gmt_identify":"1550669060000",
                            "gmt_reserve_start":"1550669060000",
                            "master_trade_order":{
                                "outer_id_sku":"123",
                                "sku_desc":"颜色:红色",
                                "sku_id":123,
                                "outer_id_p":"12345",
                                "parent_order_id":,
                                "order_id":12343,
                                "buy_amount":5,
                                "price":
                            },
                            "service_definition":{
                                "biz_code":"car_accessory_install",
                                "service_code":"轮胎安装"
                            },
                            "buyer_expect_date":"",
                            "sequence":1,
                            "sp_service_order_id":12345,
                            "gmt_assign_worker":"",
                            "gmt_reserve_end":"1550669060000",
                            "gmt_create":"",
                            "attribute_map":"{   servPrice: 5696,   newService: true,   lbxNo: LP00456451474997,   discountFee: 0,   reserveSource: tp,   serviceDate: 1625720400000,   gmtExpire: 2031-07-0516: 10: 31,   bizCode: ikea_service,   型号: IKEA00000237S,   serviceAuctionTitle: 上门安装,   reserveTimeEnd: 1625734800000,   reassign: false,   masterSkuId: 4481237091387,   serviceSkuDesc: ,   operator: 2,   settlement: true,   mainServiceOrder: true,   signedTime: WedJul0715: 07: 27CST2021,   masterAuctionTitle: IKEA宜家BILLY毕利OXBERG奥克伯落地书架置物柜书柜带门现代简约,   msfRervDate: 2021-07-08,   类目: 书架,   品牌: IKEA\/宜家,   auctionImageUrl: https: \/\/img.alicdn.com\/imgextra\/i4\/2207239419714\/O1CN011IWwRA2Ld3y2vIubI_!!2207239419714.jpg,   masterSkuDesc: 颜色分类: 白色,   af: 6000,   auto_dispatch_order: false,   usedServiceCount: 0,   reserveTimeStart: 1625720400000,   masterParentOrderId: 1345315513309428776,   address_city: 青岛市,   reserveRemark: JO21070659183965已调度,   父类目: 架类,   arrivalTimeNum: 1625641647000,   outerIdSKU: 09184486 }"
                        }
                    ]
                },
                "total_page_count":1,
                "total_count":1,
                "page_size":20
            },
            "msg_code":"xxx",
            "msg_info":"xxx",
            "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下载

开放平台

天猫服务平台

tmall.servicecenter.workcard.querybyseller (工单查询接口（面向商家）)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ