当前位置: API文档
setting.CustomAttr.getTradeLabel(订单标签查询)
¥标准
1.接口说明
| 1.1 接口描述:获取订单标签数据 |
| 1.2 适用版本:客户端 V1.4.9.3及以上版本 |
| 1.3 增量获取:支持 |
| 1.4 时间跨度:start_time和end_time最大跨度为30天。 |
1.5注意事项:
|
2.调用场景
| 2.1 举例说明:财务系统、SAP、线下ERP、数据分析等系统的对接 |
3.请求参数说明
3.1 请求地址
| 环境 | HTTP地址 |
|---|---|
| 测试环境 | http://47.92.239.46/openapi |
| 正式环境 | http://wdt.wangdian.cn/openapi |
3.2 公共请求参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 卖家账号 | sid | String | 是 | 卖家账号, 由旺店通分配 | |
| 接口账号 | key | String | 是 | 由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里 | |
| 盐 | salt | String | 是 | 由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt. | |
| 接口名称 | method | String | 是 | 调用的接口名称 | |
| 版本号 | v | String | 是 | 1.0 | |
| 秒级时间戳 | timestamp | Int | 是 | 秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。 | |
| 签名 | sign | String | 是 | 签名 | |
| 分页大小 | page_size | Int | 否 | 分页大小,分页查询必传 | |
| 分页编号 | page_no | Int | 否 | 分页编号,分页查询必传,标准接口page_no从0开始 | |
| 是否计算查询结果的总条数 | calc_total | Int | 否 | 是否计算查询结果的总条数, 需要计算则1, 否则填0 |
3.3 业务请求参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
查询参数 | params | Map<String, Object> | 是 | 查询参数 | |
分页 | pager | Pager | 是 | 分页 |
params
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
开始时间 | start_time | String | 40 | N | 最后修改时间 |
结束时间 | end_time | String | 40 | N | 最后修改时间 |
pager
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 分页大小 | page_size | Int | 4 | 否 | 分页大小 |
| 页号 | page_no | Int | 4 | 否 | 从0开始 |
4.响应参数
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 状态码 | status | Int | 是 | 状态码,0表示调用成功 | |
| 错误信息 | message | String | 是 | 无错误信息不返回 | |
| 返回信息 | data | <Map<String, Object>> | 是 | 返回信息 |
data
响应参数说明示例值或者格式、具体含义、使用方法及注意事项
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 数据节点 | detail_list | List<Map<String, Object>> | 是 | 数据节点 | |
| 总条数 | total_count | Int | 是 | 总条数 |
detail_list
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
标签唯一id | rec_id | Int | 11 | Y | 标签唯一id |
| 标签类型 | attr_type | short | Y | 标签类型 | |
| 标签key | attr_key | Int | 11 | Y | 标签key |
| 标签名称 | attr_name | String | 40 | Y | 标签名称 |
| 是否内置 | is_builtin | boolean | Y | 是否内置 | |
| 创建时间 | created | String | Y | 创建时间,yyyy-MM-dd HH:mm:ss格式 | |
最后修改时间 | modified | String | Y | 最后修改时间,yyyy-MM-dd HH:mm:ss格式 |
5.请求示例
[
{
"start_time": "2023-10-01 00:00:00",
"end_time": "2023-10-02 00:00:00"
}
] | |
<?php
header("Content-Type: text/html; charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret")
$params = new stdClass();
//$params->jit_refund_no = 'l3453245345l';
$params->start_time = '2022-06-05 11:42:56';
$params->end_time = '2022-07-19 11:42:56';
$pager = new Pager(1, 0, true);
$data = $client->pageCall("setting.CustomAttr.getTradeLabel", $pager, $params);
?> | |
| JAVA | |
| C# |
6.响应示例
6.1 正常响应示例
{
"data": {
"detail_list": [
{
"attr_key": 1,
"attr_name": "其他",
"attr_type": 12,
"is_builtin": true,
"rec_id": 87
},
{
"attr_key": 2,
"attr_name": " 不同仓库发货",
"attr_type": 12,
"is_builtin": true,
"rec_id": 88
}
],
"total_count": 93
},
"status": 0
} |
6.2 异常响应示例
{
"message": "未知错误",
"status": 100
} |