当前位置: API文档

1.接口说明

1.1 接口描述:获取旺店通ERP的主播绩效信息数据
1.2 适用版本:客户端 V2.4.8.0及以上版本

2.调用场景

2.1 主播绩效查询

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境https://sandbox.wangdian.cn/openapi2/live_achievement_query.php
正式环境https://api.wangdian.cn/openapi2/live_achievement_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 业务请求参数

名称字段类型长度
必须描述
店铺shop_nosstring20店铺编号 格式:["shop1", "shop2"]
开始时间live_start_timedatetime
时间格式 yyyy-MM-dd HH:mm:ss 最多支持30天时间范围查询
结束时间live_end_timedatetime
同开始时间
分页大小page_sizeint
每页返回的数据条数,输入值范围1~100,不传本参数输入值默认为40,使用举例单击这里
页号page_noint
page_no页的数据,不传值默认从第1页开始

4.响应参数

   4.1 公共响应参数

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

   4.2 业务响应参数

名称字段类型长度必须描述
场次主键IDlive_idint11场次主键ID
场次名称
live_namevarchar128场次名称
店铺IDshop_idint6店铺ID
店铺编号shop_novarchar20
店铺编号
店铺名称shop_namevarchar128店铺名称
主播名称
role_namevarchar
40主播名称
主播IDrole_novarchar40主播ID
主播分组

group_name

varchar40主播分组
订单数
trade_numdecimal(19,4)订单数
总销售额sales_amountdecimal(19,4)总销售额
货品数goods_numdecimal(19,4)货品数
货品预估总成本goods_cost_predictdecimal(19,4)货品预估总成本
货品发货总成本goods_costdecimal(19,4)货品发货总成本
邮费总成本post_costdecimal(19,4)邮费总成本
包装总成本package_costdecimal(19,4)包装总成本
预估退款率【%】predict_refund_ratedecimal(19,4)预估退款率【%】
预估退款金额predict_refund_amountdecimal(19,4)预估退款金额
预估毛利predict_profitdecimal(19,4)预估毛利
退款订单量pre_refund_trade_numdecimal(19,4)退款订单量
退款货品数量pre_refund_goods_numdecimal(19,4)退款货品数量
退款总金额pre_refund_amountdecimal(19,4)退款总金额
退货订单量after_refund_trade_numdecimal(19,4)退货订单量
退货货品数量after_refund_goods_numdecimal(19,4)退货货品数量
退货总金额after_refund_amountdecimal(19,4)退货总金额
退款退货订单量refund_trade_numdecimal(19,4)退款退货订单量
退款退货货品数量refund_goods_numdecimal(19,4)退款退货货品数量
退款退货总金额refund_amountdecimal(19,4)退款退货总金额
发货毛利profitdecimal(19,4)发货毛利
主播佣金role_commissiondecimal(19,4)主播佣金
业务员salesman_namevarchar40业务员
业务员佣金
salesman_commissiondecimal(19,4)业务员佣金
团长teamleader_namevarchar40团长
团长佣金teamleader_commissiondecimal(19,4)团长佣金



5.请求示例

PHP
<?php
    require_once '../WdtClient.php';
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/live_achievement_query.php';
    
    $c->putApiParam('page_no', 0);
    $c->putApiParam('page_size', 1);
    $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>();

        try {
            String response = client.execute("live_achievement_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/live_achievement_query.php";

            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}
python
import WdtClient

t = WdtClient.WdtClient('appkey', 'appsecret', 'sid', 'http://sandbox.wangdian.cn/openapi2/')
params = {}

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

6.响应示例

   6.1 正常响应示例 

JSON
{
  "code": 0,
  "records": [
    {
      "after_refund_amount": "0.0000",
      "after_refund_goods_num": "0.0000",
      "after_refund_trade_num": "0.0000",
      "goods_cost": "0.0000",
      "goods_cost_predict": "46132.3926",
      "goods_num": "6.0000",
      "group_name": "",
      "live_id": "18277",
      "live_name": "自动创建:LS2308250001",
      "package_cost": "0.0000",
      "post_cost": "0.0000",
      "pre_refund_amount": "200.0000",
      "pre_refund_goods_num": "2.0000",
      "pre_refund_trade_num": "1.0000",
      "predict_profit": "-45547.3926000000",
      "predict_refund_amount": "15.0000000000",
      "predict_refund_rate": "2.5000",
      "profit": "320.0000",
      "refund_amount": "200.0000",
      "refund_goods_num": "2.0000",
      "refund_trade_num": "1.0000",
      "role_commission": "80.0000",
      "role_name": "格雷福斯",
      "role_no": "DDZB:glfs",
      "sales_amount": "600.0000",
      "salesman_commission": "0.0000",
      "salesman_name": "",
      "shop_id": "134",
      "shop_name": "抖音001",
      "shop_no": "dy001",
      "teamleader_commission": "0.0000",
      "teamleader_name": "",
      "trade_num": "3.0000"
    }
  ],
  "total_count": 1,
  "message": "ok"
}

 6.2 异常响应示例

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




常用工具