Files
xlhlw/资料/planner_teacher/docs/api/order.md
2026-02-05 01:24:42 +08:00

4.1 KiB
Raw Blame History

订单服务API文档

本文档描述了订单服务的API接口使用方法。

订单状态说明

状态码 状态名称 说明
0 未开始 订单创建后的初始状态
1 规划中 规划师已开始为学员进行规划对应学员step为1-5
2 已结束 规划全部完成对应学员step为6
3 已取消 预约失败或订单被取消
4 待审核 学员发起预约,等待规划师审核

学员步骤说明

步骤码 步骤名称 说明
1 专业规划 进行专业选择规划
2 院校规划 进行院校选择规划
3 志愿填报 进行志愿填报规划
4 待修改 规划需要修改
5 待确认 规划待学员确认
6 已完成 规划已完成

API接口

1. 获取订单列表

GET /order/list

查询订单列表,支持按类型筛选和分页。

请求参数

参数名 类型 必填 说明
type1 String 一级类型:待审核/进行中/已完成/已取消
type2 String 二级类型:筛选条件
page Integer 页码默认1
size Integer 每页大小默认10
pid Long 规划师ID
mid Long 会员ID如果指定则只查询该会员的订单

响应结果

{
  "code": 200,
  "message": "success",
  "data": {
    "records": [
      {
        "orderNo": "订单号",
        "studentName": "学员姓名",
        "studentPhone": "学员手机号",
        "area": "所在地区",
        "startTime": "任务开始时间",
        "endTime": "任务完成时间",
        "operation": "操作类型",
        "currentStep": "当前步骤",
        "memberId": 123,
        "status": 1,
        "plannerId": 456
      }
    ],
    "total": 100,
    "size": 10,
    "current": 1
  }
}

2. 创建订单

POST /order/create

创建新订单。

请求参数

{
  "memberId": 123,
  "plannerId": 456
}

响应结果

{
  "code": 200,
  "message": "success",
  "data": {
    "id": 1,
    "orderNo": "订单号",
    "memberId": 123,
    "plannerId": 456,
    "status": 0
  }
}

3. 审核订单

POST /order/audit

审核待审核状态的订单。

请求参数

{
  "orderNo": "订单号",
  "approved": true
}

响应结果

{
  "code": 200,
  "message": "订单审核通过"
}

4. 完成订单

POST /order/complete

将规划中的订单标记为已完成。

请求参数

{
  "orderNo": "订单号"
}

响应结果

{
  "code": 200,
  "message": "订单已完成"
}

5. 取消订单

POST /order/cancel

取消订单。

请求参数

{
  "orderNo": "订单号"
}

响应结果

{
  "code": 200,
  "message": "订单已取消"
}

6. 更新订单状态

POST /order/status

直接更新订单状态(一般情况下推荐使用审核、完成、取消等特定接口)。

请求参数

{
  "orderNo": "订单号",
  "status": 2
}

响应结果

{
  "code": 200,
  "message": "订单状态已更新"
}

订单操作流程

  1. 学员发起预约 -> 订单状态为待审核(4)
  2. 规划师审核订单:
    • 通过 -> 订单状态变为规划中(1),学员步骤变为专业规划(1)
    • 拒绝 -> 订单状态变为已取消(3)
  3. 规划师进行规划,学员步骤依次为:
    • 专业规划(1) -> 院校规划(2) -> 志愿填报(3) -> 待修改(4) -> 待确认(5)
  4. 规划完成,规划师确认 -> 订单状态变为已结束(2),学员步骤变为已完成(6)

错误码说明

错误码 说明
400 请求参数错误
404 订单不存在
500 服务器内部错误