POST/cqy/listOrder开放/回调

对接方 CQY(代号待业务确认)-列表订单 · listOrder 推断名·方法名推断

开放与对接 / 对接方 CQY(代号待业务确认)· OpenapiCqyRecordController#listOrder

基本信息

  • 接口状态前端在用 置信度 高 免鉴权
  • 接口URLPOSThttps://dscp-dev.hn12301.net/open-api/cqy/listOrder
  • 请求方式POST
  • Content-Typeapplication/json
  • 暴露渠道开放/回调 前缀 /open-api
  • 名称来源方法名推断 补 javadoc 后自动转正
  • 调用方已确认在用 · 湘工惠商城(1 个前端)
  • 需求上下文春秋游退款、退款回调、订单详情、订单列表
  • 维护人 / 最后改动liuxu 2026-03-23 最近提交:春秋游退款、退款回调、订单详情、订单列表
  • 读写数据表order_goods 反查该表全部接口 →
  • 控制器com.jxxx.dscp.api.controller.openapi.OpenapiCqyRecordController#listOrder
  • 源码位置jxxx-dscp/dscp-service-business/src/main/java/com/jxxx/dscp/api/controller/openapi/OpenapiCqyRecordController.java:510
  • 判定依据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<OrderResponse>
参数名参数值是否必填参数类型描述说明
list…否List<T><OrderResponse>分页数据集合(元素结构见下一行)
id…否LongID,主键 → order_goods.id
orderId…否Long订单Id,主键 → order_goods.order_id
merchantId…否Long商户Id,merchant表Id → order.merchant_id
merchantName…否String商户名称
shopId…否Long商铺Id,shop表Id → order.shop_id
shopName…否String商铺名称
memberId…否Long会员用户Id → order.member_id
memberPhone…否String会员用户手机号
orderType…否OrderType订单类型,1旅游年卡,2美食特产,3生活好物,4自驾路线,5非遗专区,6景区套票,7酒店民宿,8餐饮美食 → order.order_type 1=景区套票 2=酒店民宿 3=餐饮美食 4=美食特产 5=自驾路线 6=非遗专区 7=旅游卡 8=旅游卡
orderSource…否OrderSource订单来源,1H5,2微信小程序,3支付宝小程序,4安卓APP,5IOSAPP → order.order_source 1=H5 2=微信小程序 3=支付宝小程序 4=安卓APP 5=IOSAPP 6=YOUZHENG 7=XIANGGONGHUI 8=XIANGYUEMA 9=ZHIHUIYOU 10=BCM 11=JIANHANG 24=MEIKE
buyNum…否Integer购买份数 → order.buy_num
orderAmount…否Integer订单金额(订单原始金额) → order.order_amount
receivableAmount…否Integer应收金额 → order.receivable_amount
payableAmount…否Integer实收金额 → order.payable_amount
reducedPrice…否Integer优惠金额 → order.reduced_price
expressAmount…否Integer运费金额 → order.express_amount
discountAmount…否Integer折扣金额 → order.discount_amount
isDelivery…否Integer是否配送(0=否;1=是) → order_goods.is_delivery
payStatus…否PayStatus支付状态,1=待支付 2=已支付 3=已退款 → order.pay_status 1=待支付 2=已支付 3=已退款 4=退款失败 5=退款中 6=退款申请
orderStatus…否OrderStatus订单状态,1=待确认 2=已确认 3=待发货 4=已发货 5=已完成 6=已取消 → order.order_status 1=待支付 2=待发货 3=已发货 4=已完成 5=已取消 6=退款中 7=已退款
orderPhone…否String下单人手机 → order.order_phone
orderRemark…否String订单备注 → order.order_remark
orderTime…否Date下单时间 → order.order_time
orderExpressTime…否Date订单失效时间 → order.order_express_time
isSendIntegral…否Integer订单积分是否已发放(0=否 1=是) → order.is_send_integral
isComment…否Integer订单是否已经评价(0=否;1=是) → order.is_comment
isProfitSharing…否Integer订单资金是否已冻结(0=已冻结 1=已解冻) → order.is_profit_sharing
isSendCommission…否SendCommission订单佣金是否已发放,0=否 1=是 2=无佣金 → order.is_send_commission 0=否 1=是 2=无佣金
icode…否String分销邀请码 → order.icode
shouldReturnCommission…否Integer应返佣金 → order.should_return_commission
reallyReturnCommission…否Integer实返佣金 → order.really_return_commission
goodsName…否String商品名称 → order_goods.goods_name
goodsSkuName…否String商品Sku名称 → order_goods.goods_sku_name
refundAmount…否Integer退款金额
channelMerchantName…否String销售商户名称
channelShopName…否String销售商铺名称
transactionNo…否String支付中心otg的交易流水
refundTime…否Date退款时间
total…否Long数据总数

响应示例

成功响应示例 code=0

{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "list": "[]",
    "id": "1",
    "orderId": "1",
    "merchantId": "1",
    "merchantName": "\"string\"",
    "shopId": "1",
    "shopName": "\"string\"",
    "memberId": "1",
    "memberPhone": "\"string\"",
    "orderType": "1",
    "orderSource": "1",
    "buyNum": "1"
  }
}

失败响应示例

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

附录 · 实现细节

调用链 / 数据表 / 调用点证据 / 源码注释 / 逻辑摘要
涉及数据表:order_goods 反查全部引用接口 →
  • OpenapiCqyRecordController#listOrder
  • OrderService#queryPage(OrderServiceImpl)
  • OrderMapper#queryPage
  • OrderGoodsService#mustGet(OrderGoodsServiceImpl)
  • OrderGoodsMapper#mustGet
  • BeanUtils.map → OrderQuery
  • BeanUtils.mapPage → OrderResponse
其它依赖:OrderGoodsService.mustGet、GoodsCache.get
逻辑摘要:调用 isEmpty(StrUtil.isEmpty);分页查询(orderService.queryPage);调用 mustGet(orderGoodsService.mustGet);入参与返回值经 BeanUtils 做对象/分页映射
源码内联注释(旧站解析结果)
  • 暂时只查询旅游卡订单
  • 按订单时间排序
  • 查询出旅游卡订单关联的商品信息
  • 根据商品ID查询出商品信息
旧站环境备注:pro:(仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
调用点证据
  • xghmall/common/http.api.js:81 湘工惠商城 · listCqyOrderUrl
可能抛出的业务码:99999 服务内部错误 错误码字典 →
由 tools/build.py 从 data/apis.json 生成 · 生成时间 2026-09-12 19:49 · 数据口径见说明 · 本页数字非手写,均来自同一份数据