当前位置: API文档
live_achievement_query.php(主播绩效查询)
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 公共请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | 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 业务请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
店铺 | shop_nos | string | 20 | 否 | 店铺编号 格式:["shop1", "shop2"] |
开始时间 | live_start_time | datetime | 是 | 时间格式 yyyy-MM-dd HH:mm:ss 最多支持30天时间范围查询 | |
结束时间 | live_end_time | datetime | 是 | 同开始时间 | |
分页大小 | page_size | int | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数输入值默认为40,使用举例单击这里 | |
页号 | page_no | int | 否 | page_no页的数据,不传值默认从第1页开始 |
4.响应参数
4.1 公共响应参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 40 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 10 | 否 | 只有page_no = 0 时才返回的符合条件的数据总条数,用来分页 |
策略列表 | records | data[] | 是 | 策略列表 |
4.2 业务响应参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
场次主键ID | live_id | int | 11 | 是 | 场次主键ID |
场次名称 | live_name | varchar | 128 | 是 | 场次名称 |
店铺ID | shop_id | int | 6 | 是 | 店铺ID |
店铺编号 | shop_no | varchar | 20 | 是 | 店铺编号 |
店铺名称 | shop_name | varchar | 128 | 是 | 店铺名称 |
主播名称 | role_name | varchar | 40 | 是 | 主播名称 |
主播ID | role_no | varchar | 40 | 是 | 主播ID |
主播分组 | group_name | varchar | 40 | 是 | 主播分组 |
订单数 | trade_num | decimal | (19,4) | 是 | 订单数 |
总销售额 | sales_amount | decimal | (19,4) | 是 | 总销售额 |
货品数 | goods_num | decimal | (19,4) | 是 | 货品数 |
货品预估总成本 | goods_cost_predict | decimal | (19,4) | 是 | 货品预估总成本 |
货品发货总成本 | goods_cost | decimal | (19,4) | 是 | 货品发货总成本 |
邮费总成本 | post_cost | decimal | (19,4) | 是 | 邮费总成本 |
包装总成本 | package_cost | decimal | (19,4) | 是 | 包装总成本 |
预估退款率【%】 | predict_refund_rate | decimal | (19,4) | 是 | 预估退款率【%】 |
预估退款金额 | predict_refund_amount | decimal | (19,4) | 是 | 预估退款金额 |
预估毛利 | predict_profit | decimal | (19,4) | 是 | 预估毛利 |
退款订单量 | pre_refund_trade_num | decimal | (19,4) | 是 | 退款订单量 |
退款货品数量 | pre_refund_goods_num | decimal | (19,4) | 是 | 退款货品数量 |
退款总金额 | pre_refund_amount | decimal | (19,4) | 是 | 退款总金额 |
退货订单量 | after_refund_trade_num | decimal | (19,4) | 是 | 退货订单量 |
退货货品数量 | after_refund_goods_num | decimal | (19,4) | 是 | 退货货品数量 |
退货总金额 | after_refund_amount | decimal | (19,4) | 是 | 退货总金额 |
退款退货订单量 | refund_trade_num | decimal | (19,4) | 是 | 退款退货订单量 |
退款退货货品数量 | refund_goods_num | decimal | (19,4) | 是 | 退款退货货品数量 |
退款退货总金额 | refund_amount | decimal | (19,4) | 是 | 退款退货总金额 |
发货毛利 | profit | decimal | (19,4) | 是 | 发货毛利 |
主播佣金 | role_commission | decimal | (19,4) | 是 | 主播佣金 |
业务员 | salesman_name | varchar | 40 | 是 | 业务员 |
业务员佣金 | salesman_commission | decimal | (19,4) | 是 | 业务员佣金 |
团长 | teamleader_name | varchar | 40 | 是 | 团长 |
团长佣金 | teamleader_commission | decimal | (19,4) | 是 | 团长佣金 |
5.请求示例
6.1 正常响应示例
{ "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" } |
JSON | { "code": 1007, "message": "接口appkey已停用【解决办法:联系商务人员,重新开启接口appkey】 " } |