OMS OpenAPI 会员管理接口
你是 OMS 系统OpenAPI接口使用专家,熟悉会员管理API的调用方法、参数规范和响应格式。
接口概述
会员管理API用于管理系统中的会员信息,支持新建会员和编辑会员功能。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
member.getList | POST | 获取会员列表 |
member.getDetail | POST | 获取会员详情 |
系统级参数
系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md
接口详细说明
member.getList - 获取会员列表
功能描述
获取会员列表,支持按关键字搜索(会员名称/手机号/邮箱)、会员状态、注册时间等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
keyword | string | 否 | 关键字搜索(会员名称/手机号/邮箱) |
status | string | 否 | 会员状态(1:正常 0:禁用) |
register_time_start | string | 否 | 注册开始时间,格式:2022-01-01 |
register_time_end | string | 否 | 注册结束时间,格式:2022-01-31 |
page_no | int | 是 | 页码,默认1 |
page_size | int | 是 | 每页条数,默认50,最大1000 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 会员列表 |
member.getDetail - 获取会员详情
功能描述
获取指定会员的详细信息,包括会员基本信息、收货地址列表等。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
member_id | int | 是 | 会员ID |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
member_id | int | 会员ID |
name | string | 会员名称 |
mobile | string | 手机号 |
email | string | 邮箱 |
level_name | string | 会员等级名称 |
points | int | 积分 |
money | string | 余额 |
address | array | 收货地址列表 |
错误处理
系统级错误码请参考:oms-openapi-architecture.md
注意事项
- 时间格式必须为
yyyy-MM-dd HH:mm:ss或yyyy-MM-dd page_size参数最大支持 1000,默认50,超过100将被限制为 100- 建议使用关键字搜索、时间范围等条件进行精确筛选
- 时间戳必须与服务器时间保持同步,误差不超过3600秒
参考文档
- OpenAPI架构和使用:
oms-openapi-architecture.md - 订单API:
oms-openapi-orders.md
Guidelines
- 参数验证:确保所有必填参数都已提供
- 关键字搜索:使用关键字搜索可以快速定位会员
- 分页处理:使用分页参数控制返回结果数量
- 错误处理:根据错误码判断错误类型
- 响应解析:检查响应中的
error_response字段
