客户 | 快货运Open Api

# 新增客户信息

接口名称：/customer/create 请求参数：

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	type	客户类型：1-托运方	Byte	2	是	只允许传入 1
2	1	name	企业名称	String	64	是	2-64 个字符，允许汉字，字母，数字，全角括号
3	1	legalName	法人姓名	String	20	否	2-20 个字符，只允许汉字+少数民族符号 ·
4	1	phone	联系电话	String	20	是	传入字段需满足座机或手机号校验算法
5	1	idCard	身份证号(企业客户时为法人身份证号)	String	18	否	18 位数字（末尾允许输入 X），符合身份证号校验算法
6	1	creditCode	统一社会信用代码	String	18	是	传入字段需满足统一社会信用代码校验算法
7	1	idCardFrontFilename	身份证正面 filename	String	255	否	文件名
8	1	idCardBackFilename	身份证反面 filename	String	255	否
9	1	businessLicenseFilename	营业执照 filename	String	255	否
10	1	province	省行政区划码	String	10	是	需存在于代码集，注意：直辖市划码需要补全省、市、区，按照前两位为省，第三、四位为市，第五、六位为区的格式补缺少的划码，例如：北京市（110000）北京市（110100）东城区（110101）；
11	1	city	市行政区划码	String	10	是
12	1	district	区县行政区划码	String	10	是
13	1	provinceName	省行政区划名称	String	64	是	需存在于代码集
14	1	cityName	市行政区划名称	String	64	是
15	1	districtName	区县行政区划名称	String	64	是
16	1	location	详细地址	String	255	是	2-256 个字符，允许数字，字母，汉字，全角括号，少数民族符号 ·
17	1	remark	备注	String	512	否	最多 500 个字符，允许数字，字母，汉字，全角括号，少数民族符号 ·
18	1	serviceCostRate	服务费率	Integer	5	否	1 表示 0.01%，10 表示 0.1%，100 表示 1% 1000 表示 10%，10000 表示 100%
19	1	invoicePhone	联系电话(开票用)	String	20	是
20	1	bankDeposit	开户银行	String	64	是
21	1	bankCardNumber	银行账号	String	64	是

返回参数

true

mock 数据示例

{
  "code": "00000",
  "data": true,
  "message": "请求成功"
}

# 修改客户信息

接口名称：/customer/update

请求参数

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	type	客户类型：1-托运方	Byte	2	是	只允许传入 1
2	1	name	企业名称（企业客户）/姓名（个人客户）	String	64	是	2-64 个字符，允许汉字，字母，数字，全角括号
3	1	legalName	法人姓名	String	20	否	2-20 个字符，只允许汉字+少数民族符号 ·
4	1	phone	联系电话	String	20	是	传入字段需满足座机或手机号校验算法
5	1	idCard	法人身份证号	String	18	否	18 位数字（末尾允许输入 X），符合身份证号校验算法
6	1	creditCode	统一社会信用代码	String	18	是	传入字段需满足统一社会信用代码校验算法
7	1	idCardFrontFilename	身份证正面 filename	String	255	否	文件名
8	1	idCardBackFilename	身份证反面 filename	String	255	否
9	1	businessLicenseFilename	营业执照 filename	String	255	否
10	1	province	省行政区划码	String	10	是	需存在于代码集，注意：直辖市划码需要补全省、市、区，按照前两位为省，第三、四位为市，第五、六位为区的格式补缺少的划码，例如：北京市（110000）北京市（110100）东城区（110101）；
11	1	city	市行政区划码	String	10	是
12	1	district	区县行政区划码	String	10	是
13	1	provinceName	省行政区划名称	String	64	是	需存在于代码集
14	1	cityName	市行政区划名称	String	64	是
15	1	districtName	区县行政区划名称	String	64	是
16	1	location	详细地址	String	255	是	2-256 个字符，允许数字，字母，汉字，全角括号，少数民族符号 ·
17	1	remark	备注	String	512	否	最多 500 个字符，允许数字，字母，汉字，全角括号，少数民族符号 ·
18	1	serviceCostRate	服务费率	Integer	5	否	1 表示 0.01%，10 表示 0.1%，100 表示 1% 1000 表示 10%，10000 表示 100%
19	1	invoicePhone	联系电话(开票用)	String	20	是
20	1	bankDeposit	开户银行	String	64	是
21	1	bankCardNumber	银行账号	String	64	是

返回参数

true

mock 数据示例

{
  "code": "00000",
  "data": true,
  "message": "请求成功"
}

# 查询客户信息

接口名称：/customer/search

请求参数

序号	层级	类型	名称	备注	必填
1	1	Byte	type	客户类型：1-托运方	是
2	1	array[String]	nameList	企业名称/客户名称集合	否
3	1	array[String]	creditCodeList	统一社会信用代码集合	否

返回参数

序号	层级	类型	名称	备注	必填
1	1	Byte	type	客户类型：1-托运方	是
2	1	String	name	企业名称（企业客户）/姓名（个人客户）	是
3	1	String	legalName	法人姓名	否
4	1	String	phone	联系电话	是
5	1	String	idCard	身份证号(企业客户时为法人身份证号)	否
6	1	String	creditCode	统一社会信用代码	是
7	1	String	idCardFrontFilename	身份证正面 filename	否
8	1	String	idCardBackFilename	身份证反面 filename	否
9	1	String	businessLicenseFilename	营业执照 filename	否
10	1	String	province	省行政区划码	是
11	1	String	city	市行政区划码	是
12	1	String	district	区县行政区划码	是
13	1	String	provinceName	省行政区划名称	是
14	1	String	cityName	市行政区划名称	是
15	1	String	districtName	区县行政区划名称	是
16	1	String	location	详细地址	是
17	1	String	remark	备注	否
18	1	String	contractFilename	合同附件名称	否
19	1	Long	validDate	合同终止日期	否
20	1	Integer	serviceCostRate	服务费率	否
21	1	String	invoicePhone	联系电话(开票用)	是
22	1	String	bankDeposit	开户银行	是
23	1	String	bankCardNumber	银行账号	是

mock 数据示例

{
  "code": "00000",
  "data": [
    {
      "type": 1,
      "name": "测试科技",
      "legalName": "张三",
      "phone": "123456",
      "idCard": "",
      "creditCode": "1221312333232222",
      "idCardFrontFilename": "",
      "idCardBackFilename": "",
      "businessLicenseFilename": "",
      "province": "310000",
      "city": "330100",
      "district": "30106",
      "provinceName": "浙江省",
      "cityName": "杭州市",
      "districtName": "西湖区",
      "location": "翠苑街道",
      "remark": "",
      "contractFilename": "",
      "validDate": 1622703110176
    }
  ],
  "message": "请求成功"
}

错误码

错误码	说明	建议解决方案
TOSB.00001	系统繁忙，请稍后再试	联系开发解决