POST
/order/queryOrderList管理后台订单表主表-列表查询
订单·支付·售后 / 订单(主表)
基本信息
- 接口状态前端在用
- 接口URLPOST
https://dscp-dev.hn12301.net/manage-api/order/queryOrderList - 请求方式
POST - Content-Type
application/json - 暴露渠道管理后台 前缀
/manage-api - 名称来源源码注释
- 调用方已确认在用 · 管理后台(1 个前端)
- 需求上下文
- 维护人 / 最后改动wuyou 2023-12-14
- 读写数据表
order反查该表全部接口 → - 控制器
com.jxxx.dscp.api.controller.order.OrderController#queryOrderList - 源码位置
jxxx-dscp/dscp-service-business/src/main/java/com/jxxx/dscp/api/controller/order/OrderController.java:120 - 判定依据
请求参数
Header 请求参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| 无(渠道统一鉴权头见《认证方式》) | ||||
Query 请求参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| 无 | ||||
路径参数及说明
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| 无 | ||||
Body 请求参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| orderId | … | 否 | Long | 订单Id,主键 → order.order_id |
| merchantId | … | 否 | Long | 商户Id,merchant表Id → order.merchant_id |
| shopId | … | 否 | Long | 商铺Id,shop表Id → order.shop_id |
| memberId | … | 否 | Long | 会员用户Id → order.member_id |
| 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.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 |
| 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=无佣金 |
| shouldReturnCommission | … | 否 | Integer | 应返佣金 → order.should_return_commission |
| reallyReturnCommission | … | 否 | Integer | 实返佣金 → order.really_return_commission |
| idList | … | 否 | List<Long> | id列表 |
| keywords | … | 否 | String | 关键字 |
认证方式
响应参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| id | … | 否 | Long | ID,主键 → order.id |
| orderId | … | 否 | Long | 订单Id,主键 → order.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.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 | 商品名称 |
| goodsSkuName | … | 否 | String | 商品Sku名称 |
| refundAmount | … | 否 | Integer | 退款金额 |
| channelMerchantName | … | 否 | String | 销售商户名称 |
| channelShopName | … | 否 | String | 销售商铺名称 |
| transactionNo | … | 否 | String | 支付中心otg的交易流水 |
| refundTime | … | 否 | Date | 退款时间 |
响应示例
成功响应示例
{
"errcode": 0,
"errmsg": "",
"data": {
"id": "1",
"orderId": "1",
"merchantId": "1",
"merchantName": "\"string\"",
"shopId": "1",
"shopName": "\"string\"",
"memberId": "1",
"memberPhone": "\"string\"",
"orderType": "1",
"orderSource": "1",
"buyNum": "1",
"orderAmount": "1"
}
}附录 · 实现细节
调用链 / 数据表 / 调用点证据 / 源码注释 / 逻辑摘要
涉及数据表:order 反查全部引用接口 →
- OrderController#queryOrderList
- OrderService#queryList(OrderServiceImpl)
- OrderMapper#queryList
- BeanUtils.map → OrderQuery
- BeanUtils.mapList → OrderResponse
逻辑摘要:列表查询(orderService.queryList);入参与返回值经 BeanUtils 做对象/分页映射
旧站环境备注:pro:(仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
调用点证据
dscp-html-manage/src/api/order/index.ts:4管理后台 · request