当前位置: API文档

1.接口说明

1.1 接口描述:查询原因列表
1.2 适用版本:客户端 V2.4.8.0及以上版本


2.调用场景

2.1 查询原因列表

3.请求参数说明

   3.1 请求地址

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

   3.2 公共请求参数

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

   3.3 业务请求参数

名称字段类型长度
必须描述
原因类型class_idvarchar
原因类型
分页大小page_sizeint
每页返回的数据条数,输入值范围1~100,不传本参数输入值默认为40,使用举例单击这里
页号page_noint
page_no页的数据,不传值默认从第1页开始

4.响应参数

   4.1 公共响应参数


名称字段类型长度必须描述
错误码codeint40状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint10只有,page_no = 0 时才返回的符合条件的数据总条数,用来分页
原因列表reasonlist[ ]data
原因列表

   4.2 业务响应参数

   reasonlist

名称字段类型长度必须描述
原因类型class_idsmallint6原因类型
原因titlevarchar64

原因

优先级
priority
tinyint1原因优先级
是否内置标记is_builtintinyint1是否内置标记 0:否 1:是
原因主键id
reason_idsmallint6原因主键id
内置字段parent_idsmallint6内置字段(忽略)
是否禁用is_disabledtinyint1是否禁用
修改时间

modified

datetime
修改时间
创建时间createddatetime
创建时间


5.请求示例

PHP
<?php
    require_once '../WdtClient.php';
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/reason_query.php';
    
    $c->putApiParam('page_no', 0);
    $c->putApiParam('page_size', 1);
    $c->putApiParam('class_id', "4");
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
JAVA
package com.wangdian.api.basic;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import com.wangdian.api.WdtClient;

public class LogisticsMultiQuery {

    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("class_id", "4");


        try {
            String response = client.execute("reason_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 LogisticsQuery
{
    class LogisticsQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/reason_query.php";

            client.putParams("class_id", "4");
            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({"class_id": '4'})

response = t.execute("reason_query.php", params)
print(response)

6.响应示例

   6.1 正常响应示例 

JSON
{
  "code": 0,
  "total_count": 1,
  "message": "ok",
  "reasonlist": [
    {
      "class_id": "4",
      "created": "2020-04-23 14:20:18",
      "is_builtin": "0",
      "is_disabled": "0",
      "modified": "2023-06-21 17:42:29",
      "priority": "15",
      "reason_id": "32",
      "title": "七天无理由退款"
    }
  ]
}

 6.2 异常响应示例

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




常用工具