物流/运费 carriage

模块 carriage:共 12 个接口 —— 12 个被前端调用(在用),0 个未被调用(含 0 个开放/回调/内部)。用下方筛选可只看“在用/未使用”,或在右栏目录按名称过滤。

CarriageController 6/6 在用

POST /carriage/addCarriage 在用管理后台 #
Carriage-新增 · CarriageController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageController#addCarriage
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriagecarriage_rule
ControllerCarriageController#addCarriage
转换BeanUtils.map → Carriage ⇒ 表 carriage
转换BeanUtils.map → CarriageRule ⇒ 表 carriage_rule
ServiceCarriageService#add (CarriageServiceImpl)
MapperCarriageMapper#insert ⇒ 表 carriage
其它依赖(权限 / 会话 / 缓存 / 校验等,不直接读写业务表)· 2
ChaosTransactionTemplate.executeCarriageRuleService.addList

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriage/addCarriage
uathttps://dscp-uat.hn12301.net/manage-api/carriage/addCarriage
prohttps://dscp-uat.hn12301.net/manage-api/carriage/addCarriage (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body CarriageAddRequest
字段类型必填取值/校验表 / 列说明
nameString必填carriage.name模板名称
typeTmpType1卖家包邮2买家承担3已下架carriage.type模板类型(枚举:carriage.tmpType)
isDefaultBooleancarriage.is_default是否默认
carriageRuleListList<CarriageRuleAddRequest>运费规则
carriageRuleList[].carriageIdLong必填carriage_rule.carriage_id运费模板ID,关联运费模板表id
carriageRuleList[].areaCodeStringcarriage_rule.area_code配送区域编码,多个以","逗号分开
carriageRuleList[].areaNameStringcarriage_rule.area_name配送区域名称,多个以","逗号分开
carriageRuleList[].firstIntegercarriage_rule.first首件(个)
carriageRuleList[].firstCostIntegercarriage_rule.first_cost首件费用
carriageRuleList[].proceedIntegercarriage_rule.proceed续件(个)
carriageRuleList[].proceedCostIntegercarriage_rule.proceed_cost续件费用
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /carriage/addCarriage
{
  "body": {
    "name": "",
    "type": "1",
    "isDefault": false,
    "carriageRuleList": [
      {
        "carriageId": 1,
        "areaCode": "",
        "areaName": "",
        "first": 0,
        "firstCost": 0,
        "proceed": 0,
        "proceedCost": 0
      }
    ]
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志carriage / 新增运费模板
逻辑摘要调用 execute(newTransactionTemplate.execute);新增(carriageService.add);调用 isNotEmpty(CollectionUtils.isNotEmpty);入参与返回值经 BeanUtils 做对象/分页映射
内联注释
  • 回滚事务
  • 处理异常
POST /carriage/deleteCarriage 在用管理后台 #
Carriage-删除 · CarriageController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageController#deleteCarriage
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriage
ControllerCarriageController#deleteCarriage
ServiceCarriageService#delete (CarriageServiceImpl)
MapperCarriageMapper#deleteById ⇒ 表 carriage

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriage/deleteCarriage
uathttps://dscp-uat.hn12301.net/manage-api/carriage/deleteCarriage
prohttps://dscp-uat.hn12301.net/manage-api/carriage/deleteCarriage (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填carriage.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /carriage/deleteCarriage
{
  "body": {
    "id": 1
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志carriage / 删除运费模板
逻辑摘要删除(carriageService.delete)
POST /carriage/getCarriage 在用管理后台 #
Carriage-详情 · CarriageController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageController#getCarriage
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriagecarriage_rule
ControllerCarriageController#getCarriage
转换BeanUtils.mapList → CarriageRuleResponse
ServiceCarriageService#get (CarriageServiceImpl)
MapperCarriageMapper#selectById ⇒ 表 carriage
ServiceCarriageRuleService#queryList (CarriageRuleServiceImpl)
MapperCarriageRuleMapper#selectList ⇒ 表 carriage_rule

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriage/getCarriage
uathttps://dscp-uat.hn12301.net/manage-api/carriage/getCarriage
prohttps://dscp-uat.hn12301.net/manage-api/carriage/getCarriage (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填carriage.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 CarriageResponse (object)
字段类型必填取值/校验表 / 列说明
idLongcarriage.id主键,模板ID
nameStringcarriage.name模板名称
typeTmpType1卖家包邮2买家承担3已下架carriage.type模板类型(枚举:carriage.tmpType)
isDefaultBooleancarriage.is_default是否默认
timeCitedLong被引用次数
carriageRuleListList<CarriageRuleResponse>运费规则
carriageRuleList[].idLongcarriage.id主键ID
carriageRuleList[].carriageIdLongcarriage_rule.carriage_id运费模板ID,关联运费模板表id
carriageRuleList[].areaCodeStringcarriage_rule.area_code配送区域编码,多个以","逗号分开
carriageRuleList[].areaNameStringcarriage_rule.area_name配送区域名称,多个以","逗号分开
carriageRuleList[].firstIntegercarriage_rule.first首件(个)
carriageRuleList[].firstCostIntegercarriage_rule.first_cost首件费用
carriageRuleList[].proceedIntegercarriage_rule.proceed续件(个)
carriageRuleList[].proceedCostIntegercarriage_rule.proceed_cost续件费用
示例
请求示例 (自动生成,仅结构参考)
POST /carriage/getCarriage
{
  "body": {
    "id": 1
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "id": 1,
    "name": "",
    "type": "1",
    "isDefault": false,
    "timeCited": 0,
    "carriageRuleList": [
      {
        "id": 1,
        "carriageId": 1,
        "areaCode": "",
        "areaName": "",
        "first": 0,
        "firstCost": 0,
        "proceed": 0,
        "proceedCost": 0
      }
    ]
  }
}
处理逻辑
逻辑摘要查询详情(carriageService.get);列表查询(carriageRuleService.queryList);入参与返回值经 BeanUtils 做对象/分页映射
内联注释
  • 查询运费规则
POST /carriage/queryCarriageList 在用管理后台 #
Carriage-列表查询 · CarriageController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageController#queryCarriageList
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriage
ControllerCarriageController#queryCarriageList
转换BeanUtils.map → CarriageQuery
ServiceCarriageService#queryList (CarriageServiceImpl)
MapperCarriageMapper#selectList ⇒ 表 carriage

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriage/queryCarriageList
uathttps://dscp-uat.hn12301.net/manage-api/carriage/queryCarriageList
prohttps://dscp-uat.hn12301.net/manage-api/carriage/queryCarriageList (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body CarriageListRequest
字段类型必填取值/校验表 / 列说明
nameString可选(@MvcOptional)carriage.name模板名称
typeTmpType1卖家包邮2买家承担3已下架carriage.type模板类型(枚举:carriage.tmpType)
isDefaultBoolean可选(@MvcOptional)carriage.is_default是否默认
idListList<Long>可选(@MvcOptional)id列表
keywordsString可选(@MvcOptional)关键字
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 List<CarriageResponse> (list)
字段类型必填取值/校验表 / 列说明
[ ]array列表,元素结构见下
idLongcarriage.id主键,模板ID
nameStringcarriage.name模板名称
typeTmpType1卖家包邮2买家承担3已下架carriage.type模板类型(枚举:carriage.tmpType)
isDefaultBooleancarriage.is_default是否默认
timeCitedLong被引用次数
carriageRuleListList<CarriageRuleResponse>运费规则
carriageRuleList[].idLongcarriage.id主键ID
carriageRuleList[].carriageIdLong运费模板ID,关联运费模板表id
carriageRuleList[].areaCodeString配送区域编码,多个以","逗号分开
carriageRuleList[].areaNameString配送区域名称,多个以","逗号分开
carriageRuleList[].firstInteger首件(个)
carriageRuleList[].firstCostInteger首件费用
carriageRuleList[].proceedInteger续件(个)
carriageRuleList[].proceedCostInteger续件费用
示例
请求示例 (自动生成,仅结构参考)
POST /carriage/queryCarriageList
{
  "body": {
    "name": "",
    "type": "1",
    "isDefault": false,
    "idList": "",
    "keywords": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": 1,
      "name": "",
      "type": "1",
      "isDefault": false,
      "timeCited": 0,
      "carriageRuleList": [
        {
          "id": 1,
          "carriageId": 1,
          "areaCode": "",
          "areaName": "",
          "first": 0,
          "firstCost": 0,
          "proceed": 0,
          "proceedCost": 0
        }
      ]
    }
  ]
}
处理逻辑
逻辑摘要列表查询(carriageService.queryList);入参与返回值经 BeanUtils 做对象/分页映射
POST /carriage/queryCarriagePage 在用管理后台 #
Carriage-分页查询 · CarriageController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageController#queryCarriagePage
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriagesku
ControllerCarriageController#queryCarriagePage
转换BeanUtils.map → CarriageQuery
ServiceCarriageService#queryPage (CarriageServiceImpl)
MapperCarriageMapper#selectPage ⇒ 表 carriage
ServiceSkuService#count (SkuServiceImpl)
MapperSkuMapper#selectCount ⇒ 表 sku

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriage/queryCarriagePage
uathttps://dscp-uat.hn12301.net/manage-api/carriage/queryCarriagePage
prohttps://dscp-uat.hn12301.net/manage-api/carriage/queryCarriagePage (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body CarriagePageRequest
字段类型必填取值/校验表 / 列说明
pageNumInteger页码(继承自框架分页基类 AbstractPageRequest)
pageSizeInteger每页条数(继承自框架分页基类 AbstractPageRequest)
nameString可选(@MvcOptional)carriage.name模板名称
typeTmpType1卖家包邮2买家承担3已下架carriage.type模板类型(枚举:carriage.tmpType)
isDefaultBoolean可选(@MvcOptional)carriage.is_default是否默认
idListList<Long>可选(@MvcOptional)id列表
keywordsString可选(@MvcOptional)关键字
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 PageInfo<CarriageResponse> (page)
字段类型必填取值/校验表 / 列说明
list / recordsarray分页列表,元素结构见下
totallong总条数(PageInfo)
idLongcarriage.id主键,模板ID
nameStringcarriage.name模板名称
typeTmpType1卖家包邮2买家承担3已下架carriage.type模板类型(枚举:carriage.tmpType)
isDefaultBooleancarriage.is_default是否默认
timeCitedLong被引用次数
carriageRuleListList<CarriageRuleResponse>运费规则
carriageRuleList[].idLongcarriage.id主键ID
carriageRuleList[].carriageIdLongsku.carriage_id运费模板ID,关联运费模板表id
carriageRuleList[].areaCodeString配送区域编码,多个以","逗号分开
carriageRuleList[].areaNameString配送区域名称,多个以","逗号分开
carriageRuleList[].firstInteger首件(个)
carriageRuleList[].firstCostInteger首件费用
carriageRuleList[].proceedInteger续件(个)
carriageRuleList[].proceedCostInteger续件费用
示例
请求示例 (自动生成,仅结构参考)
POST /carriage/queryCarriagePage
{
  "body": {
    "pageNum": 0,
    "pageSize": 0,
    "name": "",
    "type": "1",
    "isDefault": false,
    "idList": "",
    "keywords": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "records": [
      {
        "id": 1,
        "name": "",
        "type": "1",
        "isDefault": false,
        "timeCited": 0,
        "carriageRuleList": [
          {
            "id": 1,
            "carriageId": 1,
            "areaCode": "",
            "areaName": "",
            "first": 0,
            "firstCost": 0,
            "proceed": 0,
            "proceedCost": 0
          }
        ]
      }
    ],
    "total": 0
  }
}
处理逻辑
逻辑摘要分页查询(carriageService.queryPage);调用 count(skuService.count);入参与返回值经 BeanUtils 做对象/分页映射
POST /carriage/updateCarriage 在用管理后台 #
Carriage-更新 · CarriageController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageController#updateCarriage
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriagecarriage_rule
ControllerCarriageController#updateCarriage
转换BeanUtils.map → Carriage ⇒ 表 carriage
转换BeanUtils.map → CarriageRule ⇒ 表 carriage_rule
ServiceCarriageService#update (CarriageServiceImpl)
MapperCarriageMapper#updateById ⇒ 表 carriage
ServiceCarriageRuleService#queryList (CarriageRuleServiceImpl)
MapperCarriageRuleMapper#selectList ⇒ 表 carriage_rule
ServiceCarriageRuleService#delete (CarriageRuleServiceImpl)
MapperCarriageRuleMapper#deleteById ⇒ 表 carriage_rule
其它依赖(权限 / 会话 / 缓存 / 校验等,不直接读写业务表)· 3
ChaosTransactionTemplate.executeCarriageRuleService.addListCarriageRuleService.updateList

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriage/updateCarriage
uathttps://dscp-uat.hn12301.net/manage-api/carriage/updateCarriage
prohttps://dscp-uat.hn12301.net/manage-api/carriage/updateCarriage (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body CarriageUpdateRequest
字段类型必填取值/校验表 / 列说明
idLong必填carriage.id主键,模板ID
nameString必填carriage.name模板名称
typeTmpType1卖家包邮2买家承担3已下架carriage.type模板类型(枚举:carriage.tmpType)
isDefaultBooleancarriage.is_default是否默认
carriageRuleListList<CarriageRuleUpdateRequest>运费规则
carriageRuleList[].idLong必填carriage.id主键ID
carriageRuleList[].carriageIdLong必填carriage_rule.carriage_id运费模板ID,关联运费模板表id
carriageRuleList[].areaCodeStringcarriage_rule.area_code配送区域编码,多个以","逗号分开
carriageRuleList[].areaNameStringcarriage_rule.area_name配送区域名称,多个以","逗号分开
carriageRuleList[].firstIntegercarriage_rule.first首件(个)
carriageRuleList[].firstCostIntegercarriage_rule.first_cost首件费用
carriageRuleList[].proceedIntegercarriage_rule.proceed续件(个)
carriageRuleList[].proceedCostIntegercarriage_rule.proceed_cost续件费用
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /carriage/updateCarriage
{
  "body": {
    "id": 1,
    "name": "",
    "type": "1",
    "isDefault": false,
    "carriageRuleList": [
      {
        "id": 1,
        "carriageId": 1,
        "areaCode": "",
        "areaName": "",
        "first": 0,
        "firstCost": 0,
        "proceed": 0,
        "proceedCost": 0
      }
    ]
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志carriage / 更新运费模板
逻辑摘要更新(carriageService.update);调用 execute(newTransactionTemplate.execute);调用 isNotEmpty(CollectionUtils.isNotEmpty);入参与返回值经 BeanUtils 做对象/分页映射
内联注释
  • 处理运费规则
  • 查询现有数据
  • 处理删除数据
  • 处理新增数据
  • 处理更新数据
  • 回滚事务
  • 处理异常

CarriageRuleController 6/6 在用

POST /carriageRule/addCarriageRule 在用管理后台 #
运费规则表-新增 · CarriageRuleController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageRuleController#addCarriageRule
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriage_rule
ControllerCarriageRuleController#addCarriageRule
转换BeanUtils.map → CarriageRule ⇒ 表 carriage_rule
ServiceCarriageRuleService#add (CarriageRuleServiceImpl)
MapperCarriageRuleMapper#insert ⇒ 表 carriage_rule

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriageRule/addCarriageRule
uathttps://dscp-uat.hn12301.net/manage-api/carriageRule/addCarriageRule
prohttps://dscp-uat.hn12301.net/manage-api/carriageRule/addCarriageRule (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body CarriageRuleAddRequest
字段类型必填取值/校验表 / 列说明
carriageIdLong必填carriage_rule.carriage_id运费模板ID,关联运费模板表id
areaCodeStringcarriage_rule.area_code配送区域编码,多个以","逗号分开
areaNameStringcarriage_rule.area_name配送区域名称,多个以","逗号分开
firstIntegercarriage_rule.first首件(个)
firstCostIntegercarriage_rule.first_cost首件费用
proceedIntegercarriage_rule.proceed续件(个)
proceedCostIntegercarriage_rule.proceed_cost续件费用
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 CarriageRuleResponse (object)
字段类型必填取值/校验表 / 列说明
idLongcarriage_rule.id主键ID
carriageIdLongcarriage_rule.carriage_id运费模板ID,关联运费模板表id
areaCodeStringcarriage_rule.area_code配送区域编码,多个以","逗号分开
areaNameStringcarriage_rule.area_name配送区域名称,多个以","逗号分开
firstIntegercarriage_rule.first首件(个)
firstCostIntegercarriage_rule.first_cost首件费用
proceedIntegercarriage_rule.proceed续件(个)
proceedCostIntegercarriage_rule.proceed_cost续件费用
示例
请求示例 (自动生成,仅结构参考)
POST /carriageRule/addCarriageRule
{
  "body": {
    "carriageId": 1,
    "areaCode": "",
    "areaName": "",
    "first": 0,
    "firstCost": 0,
    "proceed": 0,
    "proceedCost": 0
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "id": 1,
    "carriageId": 1,
    "areaCode": "",
    "areaName": "",
    "first": 0,
    "firstCost": 0,
    "proceed": 0,
    "proceedCost": 0
  }
}
处理逻辑
操作日志carriage / 新增运费规则
逻辑摘要新增(carriageRuleService.add);入参与返回值经 BeanUtils 做对象/分页映射
POST /carriageRule/deleteCarriageRule 在用管理后台 #
运费规则表-删除 · CarriageRuleController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageRuleController#deleteCarriageRule
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriage_rule
ControllerCarriageRuleController#deleteCarriageRule
ServiceCarriageRuleService#delete (CarriageRuleServiceImpl)
MapperCarriageRuleMapper#deleteById ⇒ 表 carriage_rule

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriageRule/deleteCarriageRule
uathttps://dscp-uat.hn12301.net/manage-api/carriageRule/deleteCarriageRule
prohttps://dscp-uat.hn12301.net/manage-api/carriageRule/deleteCarriageRule (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填carriage_rule.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /carriageRule/deleteCarriageRule
{
  "body": {
    "id": 1
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志carriage / 删除运费规则
逻辑摘要删除(carriageRuleService.delete)
POST /carriageRule/getCarriageRule 在用管理后台 #
运费规则表-详情 · CarriageRuleController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageRuleController#getCarriageRule
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriage_rule
ControllerCarriageRuleController#getCarriageRule
ServiceCarriageRuleService#get (CarriageRuleServiceImpl)
MapperCarriageRuleMapper#selectById ⇒ 表 carriage_rule

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriageRule/getCarriageRule
uathttps://dscp-uat.hn12301.net/manage-api/carriageRule/getCarriageRule
prohttps://dscp-uat.hn12301.net/manage-api/carriageRule/getCarriageRule (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body IdRequest
字段类型必填取值/校验表 / 列说明
idLong必填carriage_rule.idid
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 CarriageRuleResponse (object)
字段类型必填取值/校验表 / 列说明
idLongcarriage_rule.id主键ID
carriageIdLongcarriage_rule.carriage_id运费模板ID,关联运费模板表id
areaCodeStringcarriage_rule.area_code配送区域编码,多个以","逗号分开
areaNameStringcarriage_rule.area_name配送区域名称,多个以","逗号分开
firstIntegercarriage_rule.first首件(个)
firstCostIntegercarriage_rule.first_cost首件费用
proceedIntegercarriage_rule.proceed续件(个)
proceedCostIntegercarriage_rule.proceed_cost续件费用
示例
请求示例 (自动生成,仅结构参考)
POST /carriageRule/getCarriageRule
{
  "body": {
    "id": 1
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "id": 1,
    "carriageId": 1,
    "areaCode": "",
    "areaName": "",
    "first": 0,
    "firstCost": 0,
    "proceed": 0,
    "proceedCost": 0
  }
}
处理逻辑
逻辑摘要查询详情(carriageRuleService.get);入参与返回值经 BeanUtils 做对象/分页映射
POST /carriageRule/queryCarriageRuleList 在用管理后台 #
运费规则表-列表查询 · CarriageRuleController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageRuleController#queryCarriageRuleList
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriage_rule
ControllerCarriageRuleController#queryCarriageRuleList
转换BeanUtils.map → CarriageRuleQuery
ServiceCarriageRuleService#queryList (CarriageRuleServiceImpl)
MapperCarriageRuleMapper#selectList ⇒ 表 carriage_rule

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriageRule/queryCarriageRuleList
uathttps://dscp-uat.hn12301.net/manage-api/carriageRule/queryCarriageRuleList
prohttps://dscp-uat.hn12301.net/manage-api/carriageRule/queryCarriageRuleList (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body CarriageRuleListRequest
字段类型必填取值/校验表 / 列说明
carriageIdLong可选(@MvcOptional)carriage_rule.carriage_id运费模板ID,关联运费模板表id
firstInteger可选(@MvcOptional)carriage_rule.first首件(个)
firstCostInteger可选(@MvcOptional)carriage_rule.first_cost首件费用
proceedInteger可选(@MvcOptional)carriage_rule.proceed续件(个)
proceedCostInteger可选(@MvcOptional)carriage_rule.proceed_cost续件费用
idListList<Long>可选(@MvcOptional)id列表
keywordsString可选(@MvcOptional)关键字
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 List<CarriageRuleResponse> (list)
字段类型必填取值/校验表 / 列说明
[ ]array列表,元素结构见下
idLongcarriage_rule.id主键ID
carriageIdLongcarriage_rule.carriage_id运费模板ID,关联运费模板表id
areaCodeStringcarriage_rule.area_code配送区域编码,多个以","逗号分开
areaNameStringcarriage_rule.area_name配送区域名称,多个以","逗号分开
firstIntegercarriage_rule.first首件(个)
firstCostIntegercarriage_rule.first_cost首件费用
proceedIntegercarriage_rule.proceed续件(个)
proceedCostIntegercarriage_rule.proceed_cost续件费用
示例
请求示例 (自动生成,仅结构参考)
POST /carriageRule/queryCarriageRuleList
{
  "body": {
    "carriageId": 1,
    "first": 0,
    "firstCost": 0,
    "proceed": 0,
    "proceedCost": 0,
    "idList": "",
    "keywords": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": 1,
      "carriageId": 1,
      "areaCode": "",
      "areaName": "",
      "first": 0,
      "firstCost": 0,
      "proceed": 0,
      "proceedCost": 0
    }
  ]
}
处理逻辑
逻辑摘要列表查询(carriageRuleService.queryList);入参与返回值经 BeanUtils 做对象/分页映射
POST /carriageRule/queryCarriageRulePage 在用管理后台 #
运费规则表-分页查询 · CarriageRuleController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageRuleController#queryCarriageRulePage
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriage_rule
ControllerCarriageRuleController#queryCarriageRulePage
转换BeanUtils.map → CarriageRuleQuery
ServiceCarriageRuleService#queryPage (CarriageRuleServiceImpl)
MapperCarriageRuleMapper#selectPage ⇒ 表 carriage_rule

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriageRule/queryCarriageRulePage
uathttps://dscp-uat.hn12301.net/manage-api/carriageRule/queryCarriageRulePage
prohttps://dscp-uat.hn12301.net/manage-api/carriageRule/queryCarriageRulePage (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body CarriageRulePageRequest
字段类型必填取值/校验表 / 列说明
pageNumInteger页码(继承自框架分页基类 AbstractPageRequest)
pageSizeInteger每页条数(继承自框架分页基类 AbstractPageRequest)
carriageIdLong可选(@MvcOptional)carriage_rule.carriage_id运费模板ID,关联运费模板表id
firstInteger可选(@MvcOptional)carriage_rule.first首件(个)
firstCostInteger可选(@MvcOptional)carriage_rule.first_cost首件费用
proceedInteger可选(@MvcOptional)carriage_rule.proceed续件(个)
proceedCostInteger可选(@MvcOptional)carriage_rule.proceed_cost续件费用
idListList<Long>可选(@MvcOptional)id列表
keywordsString可选(@MvcOptional)关键字
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构 PageInfo<CarriageRuleResponse> (page)
字段类型必填取值/校验表 / 列说明
list / recordsarray分页列表,元素结构见下
totallong总条数(PageInfo)
idLongcarriage_rule.id主键ID
carriageIdLongcarriage_rule.carriage_id运费模板ID,关联运费模板表id
areaCodeStringcarriage_rule.area_code配送区域编码,多个以","逗号分开
areaNameStringcarriage_rule.area_name配送区域名称,多个以","逗号分开
firstIntegercarriage_rule.first首件(个)
firstCostIntegercarriage_rule.first_cost首件费用
proceedIntegercarriage_rule.proceed续件(个)
proceedCostIntegercarriage_rule.proceed_cost续件费用
示例
请求示例 (自动生成,仅结构参考)
POST /carriageRule/queryCarriageRulePage
{
  "body": {
    "pageNum": 0,
    "pageSize": 0,
    "carriageId": 1,
    "first": 0,
    "firstCost": 0,
    "proceed": 0,
    "proceedCost": 0,
    "idList": "",
    "keywords": ""
  }
}
响应示例
{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "records": [
      {
        "id": 1,
        "carriageId": 1,
        "areaCode": "",
        "areaName": "",
        "first": 0,
        "firstCost": 0,
        "proceed": 0,
        "proceedCost": 0
      }
    ],
    "total": 0
  }
}
处理逻辑
逻辑摘要分页查询(carriageRuleService.queryPage);入参与返回值经 BeanUtils 做对象/分页映射
POST /carriageRule/updateCarriageRule 在用管理后台 #
运费规则表-更新 · CarriageRuleController
基本信息
控制器com.jxxx.dscp.api.controller.carriage.CarriageRuleController#updateCarriageRule
所属模块物流/运费 carriage
暴露渠道管理后台 (@Route 注解;决定 URL 前缀与可访问端)
请求方法POST
调用链路 & 涉及数据表
涉及数据表carriage_rule
ControllerCarriageRuleController#updateCarriageRule
转换BeanUtils.map → CarriageRule ⇒ 表 carriage_rule
ServiceCarriageRuleService#update (CarriageRuleServiceImpl)
MapperCarriageRuleMapper#updateById ⇒ 表 carriage_rule

链路按 Controller → Service(Impl) → Mapper → 表 逐层追踪;字段对应的「表.列」见下方请求/响应表新增列,按字段同名映射到涉及的实体表列; 表示该字段为查询条件 / 计算 / 转换 / 包装字段,未直接对应单一列。

环境 URL
环境完整 URL(主机 + 渠道前缀 + 路径)备注
devhttps://dscp-dev.hn12301.net/manage-api/carriageRule/updateCarriageRule
uathttps://dscp-uat.hn12301.net/manage-api/carriageRule/updateCarriageRule
prohttps://dscp-uat.hn12301.net/manage-api/carriageRule/updateCarriageRule (仓库 .env.pro 指向 uat;生产域名未确认,此处沿用 uat 主机示意)
请求参数 · Header / Query / Path

无(该接口无 Query/Path/Header 显式参数;入参见 Body)

请求参数 · Body CarriageRuleUpdateRequest
字段类型必填取值/校验表 / 列说明
idLong必填carriage_rule.id主键ID
carriageIdLong必填carriage_rule.carriage_id运费模板ID,关联运费模板表id
areaCodeStringcarriage_rule.area_code配送区域编码,多个以","逗号分开
areaNameStringcarriage_rule.area_name配送区域名称,多个以","逗号分开
firstIntegercarriage_rule.first首件(个)
firstCostIntegercarriage_rule.first_cost首件费用
proceedIntegercarriage_rule.proceed续件(个)
proceedCostIntegercarriage_rule.proceed_cost续件费用
响应参数
外层包装(chaos 框架自动;前端同时兼容 code/msg)
errcodeint业务码,0=成功
errmsgstring提示信息
dataT下方“data 结构”
data 结构

void —— 无返回数据

示例
请求示例 (自动生成,仅结构参考)
POST /carriageRule/updateCarriageRule
{
  "body": {
    "id": 1,
    "carriageId": 1,
    "areaCode": "",
    "areaName": "",
    "first": 0,
    "firstCost": 0,
    "proceed": 0,
    "proceedCost": 0
  }
}
响应示例
(void,无响应体)
处理逻辑
操作日志carriage / 更新运费规则
逻辑摘要更新(carriageRuleService.update);入参与返回值经 BeanUtils 做对象/分页映射