订单接口
订单相关接口:查充值订单(列表 / 详情)、按会员查全部订单(含会籍 / 私教节数 / 私教周期 / 团课)。统一 scope `order:read`。
极客场馆开放平台 · 订单接口
版本 v1 · 配套文档:加密与签名接入 · 通用约定与错误码 所有路径前缀
https://www.gymker.com/api/open/v1。响应/错误码/幂等/限流见通用约定。
1. 能力总览
| 能力 | scope | 典型用途 |
|---|---|---|
| 查充值订单(列表) | order:read | 看充值 / 赠送 |
| 查充值订单(详情) | order:read | 单订单详情 |
| 按会员查全部订单 | order:read | 拉某会员所有交易 |
2. 充值订单列表 · GET /orders/recharge
scope order:read。
| Query | 类型 | 必填 | 说明 |
|---|---|---|---|
memberId | long | 否 | 按会员过滤 |
startDate | yyyy-MM-dd | 否 | actualPaymentDate >= startDate |
endDate | yyyy-MM-dd | 否 | actualPaymentDate <= endDate |
page | int | 否 | 默认 1 |
size | int | 否 | 默认 20,上限 100 |
时间跨度 ≤ 90 天。响应
data:{ records[], total, current, size },records[]单元素见下。
{
"id": 12345, "orderNo": "RC20260520-0001", "memberId": 100, "gymId": 1001,
"status": 1, "makingStep": 5,
"rechargeAmount": 1000.00, "giftAmount": 300.00, "receivedAmount": 1000.00,
"paymentChannel": "cash", "paymentConfirmTime": "2026-05-20T10:00:00",
"actualPaymentDate": "2026-05-20", "createTime": "2026-05-20T09:58:00"
}
字段枚举:
| 字段 | 取值 |
|---|---|
status | 0 待收款 / 1 已收款 / 9 已取消 |
makingStep | 制单流程步骤,编号即顺序:1 制单 → 2 待收款确认 → 3 待合同确认 → 4 待业绩分配 → 5 已完成 |
⚠️ 2026-07 变更:
makingStep的2与4含义互换(旧版为2业绩分配 /4收款确认,编号与流转顺序相反)。若你的系统按数值判断状态,请按上表更新;判断”是否完成”用makingStep == 5不受影响。
3. 充值订单详情 · GET /orders/recharge/{orderId}
结构同 §2。scope order:read。
4. 按会员查全部订单 · GET /orders
按 memberId 或 phone 查该会员所有类型订单,统一列表 + orderType 字段。scope order:read。
| Query | 类型 | 必填 | 说明 |
|---|---|---|---|
memberId | long | 二选一 | 与 phone 二选一(门店内唯一) |
phone | string | 二选一 | 真实手机号(11 位) |
orderType | string | 否 | 不传查全部;可选 recharge / membership_card / private_times / private_cycle / group_course |
startDate / endDate | yyyy-MM-dd | 否 | 按创建时间过滤,跨度 ≤ 90 天 |
page / size | int | 否 | 默认 1 / 20,size ≤ 100 |
data:{ records[], total, current, size },records[] 单元素(公共字段统一,按创建时间倒序):
{
"orderType": "private_times",
"orderId": 88001, "orderNo": "PT20260520-0007",
"memberId": 12345, "amount": 6000.00, "status": 1,
"title": "私教(节数)", "createTime": "2026-05-20T09:58:00"
}
amount为实收金额(receivedAmount);status各类型字典不同,原样透出。各类型专有明细(私教节数、会籍有效期等)走对应详情接口(暂未开放,后续补充)。