API文档

1.接口说明

1.1 接口描述：全量查询标签/异常名称信息

1.2 适用版本：客户端 V2.4.8.0及以上版本

2.调用场景

2.1 全量查询标签/异常

3.请求参数说明

3.1 请求地址

环境	HTTP地址
测试环境	https://sandbox.wangdian.cn/openapi2/cfg_tags_query.php
正式环境	https://api.wangdian.cn/openapi2/cfg_tags_query.php

3.2 公共请求参数

名称	字段	类型	必须	描述
卖家账号	sid	String	是	购买ERP时由旺店通分配给ERP购买方，请从ERP购买方获取。
接口账号	appkey	String	是	本开放平台“自助对接”功能模块内自助申请，申请流程单击这里
时间戳	timestamp	int	是	北京时间1970-01-01 08:00:00起至现在的总秒数，10位int值,旺店通企业版API服务端允许请求最大时间误差为5min，date.timezone = Asia/Shanghai。
签名	sign	String	是	API输入参数签名结果，签名算法介绍单击这里

3.3 业务请求参数

名称	字段	类型	必须	描述
标签名称	tag_name	varchar	否	标签名称
分页大小	page_size	varchar	否	每页返回条数，传参范围1~100，不传此参数默认page_size=40，使用举例单击这里
分页页号	page_no	varchar	否	页号，不传默认从0页开始

4.响应参数

4.1 公共响应参数

名称	字段	类型	长度	必须	描述
错误码	code	int	40	是	状态码:0表示成功,其他表示失败
错误描述	message	varchar	255	是	错误描述
数据条数	total_count	int	10	否	只有，page_no = 0 时才返回的符合条件的数据总条数，用来分页
标签列表	records[ ]	data		是	标签信息

4.2 业务响应参数

records

名称	字段	类型	长度	必须	描述
标签ID	tag_id	int	11	是	标签ID
标签分类	basic_type	int	11	是	基本分类:1订单标签 2订单异常
业务分类	business_type	tinyint	4	是	业务分类:(1~50订单标签 51~100订单异常)
标签名称	tag_name	varchar	32	是	标签名称
背景颜色	bg_color	varchar	20	是	背景颜色
字体颜色	font_color	varchar	20		字体颜色
字体	font_name	varchar	20		字体
文字加下划线	is_underline	int			文字加下划线
斜体	is_italic	int			斜体
粗体	is_bold	int			粗体
停用	is_disabled	int			停用
是否内置	is_builtin	int			是否内置标记，内置标记，用户不可编辑
对应标记flag_id	src_flag_id	int	11		对应标记flag_id，0为新增标签
优先级	priority	int			优先级默认与tag_id相同
最后修改时间	modified	datetime	datetime	是	最后修改时间时间格式：yyyy-MM-dd HH:mm:ss
创建时间	created	datetime	datetime	是	创建时间时间格式：yyyy-MM-dd HH:mm:ss

5.请求示例

PHP	<?php require_once '../WdtClient.php'; $c = new WdtClient; $c->sid = ''; $c->appkey = ''; $c->appsecret = ''; $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/cfg_tags_query.php'; $c->putApiParam('page_no', 0); $c->putApiParam('page_size', 1); $c->putApiParam('tag_name', ""); $json = $c->wdtOpenApi(); var_dump($json); ?>
JAVA	package com.wangdian.api.trade; import java.io.IOException; import java.util.HashMap; import java.util.Map; import com.wangdian.api.WdtClient; public class cfgTagsQuery{ public static void main(String[] args) { // TODO Auto-generated method stub WdtClient client = new WdtClient("传入sid", "传入appkey", "传入appsecret", "传入url"); //测试环境sid、appkey、密钥请到旺店通开放平台-自助对接-申请测试环境内查看，测试环境url=https://sandbox.wangdian.cn/openapi2/ //调用正式环境时请将sid、appkey、appsecret切换为实际参数，参数在旺店通开放平台-自助对接-应用管理内应用状态为已上线的应用中查看，调用正式环境注意切换正式环境url=https://api.wangdian.cn/openapi2/ Map<String, String> params = new HashMap<String, String>(); params.put("page_no","0"); params.put("page_size","40"); params.put("tag_name", "次日达"); try { String response = client.execute("cfg_tags_query.php", params); System.out.println(response); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } } }
C#	using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using WdtSdk; namespace cfgTagsQuery { class cfgTagsQuery { static void Main(string[] args) { WdtClient client = new WdtClient(); client.sid = ""; client.appkey = ""; client.appsecret = ""; client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/cfg_tags_query.php"; client.putParams("tag_name", "次日达"); string result = client.wdtOpenapi(); Console.WriteLine(result); Console.ReadKey(); } } }
python	import WdtClient t = WdtClient.WdtClient('appkey', 'appsecret', 'sid', 'http://sandbox.wangdian.cn/openapi2/') params = {} params.update({"tag_name": '次日达'}) response = t.execute("cfg_tags_query.php", params) print(response)

6.响应示例

6.1 正常响应示例

JSON

{
  "code": 0,
  "records": [
    {
      "basic_type": "1",
      "bg_color": "#ffffff",
      "business_type": "1",
      "created": "2023-03-01 10:05:19",
      "font_color": "#000000",
      "font_name": "SimSun",
      "is_bold": "0",
      "is_builtin": "1",
      "is_disabled": "0",
      "is_italic": "0",
      "is_underline": "0",
      "modified": "2023-03-01 10:05:19",
      "priority": "1",
      "src_flag_id": "0",
      "tag_id": "1",
      "tag_name": "聚划算"
    },
    {
      "basic_type": "1",
      "bg_color": "#ffffff",
      "business_type": "1",
      "created": "2023-03-01 10:05:19",
      "font_color": "#000000",
      "font_name": "SimSun",
      "is_bold": "0",
      "is_builtin": "1",
      "is_disabled": "0",
      "is_italic": "0",
      "is_underline": "0",
      "modified": "2023-03-01 10:05:19",
      "priority": "2",
      "src_flag_id": "0",
      "tag_id": "2",
      "tag_name": "送货上门"
    },
    {
      "basic_type": "1",
      "bg_color": "#ffffff",
      "business_type": "1",
      "created": "2023-03-01 10:05:19",
      "font_color": "#000000",
      "font_name": "SimSun",
      "is_bold": "0",
      "is_builtin": "1",
      "is_disabled": "0",
      "is_italic": "0",
      "is_underline": "0",
      "modified": "2023-03-01 10:05:19",
      "priority": "3",
      "src_flag_id": "0",
      "tag_id": "3",
      "tag_name": "当日达"
    },
    {
      "basic_type": "1",
      "bg_color": "#ffffff",
      "business_type": "1",
      "created": "2023-03-01 10:05:19",
      "font_color": "#000000",
      "font_name": "SimSun",
      "is_bold": "0",
      "is_builtin": "1",
      "is_disabled": "0",
      "is_italic": "0",
      "is_underline": "0",
      "modified": "2023-03-01 10:05:19",
      "priority": "4",
      "src_flag_id": "0",
      "tag_id": "4",
      "tag_name": "次日达"
    },
    {
      "basic_type": "1",
      "bg_color": "#ffffff",
      "business_type": "1",
      "created": "2023-03-01 10:05:19",
      "font_color": "#000000",
      "font_name": "SimSun",
      "is_bold": "0",
      "is_builtin": "1",
      "is_disabled": "0",
      "is_italic": "0",
      "is_underline": "0",
      "modified": "2023-03-01 10:05:19",
      "priority": "5",
      "src_flag_id": "0",
      "tag_id": "5",
      "tag_name": "京品试"
    }
  ],
  "total_count": 112,
  "message": "ok"
}

6.2 异常响应示例

JSON	{ "code": 1007, "message": "接口appkey已停用【解决办法：联系商务人员，重新开启接口appkey】 " }

常用工具

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

cfg_tags_query.php（查询标签/异常名称）

6.1 正常响应示例