文档中心 - 有赞云

youzan.salesman.account.score.search.3.0.0

计费

2022-02-14 09:33:09

API名称：获取销售员业绩统计

API描述

获取销售员业绩统计，按时间范围查询，最大仅支持90天，如果超过90天，end_time 会被调整为开始时间+90天，可以不传时间范围，那么是查询历史累计数据。

公共参数

参数名称	参数类型	必须	参数说明	示例值
access_token	String	是	鉴权凭证，用于请求API详见如何获取access_token	9b510e232c9e3716b4c1e264fe04cdc6

请求地址

https://open.youzanyun.com/api/youzan.salesman.account.score.search/3.0.0

请求参数

全部展开全部收起

参数名称

参数类型

必须

参数说明

示例值

page_size

java.lang.Integer

是

每页条数。默认20条，最大不能超过100，建议使用默认分页。如果订单较多请使用时间参数分割。page_size 和page_no相乘总条数不能大于3200条

page_no

java.lang.Integer

是

页码，从1~100开始，分页数不能超过100页。如果订单较多请使用时间参数分割。page_size 和page_no相乘总条数不能大于3200条

end_time

java.lang.Long

是

订单创建结束时间，Unix时间戳，单位：秒

1540867540

start_time

java.lang.Long

是

订单创建开始时间，Unix时间戳，单位：秒

1535597140

mobile

java.lang.String

否

销售员手机号（不支持国外手机号，当fans_id和mobile都传时，优先按mobile查询）

13333333333

fans_id

java.lang.Long

否

粉丝id(有赞不同的合作渠道会生成不同渠道对应在有赞平台下的fans_id。fans_id和fans_type组成一个唯一的有赞用户标识。从浏览器过来的下单的是拿不到fans_id。大账号fans_id：通过微信去访问有赞店铺的商品等，系统会给用户生成fansid。用户自有fans_id（从三方过来的）：关注任意一个公众号(包括有赞大账号)后生成ID。 fans_type：1:代表微信自有粉丝；2：代表[微博平台]产生的粉丝；9：代表粉丝类型为微信大账号粉丝；188：代表[qq平台]产生的粉丝；736:代表[支付宝平台]产生的粉丝；1181:代表[今日头条]产生的粉丝；非上述fans_type其他：代表其他平台或小程序粉丝或者三方sdk产生的粉丝；)

12345

返回参数

全部展开全部收起

参数名称

参数类型

参数说明

示例值

code

int

网关返回码，表示本次请求是否成功。200 :成功。

200

data

object

返回结果

accumulations

java.util.List

分销员业绩统计项

cps_money

java.lang.String

自动结算推广奖励(已结算)

0.00

wait_bonus_money

java.lang.String

待结算邀请奖励金额

0.00

bonus_money

java.lang.String

已结算自动结算邀请奖励

0.00

auto_settle_order_num

java.lang.Integer

自动结算推广订单数

money_sum

java.lang.String

累计成交金单位：元

100

wait_cps_money

java.lang.String

待结算推广奖励

0.00

invite_num

java.lang.Integer

有效邀请人数

mobile

java.lang.String

销售员手机号

12345675432

manual_settle_order_num

java.lang.Integer

人工结算推广订单数

manual_cps_money

java.lang.String

已结算人工结算推广奖励

0.00

auto_settle_order_amount

java.lang.String

自动结算推广订单金额

0.00

manual_settle_order_amount

java.lang.String

人工结算推广订单金额

0.00

manual_settle_money

java.lang.String

人工已结算佣金

0.00

customer_num

java.lang.Integer

客户关系数量

manual_wait_settle_money

java.lang.String

人工待结算佣金

0.00

manual_wait_bonus_money

java.lang.String

待结算人工结算邀请奖励

0.00

nickname

java.lang.String

昵称

wf测试

settle_money

java.lang.String

已结算佣金

0.00

profit_sum

java.lang.String

累计佣金单位：元

manual_bonus_money

java.lang.String

人工结算邀请奖励（已结算）

0.00

wait_settle_money

java.lang.String

待结算佣金

0.00

manual_wait_cps_money

java.lang.String

待结算人工结算推广奖励

0.00

total_results

java.lang.Long

记录总数

1234

message

java.lang.String

网关返回码描述

请根据当前业务接口报错填写。示例（订单列表查询失败,错误信息:分页数不能超过100页）

success

boolean

表示本次请求是否成功。 true:成功 false：失败

true

request_id

java.lang.String

已废弃

请求示例

nodejs

curl

php

java

const youzanyun = require('youzanyun-sdk');

const token = 'YOUR_TOKEN';
const params = {
	"start_time":"1609489272",
	"mobile":"15771835542",
	"end_time":1645086072,
	"page_no":1,
	"page_size":20
};

const resp = youzanyun.client.call({
    api: 'youzan.salesman.account.score.search',
    version: '3.0.0',
    token,
    params,
});

响应示例

{
  "trace_id": "yz7-0a135641-1645096146263-693818",
  "code": 200,
  "data": {
    "accumulations": [
      {
        "manual_settle_money": "0.00",
        "manual_settle_order_amount": "108.82",
        "profit_sum": "3.55",
        "manual_wait_settle_money": "0.00",
        "mobile": "15920767064",
        "wait_cps_money": "3.55",
        "customer_num": 8,
        "manual_wait_cps_money": "0.00",
        "auto_settle_order_num": 13,
        "manual_wait_bonus_money": "0.00",
        "money_sum": "611.33",
        "cps_money": "0.00",
        "wait_bonus_money": "0.00",
        "bonus_money": "0.00",
        "manual_settle_order_num": 9,
        "nickname": ".。o0O沈小观",
        "wait_settle_money": "3.55",
        "auto_settle_order_amount": "502.51",
        "manual_bonus_money": "0.00",
        "settle_money": "0.00",
        "invite_num": 1,
        "manual_cps_money": "0.00"
      }
    ],
    "total_results": 1
  },
  "success": true,
  "message": "successful",
  "request_id": "eef314a70f9b4caf8a9e5b7d577158f3"
}

异常示例

{
  "code": 341007501,
  "data": {
    "accumulations": []
  },
  "success": false,
  "message": "分销员业绩统计列表为空"
}

返回码

返回码	描述	解决方案
200	请求成功	请求成功
341007501	销售员业绩统计列表为空	检查该销售员手机号是否正确
341200005	请求参数非法 - pageSize:size beyond limit[100]	翻页不能超过100页

如何获得此API权限

拥有此API的能力包	拥有此API的能力包分类	可获得此API能力包的应用类目
销售员业绩统计	销售员管理	有赞教育、客户关系CRM、门店POS、iPaaS数据集成、有赞微商城、有赞零售、分销获客、老客复购、打单发货、内容营销、客户管理、订单/商品中台、系统打通（连接器）、触达通道、活动工具、推广投放、打折促单、裂变拉新、
线下引导线上开卡，绑定导购	客户管理	客户关系CRM、门店POS、iPaaS数据集成、有赞微商城、有赞零售、系统打通（连接器）、

上一篇：更新供应商信息

下一篇：云分销渠道商列表查询

此篇文档是否对你有帮助？

文档反馈