接口名称

获取系统代码字典(根据代码查询公共代码)

接口地址

/api/shipper/v1/base/sysCode/getPublicCodeMapByCodes

请求方式

POST

请求头

参数

类型

必填

说明

sessionId

String

登录会话ID

language

String

语言

Content-Type

String

application/json;charset=UTF-8

语言取值:

说明

zh_CN

中文

zh

中文(简写)

en_US

英文

请求参数

参数

类型

必填

说明

(body)

Array

系统代码数组,直接传数组,不是对象

常用系统代码

代码

说明

返回字段名示例

BOT001

电池包装类型

batteryPackingOptions

BPT001

电池类型

batteryTypeOptions

WUT001

重量单位

weightUnitOptions

请求示例

curl 'https://tracking-qa.etowertech.com/api/shipper/v1/base/sysCode/getPublicCodeMapByCodes' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'language: zh_CN' \
  -H 'sessionId: 7_MjodvX6q31RhlGMt2RkQ' \
  -d '["BOT001","BPT001","WUT001"]'

返回示例(真实数据)

{
  "success": true,
  "code": "0",
  "data": {
    "WUT001": [
      {
        "code": "WUT001",
        "sort": "0",
        "cnName": "g",
        "englishName": "g",
        "value": "1",
        "intValue": 1,
        "showFlag": 1,
        "codeType": 1
      },
      {
        "code": "WUT001",
        "sort": "0",
        "cnName": "kg",
        "englishName": "kg",
        "value": "2",
        "intValue": 2,
        "showFlag": 1,
        "codeType": 1
      },
      {
        "code": "WUT001",
        "sort": "0",
        "cnName": "lb",
        "englishName": "lb",
        "value": "3",
        "intValue": 3,
        "showFlag": 1,
        "codeType": 1
      }
    ],
    "BPT001": [
      {
        "code": "BPT001",
        "sort": "0",
        "cnName": "无电池",
        "englishName": "No Battery",
        "value": "0",
        "intValue": 0,
        "showFlag": 1,
        "codeType": 1
      },
      {
        "code": "BPT001",
        "sort": "0",
        "cnName": "Lithium Ion Polymer",
        "englishName": "Lithium Ion Polymer",
        "value": "4",
        "intValue": 4,
        "showFlag": 1,
        "codeType": 1
      },
      {
        "code": "BPT001",
        "sort": "0",
        "cnName": "Lithium Ion Alloy",
        "englishName": "Lithium Ion Alloy",
        "value": "5",
        "intValue": 5,
        "showFlag": 1,
        "codeType": 1
      }
    ],
    "BOT001": [
      {
        "code": "BOT001",
        "sort": "0",
        "cnName": "无电池",
        "englishName": "No Battery",
        "value": "0",
        "intValue": 0,
        "showFlag": 1,
        "codeType": 1
      },
      {
        "code": "BOT001",
        "sort": "0",
        "cnName": "电池在商品内",
        "englishName": "Inside Equipment",
        "value": "1",
        "intValue": 1,
        "showFlag": 1,
        "codeType": 1
      },
      {
        "code": "BOT001",
        "sort": "0",
        "cnName": "电池在商品外",
        "englishName": "Packaged with Equipment",
        "value": "2",
        "intValue": 2,
        "showFlag": 1,
        "codeType": 1
      },
      {
        "code": "BOT001",
        "sort": "0",
        "cnName": "只有电池",
        "englishName": "Battery Only",
        "value": "3",
        "intValue": 3,
        "showFlag": 1,
        "codeType": 1
      },
      {
        "code": "BOT001",
        "sort": "0",
        "cnName": "其他",
        "englishName": "Other",
        "value": "6",
        "intValue": 6,
        "showFlag": 1,
        "codeType": 1
      }
    ]
  },
  "errors": []
}

返回字段说明

字段

类型

说明

success

Boolean

请求是否成功

code

String

响应状态码,"0"表示成功

data

Object

返回数据对象,key 为系统代码,value 为对应的选项数组

errors

Array

错误信息列表

data 选项字段说明(真实数据结构)

字段

类型

说明

code

String

系统代码(与 key 相同)

sort

String

排序字段

cnName

String

中文名称

englishName

String

英文名称

value

String

选项值(字符串类型)

intValue

Number

选项值(整数类型)

showFlag

Number

显示标志:1-显示, 0-隐藏

codeType

Number

代码类型

前端调用方式

1. Vue 原型方法调用

在 `src/utils/base.js` 中定义了 `Vue.prototype.$getSysCode` 方法:

// OrdersDetail.vue 中的使用示例
async getSysCodeOptions() {
  // 传入逗号分隔的代码字符串
  const data = await this.$getSysCode('BOT001,BPT001,WUT001')

  // 返回数组,按传入顺序对应
  this.batteryPackingOptions = data[0]  // BOT001 - 电池包装
  this.batteryTypeOptions = data[1]     // BPT001 - 电池类型
  this.weightUnitOptions = data[2]      // WUT001 - 重量单位(转大写)

  // 重量单位特殊处理:转为大写显示
  this.weightUnitOptions = data[2].map(item => {
    return { ...item, name: item.name.toUpperCase() }
  })
}

电池包装类型 (BOT001) 详细说明(真实数据)

value

intValue

中文名称

英文名称

"0"

0

无电池

No Battery

"1"

1

电池在商品内

Inside Equipment

"2"

2

电池在商品外

Packaged with Equipment

"3"

3

只有电池

Battery Only

"6"

6

其他

Other


电池类型 (BPT001) 详细说明(真实数据)

value

intValue

中文名称

英文名称

"0"

0

无电池

No Battery

"4"

4

Lithium Ion Polymer

Lithium Ion Polymer

"5"

5

Lithium Ion Alloy

Lithium Ion Alloy

注意:真实数据中只有这 3 个选项,与之前文档中的枚举值不同。

重量单位 (WUT001) 详细说明(真实数据)

value

intValue

中文名称

英文名称

前端显示

"1"

1

g

g

G

"2"

2

kg

kg

KG

"3"

3

lb

lb

LB

注意:前端会将英文名称转为大写显示(g→G, kg→KG, lb→LB)。

接口特点

1. *请求参数格式*:直接传数组 `"BOT001","BPT001","WUT001"`,不是对象
2. *返回数据顺序*:返回对象的 key 顺序可能与请求顺序不同
3. *value 字段类型*:`value` 是字符串类型,`intValue` 是整数类型