名词解释
本文说明开放平台文档中的常用业务名词及字段含义,便于对接时理解接口参数与返回结构。
实体关系
一个营种下可有多个营期;一个营期下可有多种规格。三者组合对应一个 PLU(最小售卖单位编码),详见下文。
会员与营员为多对多;会员下单生成订单,订单关联所选营种、营期、规格(即某一 PLU)及订单下的营员。
人员
会员
购买与账号主体。每个会员均具备 uid、openid、unionid。仅已认证会员具备手机号 phone,且手机号全局唯一。下单、查询订单、会员列表等均以会员为主体。
相关接口:获取会员列表
营员
实际参营人员,主键为 sid。营员证件号全局唯一。会员与营员支持多对多绑定;营员信息挂在订单及报名表单字段中。
员工
机构后台工作人员,可用于订单归属等场景。
相关接口:获取全部员工
营种、营期、规格与 PLU
营种
可售卖的营种条目,主键为 pid。查询营期、规格及下单均以 pid 为入口。
营种售卖属性:
| 字段 | 取值说明 |
|---|---|
status | 1 公开售卖;2 非公开售卖 |
is_on | 1 售卖中;2 已下架 |
营期
某一营种下的具体开营场次,主键为 period_id。name 一般为日期区间,per_name 为期次名称。批量导入、分团分组、查询 PLU 等均按营期维度操作。
相关接口:获取营种营期
规格
同一营种在某一营期下的售卖选项(如「单板,1:1私教」「默认」)。现行接口字段为 sku_str,并可返回规格数字 id。多规格场景下单时通常需传入 sku_str。
相关接口:获取营种规格
PLU
最小售卖单位的编码,对应 营种 + 营期 + 规格 的唯一组合。批量导入等场景常使用 PLU 指定具体售卖项。
相关接口:获取营期 PLU 编号、批量导入营期营员
订单
订单号与订单 ID
| 字段 | 说明 |
|---|---|
ordernum | 业务订单号,查询、核销及多数回调使用 |
order_id | 系统数字 ID,编辑订单营员等接口使用 |
订单状态
| 值 | 说明 |
|---|---|
| 1 | 待付款 |
| 2 | 已支付 |
| 4 | 已结营 |
| 5 | 已取消 |
| 6 | 已退款 |
| 11 | 待支付尾款 |
| 12 | 退款中 |
| 13 | 换营中 |
相关接口:查询订单
预定下单与批量导入
| 方式 | 说明 |
|---|---|
| 预定下单 | 预定下单,接口创建订单 |
| 批量导入 | 批量导入营期营员,按营期导入营员并生成订单;开放平台「退营订单」通常仅支持导入类订单 |
核销(结营)
核销订单:校验订单号与会员手机号,且订单为已支付时,将状态更新为已结营。
差价
相对主订单的补款。可通过接口获取差价支付码,并按手机号与金额核验支付结果。
换营与连报
| 名词 | 说明 |
|---|---|
| 换营 | 订单变更至其他营种或营期,状态可能为换营中 |
| 连报 | 一次购买关联多个营期或多个订单 |
分团与分组
分团
营期内的编制单位(如「1 团」),常见字段为 cut_id、team_name。
分组
团下的小组(如「3 组」),常见字段为 group_id、group_name。
相关接口:获取营期分团分组详情、团组变更通知
接入
appid、secret、token
使用 appid 与 secret 调用 获取访问令牌 获得 token(有效期一般为 7200 秒)。除获取令牌外,业务接口均需携带 token。
回调
平台向已配置的回调地址发起 HTTP POST。接收方应返回 HTTP 200。部分回调以表单提交,业务数据位于 request_data(JSON 字符串),需先解析。详见侧栏「回调通知」及 概述。