POST/xgh/listOrder开放/回调

湘工惠-列表订单 · listOrder 推断名·方法名推断

开放与对接 / 湘工惠· XghController#listOrder

基本信息

接口状态前端在用置信度高免鉴权
接口URLPOSThttps://dscp-dev.hn12301.net/open-api/xgh/listOrder
请求方式POST
Content-Typeapplication/json
暴露渠道开放/回调　前缀 /open-api
名称来源方法名推断　补 javadoc 后自动转正
调用方已确认在用 · 湘工惠商城（1 个前端）
需求上下文湘工惠接口：下单、支付、退款及2个回调接口
维护人 / 最后改动liuxu　2025-04-08　最近提交：湘工惠接口：下单、支付、退款及2个回调接口
读写数据表order_goods、openapi_channel_card　反查该表全部接口 →
控制器com.jxxx.dscp.api.controller.openapi.XghController#listOrder
源码位置jxxx-dscp/dscp-service-business/src/main/java/com/jxxx/dscp/api/controller/openapi/XghController.java:368
判定依据1 个调用点：xghmall/common/http.api.js

请求参数

分页字段来自 AbstractPageRequest：pageNo（不是 pageNum）· pageSize · orderBy

Header 请求参数

参数名	参数值	是否必填	参数类型	描述说明
无（渠道统一鉴权头见《认证方式》）

Query 请求参数

参数名	参数值	是否必填	参数类型	描述说明
无

路径参数及说明

参数名	参数值	是否必填	参数类型	描述说明
无

Body 请求参数

Body 类型 ZfbListOrderRequest

参数名	参数值	是否必填	参数类型	描述说明
pageNo	…	否	Integer	当前页面
pageSize	…	否	Integer	每页记录数
orderBy	…	否	String	排序语句
orderPhone	…	否	String	→ order.order_phone
orderStatus	…	否	OrderStatus	→ order.order_status 1＝待支付 2＝待发货 3＝已发货 4＝已完成 5＝已取消 6＝退款中 7＝已退款

认证方式

免鉴权：@Route(auth = false) —— 该接口不校验登录态，改动前确认调用方与签名校验。

响应参数

data 类型 PageInfo<CardOrderResponse>

参数名	参数值	是否必填	参数类型	描述说明
list	…	否	List<T><CardOrderResponse>	分页数据集合（元素结构见下一行）
id	…	否	Long	主键 → order_goods.id
orderId	…	否	Long	订单Id，主键 → order_goods.order_id
orderName	…	否	String	订单旅游卡（商品）名称
orderPic	…	否	String	订单旅游卡（商品）主图
buyNum	…	否	Integer	购买份数 → order.buy_num
goodsAmount	…	否	Integer	商品金额
payableAmount	…	否	Integer	实收金额 → order.payable_amount
payStatus	…	否	PayStatus	支付状态，1=待支付 2=已支付 3=已退款 → order.pay_status 1＝待支付 2＝已支付 3＝已退款 4＝退款失败 5＝退款中 6＝退款申请
orderStatus	…	否	OrderStatus	订单状态 → order.order_status 1＝待支付 2＝待发货 3＝已发货 4＝已完成 5＝已取消 6＝退款中 7＝已退款
orderTime	…	否	Date	下单时间 → order.order_time
payTime	…	否	Date	支付时间
cardNum	…	否	String	卡号
total	…	否	Long	数据总数

响应示例

成功响应示例 code=0

{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "list": "[]",
    "id": "1",
    "orderId": "1",
    "orderName": "\"string\"",
    "orderPic": "\"string\"",
    "buyNum": "1",
    "goodsAmount": "1",
    "payableAmount": "1",
    "payStatus": "1",
    "orderStatus": "1",
    "orderTime": "\"2026-01-01 00:00:00\"",
    "payTime": "\"2026-01-01 00:00:00\""
  }
}

失败响应示例

{
  "data": null,
  "可能返回": [
    {
      "errcode": "99999",
      "errmsg": "服务内部错误"
    }
  ]
}

示例来自源码/导出内容，仅结构参考，非线上真实数据。

附录 · 实现细节

调用链 / 数据表 / 调用点证据 / 源码注释 / 逻辑摘要

涉及数据表：order_goods、openapi_channel_card　反查全部引用接口 →

XghController#listOrder
ZfbCardService#listOrder（ZfbCardServiceImpl）
OrderService#queryPage（OrderServiceImpl）
OrderMapper#queryPage
OrderGoodsService#mustGet（OrderGoodsServiceImpl）
OrderGoodsMapper#mustGet
OpenapiChannelCardService#queryList（OpenapiChannelCardServiceImpl）
OpenapiChannelCardMapper#queryList
BeanUtils.map → OrderQuery
BeanUtils.mapPage → CardOrderResponse

其它依赖：OrderGoodsService.mustGet、GoodsCache.get

逻辑摘要：调用 listOrder（zfbService.listOrder）

旧站环境备注：pro：（仓库 .env.pro 指向 uat；生产域名未确认，此处沿用 uat 主机示意）

调用点证据

xghmall/common/http.api.js:12　湘工惠商城 · listOrderUrl

可能抛出的业务码：99999 服务内部错误　错误码字典 →