快货运Open Api

# 新增货源单

前置说明：调用新增货源单接口前，当前企业需已维护企业客户资料；接口会按当前登录企业自动补齐托运方信息。

接口名称：/shipping/bill/add

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
1 1 publishType 货源发布类型 Integer 1 是 0-单车货源，1-批量货源
2 1 releaseMethod 发布方式 Integer 1 是 0-平台级货源大厅，1-企业级货源大厅， 2-扫码接单
3 1 transportBusinessType 业务类型 Integer 10 是 干线普货 1002996，城市配送 1003997，农村配送 1003998，集装箱运输 1002998，其他 1003999
4 1 projectName 项目名称 String 40 否
5 1 routeName 线路名称 String 40 否 不传时按发货城市-收货城市自动生成
6 1 shipperTransportBillNumber 客户单号 String 40 否
7 1 senderInfo 发货方信息 Object 是
8 2 name 发货方名称 String 32 是
9 2 phone 发货方电话 String 16 是
10 2 provinceCode 发货省编码 String 10 是 省、直辖市行政区划码，系统会按编码自动补齐名称
11 2 cityCode 发货市编码 String 10 是 市、区县行政区划码，系统会按编码自动补齐名称
12 2 districtCode 发货区编码 String 10 否 无区县可不传，系统会按编码自动补齐名称
13 2 detailAddress 发货详细地址 String 64 是
14 2 lng 发货经度 BigDecimal 10,6 否
15 2 lat 发货纬度 BigDecimal 10,6 否
16 1 receiverInfo 收货方信息 Object 是
17 2 name 收货方名称 String 32 是
18 2 phone 收货方电话 String 16 是
19 2 provinceCode 收货省编码 String 10 是 省、直辖市行政区划码，系统会按编码自动补齐名称
20 2 cityCode 收货市编码 String 10 是 市、区县行政区划码，系统会按编码自动补齐名称
21 2 districtCode 收货区编码 String 10 否 无区县可不传，系统会按编码自动补齐名称
22 2 detailAddress 收货详细地址 String 64 是
23 2 lng 收货经度 BigDecimal 10,6 否
24 2 lat 收货纬度 BigDecimal 10,6 否
25 1 goodsInfo 货物信息 Object 是 当前按单个货物对象接收
26 2 goodsName 货物名称 String 50 是
27 2 goodsType 货物类型 String 20 是 支持枚举值：0100-煤炭及制品、0200-石油、天然气及制品、0300-金属矿石、0400-钢铁、0500-矿建材料、0600-水泥、0700-木材、0800-非金属矿石、0900-化肥及农药、1000-盐、1100-粮食、1200-机械、设备、电器、1300-轻工原料及制品、1400-有色金属、1500-轻工医药产品、1601-鲜活农产品、1602-冷藏冷冻货物、1701-商品汽车、1702-快递、1700-其他
28 2 weight 货物重量 Long 20 是 单位：克
29 2 volume 货物体积 Long 20 否
30 2 number 货物件数 Long 20 否
31 1 singleCarLimit 单车限制 Object 是
32 2 weight 单车限重 Long 20 是 单位：克
33 2 volume 单车限体积 Long 20 否 单位：立方分米
34 2 number 单车限件数 Long 20 否 单位：件
35 1 payeeInfo 收款人信息 Object 否 若同时传入 bankAccountName 和 bankCardNumber，系统会优先反查并关联已有收款账户
36 2 driverLinkedPayee 是否司机关联收款人 Boolean 1 否 默认为否.若为是，不需要传入收款人信息
37 2 bankAccountName 银行开户名 String 20 否
38 2 bankCardNumber 银行卡号 String 50 否
39 2 bankDeposit 开户银行 String 64 否
40 2 payeeIdCard 收款人证件号 String 20 否
41 1 pricePlanInfo 计价规则 Object 是
42 2 pricePlanType 计费类型 Integer 1 是 0-按单价，1-按整车
43 2 priceUnitType 计价单位 Integer 1 条件必填 1-吨，2-方，3-件；按单价计费时必填
44 2 transportPrice 运输单价 Long 20 条件必填 选择按单价计费必填，按计价单位赋值
45 2 totalTransportPrice 运输总价 Long 20 条件必填 选择按整车计费必填
46 2 settlementMethod 计价维度 Integer 1 是 0-装货数量，1-卸货数量，2-装卸货数量最小值
47 2 lossRule 亏损规则 Integer 1 否 0-不扣除亏损，1-扣除亏损
48 2 allowLossNumber 允许亏损数量 Long 20 否
49 2 allowLossNumberUnit 允许亏损数量单位 Integer 1 否 0-绝对值，1-千分比
50 2 lossPrice 亏损扣款单价 Long 20 否 按计价单位赋值
51 2 otherFine 其他扣罚 Long 20 否 单位：元
52 2 smallChangeRule 抹零规则 Integer 1 否 0-角分抹零，1-10 元以下抹零，2-不抹零
53 2 otherAward 其他奖励 Long 20 否 单位：元

请求参数示例

{
  "publishType": 0,
  "releaseMethod": 1,
  "transportBusinessType": 20,
  "projectName": "煤炭运输项目",
  "routeName": "榆林-西安",
  "shipperTransportBillNumber": "KHYHY202604140001",
  "senderInfo": {
    "name": "榆林发货仓",
    "phone": "13800000001",
    "provinceCode": "610000",
    "cityCode": "610800",
    "districtCode": "610802",
    "detailAddress": "高新区能源路 1 号",
    "lng": 109.741,
    "lat": 38.2909
  },
  "receiverInfo": {
    "name": "西安收货仓",
    "phone": "13800000002",
    "provinceCode": "610000",
    "cityCode": "610100",
    "districtCode": "610113",
    "detailAddress": "科技路 88 号",
    "lng": 108.9465,
    "lat": 34.2595
  },
  "goodsInfo": {
    "goodsName": "煤炭",
    "goodsType": "1001001",
    "weight": 32000,
    "volume": 0,
    "number": 1
  },
  "singleCarLimit": {
    "weight": 32000,
    "volume": 0,
    "number": 1
  },
  "payeeInfo": {
    "driverLinkedPayee": false,
    "bankAccountName": "张三",
    "bankCardNumber": "6222020202020202020",
    "bankDeposit": "中国工商银行",
    "payeeIdCard": "610101199001011234"
  },
  "pricePlanInfo": {
    "pricePlanType": 0,
    "priceUnitType": 1,
    "transportPrice": 18000,
    "settlementMethod": 0,
    "lossRule": 1,
    "allowLossNumber": 50,
    "allowLossNumberUnit": 0,
    "lossPrice": 18000,
    "otherFine": 20,
    "smallChangeRule": 2,
    "otherAward": 10
  }
}

返回参数

序号 层级 类型 名称 说明
1 1 String code 结果码，成功为 00000
2 1 String message 返回文本
3 1 String data 新增成功后的货源单号

mock 数据示例

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

# 编辑货源单

前置说明：编辑货源单，需要确保货源单已存在

接口名称：/shipping/bill/update

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
2 1 releaseMethod 发布方式 Integer 1 是 0-平台级货源大厅，1-企业级货源大厅， 2-扫码接单
3 1 transportBusinessType 业务类型 Integer 10 是 干线普货 1002996，城市配送 1003997，农村配送 1003998，集装箱运输 1002998，其他 1003999
4 1 projectName 项目名称 String 40 否
5 1 routeName 线路名称 String 40 否 不传时按发货城市-收货城市自动生成
6 1 shipperTransportBillNumber 客户单号 String 40 否
7 1 senderInfo 发货方信息 Object 是
8 2 name 发货方名称 String 32 是
9 2 phone 发货方电话 String 16 是
10 2 provinceCode 发货省编码 String 10 是 省、直辖市行政区划码，系统会按编码自动补齐名称
11 2 cityCode 发货市编码 String 10 是 市、区县行政区划码，系统会按编码自动补齐名称
12 2 districtCode 发货区编码 String 10 否 无区县可不传，系统会按编码自动补齐名称
13 2 detailAddress 发货详细地址 String 64 是
14 2 lng 发货经度 BigDecimal 10,6 否
15 2 lat 发货纬度 BigDecimal 10,6 否
16 1 receiverInfo 收货方信息 Object 是
17 2 name 收货方名称 String 32 是
18 2 phone 收货方电话 String 16 是
19 2 provinceCode 收货省编码 String 10 是 省、直辖市行政区划码，系统会按编码自动补齐名称
20 2 cityCode 收货市编码 String 10 是 市、区县行政区划码，系统会按编码自动补齐名称
21 2 districtCode 收货区编码 String 10 否 无区县可不传，系统会按编码自动补齐名称
22 2 detailAddress 收货详细地址 String 64 是
23 2 lng 收货经度 BigDecimal 10,6 否
24 2 lat 收货纬度 BigDecimal 10,6 否
25 1 goodsInfo 货物信息 Object 是 当前按单个货物对象接收
26 2 goodsName 货物名称 String 50 是
27 2 goodsType 货物类型 String 20 是 支持枚举值：0100-煤炭及制品、0200-石油、天然气及制品、0300-金属矿石、0400-钢铁、0500-矿建材料、0600-水泥、0700-木材、0800-非金属矿石、0900-化肥及农药、1000-盐、1100-粮食、1200-机械、设备、电器、1300-轻工原料及制品、1400-有色金属、1500-轻工医药产品、1601-鲜活农产品、1602-冷藏冷冻货物、1701-商品汽车、1702-快递、1700-其他
28 2 weight 货物重量 Long 20 是 单位：克
29 2 volume 货物体积 Long 20 否
30 2 number 货物件数 Long 20 否
31 1 singleCarLimit 单车限制 Object 是
32 2 weight 单车限重 Long 20 是 单位：克
33 2 volume 单车限体积 Long 20 否 单位：立方分米
34 2 number 单车限件数 Long 20 否 单位：件
35 1 payeeInfo 收款人信息 Object 否 若同时传入 bankAccountName 和 bankCardNumber，系统会优先反查并关联已有收款账户
36 2 driverLinkedPayee 是否司机关联收款人 Boolean 1 否 默认为否.若为是，不需要传入收款人信息
37 2 bankAccountName 银行开户名 String 20 否
38 2 bankCardNumber 银行卡号 String 50 否
39 2 bankDeposit 开户银行 String 64 否
40 2 payeeIdCard 收款人证件号 String 20 否
41 1 pricePlanInfo 计价规则 Object 是
42 2 pricePlanType 计费类型 Integer 1 是 0-按单价，1-按整车
43 2 priceUnitType 计价单位 Integer 1 条件必填 1-吨，2-方，3-件；按单价计费时必填
44 2 transportPrice 运输单价 Long 20 条件必填 选择按单价计费必填，按计价单位赋值
45 2 totalTransportPrice 运输总价 Long 20 条件必填 选择按整车计费必填
46 2 settlementMethod 计价维度 Integer 1 是 0-装货数量，1-卸货数量，2-装卸货数量最小值
47 2 lossRule 亏损规则 Integer 1 否 0-不扣除亏损，1-扣除亏损
48 2 allowLossNumber 允许亏损数量 Long 20 否
49 2 allowLossNumberUnit 允许亏损数量单位 Integer 1 否 0-绝对值，1-千分比
50 2 lossPrice 亏损扣款单价 Long 20 否 按计价单位赋值
51 2 otherFine 其他扣罚 Long 20 否 单位：元
52 2 smallChangeRule 抹零规则 Integer 1 否 0-角分抹零，1-10 元以下抹零，2-不抹零
53 2 otherAward 其他奖励 Long 20 否 单位：元
54 1 shippingBillNumber 货源单号 String 32 是

请求参数示例

{
  "publishType": 0,
  "releaseMethod": 1,
  "transportBusinessType": 20,
  "projectName": "煤炭运输项目",
  "routeName": "榆林-西安",
  "shipperTransportBillNumber": "KHYHY202604140001",
  "shippingBillNumber": "HY236060930041000002",
  "senderInfo": {
    "name": "榆林发货仓",
    "phone": "13800000001",
    "provinceCode": "610000",
    "cityCode": "610800",
    "districtCode": "610802",
    "detailAddress": "高新区能源路 1 号",
    "lng": 109.741,
    "lat": 38.2909
  },
  "receiverInfo": {
    "name": "西安收货仓",
    "phone": "13800000002",
    "provinceCode": "610000",
    "cityCode": "610100",
    "districtCode": "610113",
    "detailAddress": "科技路 88 号",
    "lng": 108.9465,
    "lat": 34.2595
  },
  "goodsInfo": {
    "goodsName": "煤炭",
    "goodsType": "1001001",
    "weight": 32000,
    "volume": 0,
    "number": 1
  },
  "singleCarLimit": {
    "weight": 32000,
    "volume": 0,
    "number": 1
  },
  "payeeInfo": {
    "driverLinkedPayee": false,
    "bankAccountName": "张三",
    "bankCardNumber": "6222020202020202020",
    "bankDeposit": "中国工商银行",
    "payeeIdCard": "610101199001011234"
  },
  "pricePlanInfo": {
    "pricePlanType": 0,
    "priceUnitType": 1,
    "transportPrice": 18000,
    "settlementMethod": 0,
    "lossRule": 1,
    "allowLossNumber": 50,
    "allowLossNumberUnit": 0,
    "lossPrice": 18000,
    "otherFine": 20,
    "smallChangeRule": 2,
    "otherAward": 10
  }
}

返回参数

序号 层级 类型 名称 说明
1 1 String code 结果码，成功为 00000
2 1 String message 返回文本
3 1 Boolean data 是否成功

mock 数据示例

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

# 关闭货源单

接口名称：/shipping/bill/close

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
1 1 shippingBillNumber 货源单号 String 32 否

请求参数示例

{
  "shippingBillNumber": "HY202604140001",
}

返回参数

序号 层级 类型 名称 说明
1 1 String code 结果码，成功为 00000
2 1 String message 返回文本
3 1 Boolean data 是否成功

mock 数据示例

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

# 查询货源单

接口名称：/shipping/bill/search

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
1 1 shippingBillNumber 货源单号 String 32 否
2 1 startPublishTime 发布开始时间 Long 20 否 时间戳，毫秒
3 1 endPublishTime 发布结束时间 Long 20 否 时间戳，毫秒
4 1 pageNum 页码 Integer 20 是

请求参数示例

{
  "shippingBillNumber": "HY202604140001",
  "startPublishTime": 1713024000000,
  "endPublishTime": 1713110399000,
  "pageNum": 1
}

返回参数

序号 层级 英文名称 中文名称 类型 说明
1 1 code 结果码 String 成功为 00000
2 1 message 返回文本 String
3 1 data 分页结果 PageInfo
4 2 records 货源单列表 [ShippingBillDTO]
5 2 total 总条数 Long
6 2 pageSize 每页条数 Integer
7 2 pageNum 当前页码 Integer
8 3 id 货源单 ID Long
9 3 shippingBillNumber 货源单号 String
10 3 status 货源单状态 Integer 0-待接单，1-部分接单，2-已接单，3-已关闭
11 3 publishType 货源发布类型 Integer 0-单车货源，1-批量货源
12 3 releaseMethod 发布方式 Integer 0-平台级货源大厅，1-企业级货源大厅， 2-扫码接单
13 3 transportBusinessType 业务类型 Integer 干线普货 1002996，城市配送 1003997，农村配送 1003998，集装箱运输 1002998，其他 1003999
14 3 projectName 项目名称 String
15 3 routeName 线路名称 String
16 3 shipperTransportBillNumber 客户单号 String
17 3 publishTime 发布时间 Long 时间戳，毫秒
18 3 weightLimit 单车限重 Long
19 3 volumeLimit 单车限体积 Long
20 3 numberLimit 单车限件数 Long
21 3 goodsDTO 货物信息 Object
22 4 goodsName 货物名称 String
23 4 goodsType 货物类型 String
24 4 weight 货物重量 Long
25 4 volume 货物体积 Long
26 4 number 货物件数 Long
27 3 addressInfoDTO 收发货信息 Object
28 4 senderName 发货方名称 String
29 4 senderPhone 发货方电话 String
30 4 senderProvince 发货省编码 String
31 4 senderProvinceName 发货省名称 String
32 4 senderCity 发货市编码 String
33 4 senderCityName 发货市名称 String
34 4 senderDistrict 发货区编码 String
35 4 senderDistrictName 发货区名称 String
36 4 senderLocation 发货详细地址 String
37 4 senderLng 发货经度 BigDecimal
38 4 senderLat 发货纬度 BigDecimal
39 4 receiverName 收货方名称 String
40 4 receiverPhone 收货方电话 String
41 4 receiverProvince 收货省编码 String
42 4 receiverProvinceName 收货省名称 String
43 4 receiverCity 收货市编码 String
44 4 receiverCityName 收货市名称 String
45 4 receiverDistrict 收货区编码 String
46 4 receiverDistrictName 收货区名称 String
47 4 receiverLocation 收货详细地址 String
48 4 receiverLng 收货经度 BigDecimal
49 4 receiverLat 收货纬度 BigDecimal
50 3 carrierInfoDTO 收款信息 Object
51 4 payeeId 收款人 ID Long
52 4 driverLinkedPayee 是否司机关联收款人 Boolean
53 4 bankAccountName 银行开户名 String
54 4 bankCardNumber 银行卡号 String
55 4 bankDeposit 开户银行 String
56 4 payeeIdCard 收款人证件号 String
57 3 pricePlanDTO 计价规则 Object
58 4 pricePlanType 计费类型 Integer 0-按单价，1-按整车
59 4 priceUnitType 计价单位 Integer 1-吨，2-方，3-件
60 4 transportPrice 运输单价 Long
61 4 totalTransportPrice 运输总价 Long
62 4 settlementMethod 计价维度 Integer 0-装货数量，1-卸货数量，2-装卸货数量最小值
63 4 lossRule 亏损规则 Integer 0-不扣除亏损，1-扣除亏损
64 4 allowLossNumber 允许亏损数量 Long
65 4 allowLossNumberUnit 允许亏损数量单位 Integer 0-绝对值，1-千分比
66 4 lossPrice 亏损扣款单价 Long
67 4 otherFine 其他扣罚 Long
68 4 smallChangeRule 抹零规则 Integer 0-角分抹零，1-10 元以下抹零，2-不抹零
69 4 otherAward 其他奖励 Long
70 3 shippingBillShipperInfoDTO 托运方信息 Object 当前由系统按登录企业自动补齐
71 4 shipperId 托运方 ID Long
72 4 shipperName 托运方名称 String
73 4 shipperPhone 托运方电话 String
74 4 payType 托运方支付方式 Integer 0-现付，1-到付，2-月结，3-季度结，4-到付月结
75 4 shipperIdCard 托运方证件号 String

mock 数据示例

{
  "code": "00000",
  "message": "请求成功",
  "data": {
    "records": [
      {
        "id": 123456789,
        "shippingBillNumber": "HY202604140001",
        "status": 0,
        "publishType": 0,
        "releaseMethod": 1,
        "transportBusinessType": 20,
        "projectName": "煤炭运输项目",
        "routeName": "榆林-西安",
        "shipperTransportBillNumber": "KHYHY202604140001",
        "publishTime": 1713088800000,
        "weightLimit": 32000,
        "volumeLimit": 0,
        "numberLimit": 1,
        "goodsDTO": {
          "goodsName": "煤炭",
          "goodsType": "1001001",
          "weight": 32000,
          "volume": 0,
          "number": 1
        },
        "addressInfoDTO": {
          "senderName": "榆林发货仓",
          "senderPhone": "13800000001",
          "senderProvince": "610000",
          "senderProvinceName": "陕西省",
          "senderCity": "610800",
          "senderCityName": "榆林市",
          "senderDistrict": "610802",
          "senderDistrictName": "榆阳区",
          "senderLocation": "高新区能源路 1 号",
          "senderLng": 109.741,
          "senderLat": 38.2909,
          "receiverName": "西安收货仓",
          "receiverPhone": "13800000002",
          "receiverProvince": "610000",
          "receiverProvinceName": "陕西省",
          "receiverCity": "610100",
          "receiverCityName": "西安市",
          "receiverDistrict": "610113",
          "receiverDistrictName": "雁塔区",
          "receiverLocation": "科技路 88 号",
          "receiverLng": 108.9465,
          "receiverLat": 34.2595
        },
        "carrierInfoDTO": {
          "payeeId": 9527,
          "driverLinkedPayee": false,
          "bankAccountName": "张三",
          "bankCardNumber": "6222020202020202020",
          "bankDeposit": "中国工商银行",
          "payeeIdCard": "610101199001011234"
        },
        "pricePlanDTO": {
          "pricePlanType": 0,
          "priceUnitType": 1,
          "transportPrice": 18000,
          "settlementMethod": 0,
          "lossRule": 1,
          "allowLossNumber": 50,
          "allowLossNumberUnit": 0,
          "lossPrice": 18000,
          "otherFine": 20,
          "smallChangeRule": 2,
          "otherAward": 10
        },
        "shippingBillShipperInfoDTO": {
          "shipperId": 10001,
          "shipperName": "陕西快货运有限公司",
          "shipperPhone": "02912345678",
          "payType": 0,
          "shipperIdCard": "91610100MA0000000X"
        }
      }
    ],
    "total": 1,
    "pageSize": 20,
    "pageNum": 1
  }
}

← 运单 →