淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
app_version	String	可选	6.5.0		app版本
execute_user_list	ExecuteUserDto []	可选		最大列表长度：20	账号列表
└ execute_user_id Number 可选 234234 账号id └ execute_user_type String 可选 CP 账号类型
ext	String	可选	ABCD		扩展信息预留
personal_session	String	可选	22233		个人账号session
personal_user_id	Number	可选	33333		个人账号id

名称	类型	示例值	描述
data	YmDeviceCenterDeviceListResponse	数据结构	data
devices_list YmDeviceCenterDeviceDetailDto [] 设备列表设备列表 └ device_factory String 汉印设备厂商 └ device_model String HPRT 设备型号 └ device_name String 蓝牙扫码枪设备名称 └ feature_tag_list String [] ["1","2","3"] featureTags └ gmt_create Date 时间戳创建时间 └ gmt_modified Date 时间戳变更时间 └ id Number 1 设备id └ img_url String www.xx.com/png imgUrl └ lifecycle_connected_cmd String cmdA 设备声明周期连接cmd └ lifecycle_disconnected_cmd String CMDB 设备声明周期断开cmd └ obtain_channel_h5_url String www.taobao.com 获取渠道H5页面地址 └ obtain_channel_sub_img_url String www.xx.com/png 获取渠道描述图片 └ obtain_channel_summary String 描述内容获取渠道描述信息 └ obtain_channel_title String 渠道标题获取渠道title └ obtain_channel_type Number 1 可获取设备的渠道类型 0：代表无 1：H5地址 2：商城引流 └ service_uuid_list String [] ['FF01','FF02'] 设备Service UUID列表 └ summary String 设备描述设备描述 └ support_scene_list String [] ['批量揽收'] 支持场景 └ support_scene_desc_list String [] ['批量揽收提效'] 支持场景描述
status_code	String	2	statusCode
status_message	String	错误信息文案	statusMessage
is_success	Boolean	false	success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoDevicecenterDeviceListRequest req = new CainiaoGuoguoDevicecenterDeviceListRequest();
req.setAppVersion("6.5.0");
List<CainiaoGuoguoDevicecenterDeviceListRequest.ExecuteUserDto> list2 = new ArrayList<CainiaoGuoguoDevicecenterDeviceListRequest.ExecuteUserDto>();
CainiaoGuoguoDevicecenterDeviceListRequest.ExecuteUserDto obj3 = new CainiaoGuoguoDevicecenterDeviceListRequest.ExecuteUserDto();
list2.add(obj3);
obj3.setExecuteUserId(234234L);
obj3.setExecuteUserType("CP");
req.setExecuteUserList(list2);
req.setExt("ABCD");
req.setPersonalSession("22233");
req.setPersonalUserId(33333L);
CainiaoGuoguoDevicecenterDeviceListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

XML示例
JSON示例

<cainiao_guoguo_devicecenter_device_list_response>
    <data>
        <devices_list>
            <ym_device_center_device_detail_dto>
                <device_factory>汉印</device_factory>
                <device_model>HPRT</device_model>
                <device_name>蓝牙扫码枪</device_name>
                <feature_tag_list>
                    <string>[&quot;1&quot;</string>
                    <string>&quot;2&quot;</string>
                    <string>&quot;3&quot;]</string>
                </feature_tag_list>
                <gmt_create>时间戳</gmt_create>
                <gmt_modified>时间戳</gmt_modified>
                <id>1</id>
                <img_url>www.xx.com/png</img_url>
                <lifecycle_connected_cmd>cmdA</lifecycle_connected_cmd>
                <lifecycle_disconnected_cmd>CMDB</lifecycle_disconnected_cmd>
                <obtain_channel_h5_url>www.taobao.com</obtain_channel_h5_url>
                <obtain_channel_sub_img_url>www.xx.com/png</obtain_channel_sub_img_url>
                <obtain_channel_summary>描述内容</obtain_channel_summary>
                <obtain_channel_title>渠道标题</obtain_channel_title>
                <obtain_channel_type>1</obtain_channel_type>
                <service_uuid_list>
                    <string>[&apos;FF01&apos;</string>
                    <string>&apos;FF02&apos;]</string>
                </service_uuid_list>
                <summary>设备描述</summary>
                <support_scene_list>
                    <string>[&apos;批量揽收&apos;]</string>
                </support_scene_list>
                <support_scene_desc_list>
                    <string>[&apos;批量揽收提效&apos;]</string>
                </support_scene_desc_list>
            </ym_device_center_device_detail_dto>
        </devices_list>
    </data>
    <status_code>2</status_code>
    <status_message>错误信息文案</status_message>
    <is_success>false</is_success>
</cainiao_guoguo_devicecenter_device_list_response>

{
    "cainiao_guoguo_devicecenter_device_list_response":{
        "data":{
            "devices_list":{
                "ym_device_center_device_detail_dto":[
                    {
                        "device_factory":"汉印",
                        "device_model":"HPRT",
                        "device_name":"蓝牙扫码枪",
                        "feature_tag_list":{
                            "string":[
                                "[\"1\"",
                                "\"2\"",
                                "\"3\"]"
                            ]
                        },
                        "gmt_create":"时间戳",
                        "gmt_modified":"时间戳",
                        "id":1,
                        "img_url":"www.xx.com\/png",
                        "lifecycle_connected_cmd":"cmdA",
                        "lifecycle_disconnected_cmd":"CMDB",
                        "obtain_channel_h5_url":"www.taobao.com",
                        "obtain_channel_sub_img_url":"www.xx.com\/png",
                        "obtain_channel_summary":"描述内容",
                        "obtain_channel_title":"渠道标题",
                        "obtain_channel_type":1,
                        "service_uuid_list":{
                            "string":[
                                "['FF01'",
                                "'FF02']"
                            ]
                        },
                        "summary":"设备描述",
                        "support_scene_list":{
                            "string":[
                                "['批量揽收']"
                            ]
                        },
                        "support_scene_desc_list":{
                            "string":[
                                "['批量揽收提效']"
                            ]
                        }
                    }
                ]
            }
        },
        "status_code":"2",
        "status_message":"错误信息文案",
        "is_success":false
    }
}

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>

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

物流API

cainiao.guoguo.devicecenter.device.list (获取支持设备列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ