POST/xgh/getOrder开放/回调

湘工惠-获取订单 · getOrder 推断名·方法名推断

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

基本信息

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

请求参数

Header 请求参数

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

Query 请求参数

参数名参数值是否必填参数类型描述说明
orderId…是String → order_goods.order_id

路径参数及说明

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

Body 请求参数

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

认证方式

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

响应参数

data 类型 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卡号

响应示例

成功响应示例 code=0

{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "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\"",
    "cardNum": "\"string\""
  }
}

失败响应示例

{
  "data": null,
  "可能返回": [
    {
      "errcode": "99999",
      "errmsg": "服务内部错误"
    }
  ]
}
示例来自源码/导出内容,仅结构参考,非线上真实数据。

附录 · 实现细节

调用链 / 数据表 / 调用点证据 / 源码注释 / 逻辑摘要
涉及数据表:order_goods、openapi_channel_card 反查全部引用接口 →
  • XghController#getOrder
  • ZfbCardService#getOrder(ZfbCardServiceImpl)
  • OrderGoodsService#mustGet(OrderGoodsServiceImpl)
  • OrderGoodsMapper#mustGet
  • OpenapiChannelCardService#queryList(OpenapiChannelCardServiceImpl)
  • OpenapiChannelCardMapper#queryList
  • BeanUtils.map → CardOrderResponse
其它依赖:OrderGoodsService.mustGet、GoodsCache.get
逻辑摘要:查询详情(zfbService.getOrder)
旧站环境备注:pro:(仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
调用点证据
  • xghmall/common/http.api.js:10 湘工惠商城 · queryOrderUrl
可能抛出的业务码:99999 服务内部错误 错误码字典 →
由 tools/build.py 从 data/apis.json 生成 · 生成时间 2026-09-12 19:49 · 数据口径见说明 · 本页数字非手写,均来自同一份数据