店铺会员管理 API
API无需订购ecrm工具也可调用。开放淘宝卖家的会员数据,并且提供对会员的相关管理,设置操作。
-
class crm.GroupDomain(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
分组简单定义
-
class crm.BasicMember(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
表示会员关系的基本信息字段,用于会员列表的基本查询
-
class crm.GradePromotion(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
卖家设置的等级优惠信息
-
class crm.RuleData(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
规则相关信息
-
class crm.CrmMember(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
会员信息对象
-
class crm.Group(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
描述分组的数据结构
-
add(group_name, session)[source]
taobao.crm.group.add 卖家创建一个分组
卖家创建一个新的分组,接口返回一个创建成功的分组的id
-
append(from_group_id, to_group_id, session)[source]
taobao.crm.group.append 将一个分组添加到另外一个分组
将某分组下的所有会员添加到另一个分组,注
- 1.该操作为异步任务,建议先调用taobao.crm.grouptask.check 确保涉及分组上没有任务;
- 2.若分组下某会员分组数超最大限额,则该会员不会被添加到新分组,同时不影响其余会员添加分组,接口调用依然返回成功。
-
delete(group_id, session)[source]
taobao.crm.group.delete 删除分组
将该分组下的所有会员移除出该组,同时删除该分组。注:删除分组为异步任务,必须先调用taobao.crm.grouptask.check 确保涉及属性上没有任务。
-
move(from_group_id, to_group_id, session)[source]
taobao.crm.group.move 分组移动
将一个分组下的所有会员移动到另一个分组,会员从原分组中删除 注:移动属性为异步任务建议先调用taobao.crm.grouptask.check 确保涉及属性上没有任务。
-
update(group_id, new_group_name, session)[source]
taobao.crm.group.update 修改一个已经存在的分组
修改一个已经存在的分组,接口返回分组的修改是否成功
-
class crm.Groups(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
-
get(page_size, current_page, session)[source]
taobao.crm.groups.get 查询卖家的分组
查询卖家的分组,返回查询到的分组列表,分页返回分组
-
class crm.GroupTask(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
-
check(group_id, session)[source]
taobao.crm.grouptask.check 查询分组任务是否完成
检查一个分组上是否有异步任务,异步任务包括
- 1.将一个分组下的所有用户添加到另外一个分组
- 2.将一个分组下的所有用户移动到另外一个分组
- 3.删除某个分组 若分组上有任务则该属性不能被操作。
-
class crm.MemberInfo(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
-
update(buyer_nick, status, session, grade=None, province=None, city=None)[source]
taobao.crm.memberinfo.update 编辑会员资料
检查一个分组上是否有异步任务,异步任务包括
- 1.将一个分组下的所有用户添加到另外一个分组
- 2.将一个分组下的所有用户移动到另外一个分组
- 3.删除某个分组 若分组上有任务则该属性不能被操作。
-
class crm.Members(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
-
get(current_page, session, **kwargs)[source]
taobao.crm.members.get 获取卖家的会员(基本查询)
查询卖家的会员,进行基本的查询,返回符合条件的会员列表
-
group_batchadd(buyer_ids, group_ids, session)[source]
taobao.crm.members.group.batchadd 给一批会员添加一个分组
为一批会员添加分组,接口返回添加是否成功,如至少有一个会员的分组添加成功,接口就返回成功,否则返回失败,如果当前会员已经拥有当前分组,则直接跳过
-
groups_batchdelete(buyer_ids, group_ids, session)[source]
taobao.crm.members.groups.batchdelete 批量删除分组
批量删除多个会员的公共分组,接口返回删除是否成功,该接口只删除多个会员的公共分组,不是公共分组的,不进行删除。如果入参只输入一个会员,则表示删除该会员的某些分组。
-
increment_get(current_page, session, **kwargs)[source]
taobao.crm.members.increment.get 增量获取卖家会员)
增量获取会员列表,接口返回符合查询条件的所有会员。任何状态更改都会返回
-
search(current_page, session, **kwargs)[source]
taobao.crm.members.search 获取卖家会员(高级查询))
会员列表的高级查询,接口返回符合条件的会员列表
-
class crm.Grade(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
-
get(session)[source]
taobao.crm.grade.get 卖家查询等级规则
卖家查询等级规则,包括普通会员、高级会员、VIP会员、至尊VIP会员四个等级的信息
-
class crm.Rule(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
-
add(rule_name, session, **kwargs)[source]
taobao.crm.rule.add 分组规则添加
添加分组规则,规则可用于筛选一定条件的会员。过滤条件可以选择客户来源、会员级别 、交易笔数、交易额、上次交易时间、平均客单价、宝贝件数、省份、关闭交易数等,新建规则时必须至少选择一个以上筛选条件。如果输入的规则的筛选条件不正确则不会进行处理,可以将某些分组挂在这个规则下,对被挂在该规则下的分组,系统对现有满足规则的客户都划分到这个分组(异步任务),若某些会员分组数或规则数超最大限额,则该会员不被操作,同时不影响其余会员操作,接口调用依然返回成功。每个规则可以应用到多个分组,一个用户的规则上限为5个。
-
delete(rule_id, session)[source]
taobao.crm.rule.delete 分组规则删除
分组规则删除
-
group_set(rule_id, session, add_groups=None, delete_groups=None)[source]
taobao.crm.rule.group.set 设置规则适用的分组
将规则应用或取消应用到分组上,add_groups和delete_groups,两个参数最少填写一个。
-
class crm.Rules(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
-
get(current_page, session, page_size=None)[source]
taobao.crm.rules.get 获取规则
获取现有的规则列表
-
class crm.ShopVip(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)[source]
-
cancel(session)[source]
taobao.crm.shopvip.cancel 卖家取消店铺vip的优惠
此接口用于取消VIP优惠