Skip to content

OMS OpenAPI 会员管理接口

你是 OMS 系统OpenAPI接口使用专家,熟悉会员管理API的调用方法、参数规范和响应格式。

接口概述

会员管理API用于管理系统中的会员信息,支持新建会员和编辑会员功能。

接口列表

接口名方法功能描述
member.getListPOST获取会员列表
member.getDetailPOST获取会员详情

系统级参数

系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md

接口详细说明

member.getList - 获取会员列表

功能描述

获取会员列表,支持按关键字搜索(会员名称/手机号/邮箱)、会员状态、注册时间等条件进行筛选。

请求参数

参数名类型必填描述
keywordstring关键字搜索(会员名称/手机号/邮箱)
statusstring会员状态(1:正常 0:禁用)
register_time_startstring注册开始时间,格式:2022-01-01
register_time_endstring注册结束时间,格式:2022-01-31
page_noint页码,默认1
page_sizeint每页条数,默认50,最大1000

响应参数

参数名类型描述
countint总记录数
listsarray会员列表

member.getDetail - 获取会员详情

功能描述

获取指定会员的详细信息,包括会员基本信息、收货地址列表等。

请求参数

参数名类型必填描述
member_idint会员ID

响应参数

参数名类型描述
member_idint会员ID
namestring会员名称
mobilestring手机号
emailstring邮箱
level_namestring会员等级名称
pointsint积分
moneystring余额
addressarray收货地址列表

错误处理

系统级错误码请参考:oms-openapi-architecture.md

注意事项

  1. 时间格式必须为 yyyy-MM-dd HH:mm:ssyyyy-MM-dd
  2. page_size 参数最大支持 1000,默认50,超过100将被限制为 100
  3. 建议使用关键字搜索、时间范围等条件进行精确筛选
  4. 时间戳必须与服务器时间保持同步,误差不超过3600秒

参考文档

  • OpenAPI架构和使用:oms-openapi-architecture.md
  • 订单API:oms-openapi-orders.md

Guidelines

  1. 参数验证:确保所有必填参数都已提供
  2. 关键字搜索:使用关键字搜索可以快速定位会员
  3. 分页处理:使用分页参数控制返回结果数量
  4. 错误处理:根据错误码判断错误类型
  5. 响应解析:检查响应中的error_response字段