POST
/goods/getGoodsList管理后台商品(主表)-获取Goods列表 · getGoodsList 推断名·方法名推断
商品与履约 / 商品(主表)
基本信息
- 接口状态前端在用
- 接口URLPOST
https://dscp-dev.hn12301.net/manage-api/goods/getGoodsList - 请求方式
POST - 暴露渠道管理后台 前缀
/manage-api - 名称来源方法名推断
- 调用方已确认在用 · 管理后台(1 个前端)
- 需求上下文
- 维护人 / 最后改动liuxu 2024-11-19
- 读写数据表—
- 控制器
com.jxxx.dscp.api.controller.goods.GoodsController#getGoodsList - 源码位置
jxxx-dscp/dscp-service-business/src/main/java/com/jxxx/dscp/api/controller/goods/GoodsController.java:336 - 判定依据
请求参数
Header 请求参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| 无(渠道统一鉴权头见《认证方式》) | ||||
Query 请求参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| 无 | ||||
路径参数及说明
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| 无 | ||||
Body 请求参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| 无 | ||||
认证方式
响应参数
| 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
|---|---|---|---|---|
| id | … | 否 | Long | 商品id,主键 |
| merchantId | … | 否 | Long | 所属商户id,关联merchant表id |
| shopId | … | 否 | Long | 所属商铺id,关联shop表id |
| name | … | 否 | String | 商品名称 |
| mainPic | … | 否 | String | 商品主图 |
| typeId | … | 否 | String | 商品大类id |
| cardModelId | … | 否 | Long | 卡种id |
| subTypeId | … | 否 | String | 商品小类id |
| grade | … | 否 | String | 商品等级 |
| status | … | 否 | GoodsStatus | 商品状态,1正常,2编辑中,3已下架 1=已上架 2=编辑中 3=已下架 |
| qrcode | … | 否 | String | 商品二维码 |
| shopsName | … | 否 | String | 商铺名称 |
| shortName | … | 否 | String | 商品简称 |
| weight | … | 否 | Integer | 商品权重 |
| tags | … | 否 | String | 商品标签 |
| buyPrice | … | 否 | Integer | 商品实际售价 |
| salesAmount | … | 否 | Integer | 累计销售金额 |
| recommendReason | … | 否 | String | 推荐理由 |
| introduction | … | 否 | String | 简介 |
| propagatePic | … | 否 | String | 宣传图片url地址 |
| video | … | 否 | String | 宣传视频url地址 |
| notice | … | 否 | String | 购买须知 |
| tips | … | 否 | String | 温馨提示 |
| skuList | … | 否 | List<SkuResponse> | sku列表 |
| id | … | 否 | Long | 商品SKUID,主键 |
| goodsId | … | 否 | Long | 商品ID,关联商品表id |
| goodsChannelId | … | 否 | Long | 关联商品渠道id |
| skuName | … | 否 | String | sku名称 |
| showPrice | … | 否 | Integer | 商品挂牌价 |
| buyPrice | … | 否 | Integer | 商品实际售价 |
| costPrice | … | 否 | Integer | 商品成本价 |
| buyCount | … | 否 | Integer | 单次可购买数量 |
| stock | … | 否 | Integer | 库存数量 |
| isLogistic | … | 否 | Boolean | 是否需要物流 |
| carriageId | … | 否 | Long | 物流模版ID,关联carriage表id |
| mold | … | 否 | GoodsMold | 商品状态,1实物商品,2虚拟商品,3电子卡券 1=实物商品 2=虚拟商品 3=电子卡券 |
| isDistributes | … | 否 | Boolean | 是否可分销 |
| commission | … | 否 | Integer | 分销佣金 |
| isPreferential | … | 否 | Boolean | 是否可使用优惠券 |
| isUseScore | … | 否 | Boolean | 是否可使用积分抵扣 |
| isAddScore | … | 否 | Boolean | 购买后是否产生积分 |
| useScoreRate | … | 否 | BigDecimal | 抵扣积分倍率 |
| addScoreRate | … | 否 | BigDecimal | 产生积分倍率 |
| cardNum | … | 否 | Integer | 发卡数量,仅旅游卡商品 |
| skuEntranceList | … | 否 | List<SkuEntrance> | 景区入口列表 |
| id | … | 否 | Long | ID,主键 |
| skuId | … | 否 | Long | 所属关联sku表id |
| entranceName | … | 否 | String | 景区入口名称 |
| merchantId | … | 否 | Long | 所属商户id |
| shopId | … | 否 | Long | 所属商铺id |
| goodsId | … | 否 | Long | 商品ID,关联商品表id |
| createdBy | … | 否 | String | 创建人id |
| createdTime | … | 否 | Date | 创建时间 |
| relationList | … | 否 | List<GoodsRelationResponse> | |
| id | … | 否 | Long | id |
| goodsId | … | 否 | Long | goodsId |
| channelType | … | 否 | ChannelType | 类型 |
| thirdId | … | 否 | String | 第三方id |
| thirdName | … | 否 | String | 第三方名称 |
| createdTime | … | 否 | Date | 创建时间 |
| updatedTime | … | 否 | Date | 修改时间 |
| businessTime | … | 否 | String | 营业时间 |
| thirdId | … | 否 | String | 第三方id |
| thirdName | … | 否 | String | 第三方名称 |
| expireDate | … | 否 | Date | |
| isRefund | … | 否 | Boolean | |
| areaInfo | … | 否 | String | |
| shop | … | 否 | Shop | |
| id | … | 否 | Long | 商铺id,主键 |
| merchantId | … | 否 | Long | 所属商户id,关联merchant表id |
| merchantType | … | 否 | MerchantType | 商户类型 1=供应商 2=分销商 3=发卡商 4=其他 5=酒店 6=第三方 |
| name | … | 否 | String | 商铺名称 |
| logo | … | 否 | String | 商铺LOGO图片url地址 |
| typeId | … | 否 | Long | 商铺大类 |
| subTypeId | … | 否 | Long | 商铺小类ID |
| status | … | 否 | ShopStatus | 商铺状态,1正常运营,2审核中,3暂停运营,4已关店 1=正常运营 2=审核中 3=暂停运营 4=已关店 |
| provinceId | … | 否 | String | 省id |
| cityId | … | 否 | String | 市id |
| districtId | … | 否 | String | 区县id |
| address | … | 否 | String | 商铺地址 |
| mobile | … | 否 | String | 客服电话 |
| linkman | … | 否 | String | 商户联系人 |
| linkphone | … | 否 | String | 商户联系人手机 |
| manager | … | 否 | String | 专属客户经理 |
| level | … | 否 | String | 等级 |
| lng | … | 否 | String | 经度 |
| lat | … | 否 | String | 纬度 |
| introduction | … | 否 | String | 简介 |
| businessTime | … | 否 | String | 营业时间 |
| tags | … | 否 | String | 商铺标签 |
| mainPic | … | 否 | String | 景区主图url地址 |
| propagatePic | … | 否 | String | 宣传图片url地址 |
| video | … | 否 | String | 景区视频url地址 |
| poster | … | 否 | String | 分享海报url地址 |
| propagateContent | … | 否 | String | 宣传语 |
| description | … | 否 | String | 图文详情 |
| ticketInfo | … | 否 | String | 门票信息 |
| trafficInfo | … | 否 | String | 交通信息 |
| tips | … | 否 | String | 温馨提示 |
| isDeleted | … | 否 | Boolean | 是否删除 |
| createdBy | … | 否 | String | 创建人id |
| createdTime | … | 否 | Date | 创建时间 |
| updatedBy | … | 否 | String | 更新人id |
| updatedTime | … | 否 | Date | 修改时间 |
| thirdId | … | 否 | String | 第三方id |
| thirdName | … | 否 | String | 第三方名称 |
响应示例
成功响应示例
{
"errcode": 0,
"errmsg": "",
"data": {
"id": "1",
"merchantId": "1",
"shopId": "1",
"name": "\"string\"",
"mainPic": "\"string\"",
"typeId": "\"string\"",
"cardModelId": "1",
"subTypeId": "\"string\"",
"grade": "\"string\"",
"status": "1",
"qrcode": "\"string\"",
"shopsName": "\"string\""
}
}附录 · 实现细节
调用链 / 数据表 / 调用点证据 / 源码注释 / 逻辑摘要
- GoodsController#getGoodsList
逻辑摘要:见下方调用链
旧站环境备注:pro:(仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
调用点证据
dscp-html-manage/src/api/goods/index.ts:23管理后台 · request