导入项目已发货运单接口
接口说明
接口地址: /gys/gems-web-api/waybillApi/batchSaveWaybills
接口用途: 项目已发货运单数据导入
请求方式: POST
请求参数: JSON格式字符串
注意事项:
- 单次请求条数不超过10条，大于10条，请分批次推送
重点说明
一、接口需关联第三方订单，请提前使用“导入项目订单信息接口”导入订单
二、接口支持作废“已发货”的运单，作废之后三方可修改该运单，将运单状态由”已作废”重新变为”已发货”
三、“已验收“的运单不支持作废
HTTP请求方式
POST
请求参数
| 参数 | 类型 | 必须 | 取值范围 | 默认值 | 描述 |
|---|---|---|---|---|---|
| jsonStr | String | Y | json对象 详细格式见下 |
请求参数各项属性说明
运单主表属性
| 参数 | 类型 | 必须 | 取值范围（字符长度） | 默认值 | 描述 |
|---|---|---|---|---|---|
| syncCode | String | 是 | 255 | 项目同步编码 | |
| optFlag | Number | 是 | 2 | 操作。新增或修改：0，删除：2 | |
| unitId | String | 是 | 64 | 第三方运单Id | |
| waybillNum | String | 是 | 255 | 运单编号 | |
| carNum | String | 是 | 255 | 车牌号 | |
| orderUnitId | String | 是 | 255 | 三方订单id | |
| providerUnitId | String | 是 | 255 | 三方供应商id，与订单供应商一致 | |
| waybillSubmitTime | String | 是 | 20 | 发货时间，yyyy-MM-dd HH:mm:ss | |
| waybillMaterials | Array | 是 | 发货材料明细属性详见【发货材料明细属性】 | ||
| status | Number | 是 | 运单状态：1已发货 | ||
| address | String | 是 | 255 | 地址 | |
| remark | String | 否 | 255 | 备注 | |
| createTime | String | 否 | 20 | 当前时间 | 运单创建时间，yyyy-MM-dd HH:mm:ss |
| lastModifyTime | String | 否 | 20 | 当前时间 | 运单修改时间，yyyy-MM-dd HH:mm:ss |
| driverTelNum | String | 否 | 20 | 司机手机号 | |
| driverName | String | 否 | 20 | 司机名字 | |
| creatorName | String | 否 | 255 | 发货人名 | |
| creatorUnitId | String | 否 | 100 | 发货人三方id | |
| receiveType | Number | 否 | 2 | 收货方式：1地磅，2移动验收 | |
| src | String | 否 | 255 | 供应商系统标识。比如wl：物料供应商系统；gldlv：广联达履约系统；geps:Xx-01，xx：供应商系统的英文标识等等 | |
| extend | String | 否 | 扩展字段，json |
发货材料明细属性
| 参数 | 类型 | 必须 | 取值范围（字符长度） | 默认值 | 描述 |
|---|---|---|---|---|---|
| unitId | String | 是 | 64 | 第三方唯一细表id | |
| unitPid | String | 是 | 64 | 第三方主表运单id | |
| materialUnitId | String | 是 | 255 | 第三方材料Id，来自于订单材料，与订单材料Id一致 | |
| materialName | String | 是 | 255 | 材料名称 | |
| materialCode | String | 是 | 64 | 材料编码 | |
| wayBillQuantity | Number | 是 | 发货量 | ||
| specification | String | 否 | 255 | 规格+型号 | |
| unit | String | 否 | 255 | 材料计量单位 | |
| batchNumber | String | 否 | 255 | 批次号 | |
| extend | String | 否 | 扩展字段，json | ||
| positionName | String | 否 | 255 | 材料使用部位名称 | |
| positionUnitId | String | 否 | 255 | 材料使用部位三方Id | |
| additionalCharges | Array | 否 | 材料附加费。属性详见【运单材料附加费additionalCharges属性】 |
运单材料附加费additionalCharges属性
| 参数 | 类型 | 必须 | 取值范围（字符长度） | 默认值 | 描述 |
|---|---|---|---|---|---|
| additionalChargeName | String | 是 | 255 | 附加费名称 | |
| additionalChargeUnitId | String | 是 | 255 | 第三方附加费Id | |
| unitPid | String | 否 | 255 | 第三方运单材料行id | |
| code | String | 否 | 64 | 附加费编码 | |
| unit | String | 否 | 45 | 附加费单位 | |
| extend | String | 否 | 扩展字段 |
返回结果
| 参数 | 类型 | 必须 | 取值范围 | 默认值 | 描述 |
|---|---|---|---|---|---|
| success | Boolen | Y | 状态。true成功，false失败 | ||
| code | Number | Y | 200操作成功；500 操作失败 | ||
| errorCode | String | N | 失败错误码; 如 system_error （系统异常，此种情况建议重试） | ||
| errorMsg | String | N | 失败错误信息；如系统异常 | ||
| data | Object | Y | 同步结果说明 | ||
| data.successList | Array | Y | 处理成功的数据，属性详见【运单主表属性】 | ||
| data.errorList | Array | Y | 处理失败的数据，属性详见【运单主表属性】，额外属性：errMsg失败原因,errCode失败错误码，常见code码，biz_error 业务错误，必填字段缺失或不符合业务规则导致； | ||
| data.message | String | Y | 结果说明。如：成功:1条，失败:1条 |
常见异常信息
| 响应端异常提示 | 请求端处理意见 |
|---|---|
| 同步数据不能为空 | 调用接口前校验入参列表非空 |
| 最大支持上传数据为10条 | 分批调用接口，每批10条数据 |
| XXXX不允许为空 | 必填字段为空 |
| XXXX长度不允许大于XX | 字段超长 |
| XX状态非法 | 枚举字段值不在提供范围 |
| 运单的同步编码不存在 | 检查授权文件是否与当前项目一致；检查syncCode是否正确 |
| 运单的供应商不存在 | 供应商需要提前集成到系统中 |
| 运单的订单不存在 | 订单需要提前集成到系统中 |
| 运单的订单已作废，不允许新增修改 | 关联订单已标记作废，调用接口前校验 |
| 运单的供应商与订单供应商不一致 | 运单供应商与订单供应商不一致，调用接口前校验 |
| 运单已验收不允许修改 | 核实状态后重试，或取消该订单同步 |
| 未找到要删除的运单 | 取消该运单同步 |
| 运单材料三方id不存在 | 材料需要提前集成到系统中 |
| 运单材料与订单材料不一致 | 运单材料与订单材料不一致，调用接口前校验 |
| 运单数量不允许小于等于0 | 运单数量需要为正整数 |
| 同一运单同一材料批次编号不能相同 | 检查批次号是否重复 |
| 运单材料行三方id不允许重复 | 检查材料id是否重复 |
请求参数格式示例
[
{ //类型：Object 必有字段 备注：运单实体
"unitId":"2021031610190001", //类型：String 必有字段 备注：第三方运单Id
"waybillNum":"waybillNum223", //类型：String 必有字段 备注：运单编号
"carNum":"李A22345", //类型：String 必有字段 备注：车牌号
"orderUnitId":"2021031610190001", //类型：String 必有字段 备注：三方订单id
"providerUnitId":"dsf202105121", //类型：String 必有字段 备注：三方供应商id，与订单供应商一致
"waybillSubmitTime":"2021-07-27 10:01:30", //类型：String 必有字段 备注：发货时间，yyyy-MM-dd HH:mm:ss
"status":1, //类型：Number 必有字段 备注：运单状态：1已发货
"remark":"备注", //类型：String 可有字段 备注：备注
"createTime":"2021-04-26 10:01:30", //类型：String 可有字段 备注：运单创建时间，yyyy-MM-dd HH:mm:ss
"lastModifyTime":"2021-04-28 10:01:30", //类型：String 可有字段 备注：运单修改时间，yyyy-MM-dd HH:mm:ss
"address":"地址11", //类型：String 必有字段 备注：地址
"driverTelNum":"18812354567", //类型：String 可有字段 备注：司机手机号
"driverName":"张三", //类型：String 可有字段 备注：司机名字
"creatorName":"发货李四", //类型：String 可有字段 备注：发货人名
"creatorUnitId":"12321", //类型：String 可有字段 备注：发货人三方id
"receiveType":1, //类型：Number 可有字段 备注：收货方式：1地磅，2移动验收
"syncCode":"xrqhhgj", //类型：String 必有字段 备注：项目同步编码
"optFlag":0, //类型：Number 必有字段 备注：操作。新增或修改：0，删除：2
"extend":"{}", //类型：String 可有字段 备注：扩展字段，json
"waybillMaterials":[ //类型：Array 必有字段 备注：发货材料明细
{ //类型：Object 必有字段 备注：无
"unitId":"2021031610190002", //类型：String 必有字段 备注：第三方唯一细表id
"unitPid":"2021031610190001", //类型：String 必有字段 备注：第三方主表运单id
"materialUnitId":"141", //类型：String 必有字段 备注：第三方材料Id，来自于订单材料，与订单材料Id一致
"materialName":"圆钢(Q235)_集成测试131", //类型：String 必有字段 备注：材料名称
"materialCode":"000131", //类型：String 必有字段 备注：材料编码
"specification":"Φ10", //类型：String 可有字段 备注：规格+型号
"unit":"匹", //类型：String 可有字段 备注：材料计量单位
"batchNumber":"批次号1", //类型：String 可有字段 备注：批次号
"wayBillQuantity":14.312, //类型：Number 必有字段 备注：发货量
"extend":"{}", //类型：String 可有字段 备注：扩展字段，json
"positionName":"测试部位", //类型：String 可有字段 备注：材料使用部位名称
"positionUnitId":"20230420001", //类型：String 可有字段 备注：材料使用部位三方id
"additionalCharges":[
{
"unitPid":"2021031610190002", //类型：String 可有字段 备注：第三方运单材料行id
"additionalChargeName":"泵送", //类型：String 必有字段 备注：附加费名称
"additionalChargeUnitId"："20230330002", //类型：String 必有字段 备注：第三方附加费id
"code":"test", //类型：String 可有字段 备注：附加费编码
"unit":"米", //类型：String 可有字段 备注：附加费单位
"extend":"mock" //类型：String 可有字段 备注：扩展字段
}
]
}
]
}
]
成功返回结果
{
"success":true, //类型：Boolean 必有字段 备注：接口是否成功
"data":{ //类型：Object 必有字段 备注：处理结果
"successList":[ //类型：Array 必有字段 备注：成功列表
{ //类型：Object 必有字段 备注：运单实体
"unitId":"2021031610190001", //类型：String 必有字段 备注：第三方运单Id
"waybillNum":"waybillNum223", //类型：String 必有字段 备注：运单编号
"carNum":"李A22345", //类型：String 必有字段 备注：车牌号
"orderUnitId":"2021031610190001", //类型：String 必有字段 备注：三方订单id
"providerUnitId":"dsf202105121", //类型：String 必有字段 备注：三方供应商id，与订单供应商一致
"waybillSubmitTime":"2021-07-27 10:01:30", //类型：String 必有字段 备注：发货时间，yyyy-MM-dd HH:mm:ss
"status":1, //类型：Number 必有字段 备注：运单状态：1已发货
"remark":"备注", //类型：String 可有字段 备注：备注
"createTime":"2021-04-26 10:01:30", //类型：String 可有字段 备注：运单创建时间，yyyy-MM-dd HH:mm:ss
"lastModifyTime":"2021-04-28 10:01:30", //类型：String 可有字段 备注：运单修改时间，yyyy-MM-dd HH:mm:ss
"address":"地址11", //类型：String 必有字段 备注：地址
"driverTelNum":"18812354567", //类型：String 可有字段 备注：司机手机号
"driverName":"张三", //类型：String 可有字段 备注：司机名字
"creatorName":"发货李四", //类型：String 可有字段 备注：发货人名
"creatorUnitId":"12321", //类型：String 可有字段 备注：发货人三方id
"receiveType":1, //类型：Number 可有字段 备注：收货方式：1地磅，2移动验收
"syncCode":"xrqhhgj", //类型：String 必有字段 备注：项目同步编码
"optFlag":0, //类型：Number 必有字段 备注：操作。新增或修改：0，删除：2
"extend":"{}", //类型：String 可有字段 备注：扩展字段，json
"waybillMaterials":[ //类型：Array 必有字段 备注：发货材料明细
{ //类型：Object 必有字段 备注：无
"unitId":"2021031610190002", //类型：String 必有字段 备注：第三方唯一细表id
"unitPid":"2021031610190001", //类型：String 必有字段 备注：第三方主表运单id
"materialUnitId":"141", //类型：String 必有字段 备注：第三方材料Id，来自于订单材料，与订单材料Id一致
"materialName":"圆钢(Q235)_集成测试131", //类型：String 必有字段 备注：材料名称
"materialCode":"000131", //类型：String 必有字段 备注：材料编码
"specification":"Φ10", //类型：String 可有字段 备注：规格+型号
"unit":"匹", //类型：String 可有字段 备注：材料计量单位
"batchNumber":"批次号1", //类型：String 可有字段 备注：批次号
"wayBillQuantity":14.312, //类型：Number 必有字段 备注：发货量
"extend":"{}", //类型：String 可有字段 备注：扩展字段，json
"positionName":"测试部位", //类型：String 可有字段 备注：材料使用部位名称
"positionUnitId":"20230420001", //类型：String 可有字段 备注：材料使用部位三方id
"additionalCharges":[
{
"unitPid":"2021031610190002", //类型：String 可有字段 备注：第三方运单材料行id
"additionalChargeName":"泵送", //类型：String 必有字段 备注：附加费名称
"additionalChargeUnitId"："20230330002", //类型：String 必有字段 备注：第三方附加费id
"code":"test", //类型：String 可有字段 备注：附加费编码
"unit":"米", //类型：String 可有字段 备注：附加费单位
"extend":"mock" //类型：String 可有字段 备注：扩展字段
}
]
}
]
}
],
"errorList":[ //类型：Array 必有字段 备注：失败列表
{ //类型：Object 必有字段 备注：运单实体
"errMsg":"unitId为空", //类型：String 必有字段 备注：失败原因
"errCode"："biz_error", //类型：String 必有字段 备注：失败错误码
"unitId":"2021031610190001", //类型：String 必有字段 备注：第三方运单Id
"waybillNum":"waybillNum223", //类型：String 必有字段 备注：运单编号
"carNum":"李A22345", //类型：String 必有字段 备注：车牌号
"orderUnitId":"2021031610190001", //类型：String 必有字段 备注：三方订单id
"providerUnitId":"dsf202105121", //类型：String 必有字段 备注：三方供应商id，与订单供应商一致
"waybillSubmitTime":"2021-07-27 10:01:30", //类型：String 必有字段 备注：发货时间，yyyy-MM-dd HH:mm:ss
"status":1, //类型：Number 必有字段 备注：运单状态：1已发货
"remark":"备注", //类型：String 可有字段 备注：备注
"createTime":"2021-04-26 10:01:30", //类型：String 可有字段 备注：运单创建时间，yyyy-MM-dd HH:mm:ss
"lastModifyTime":"2021-04-28 10:01:30", //类型：String 可有字段 备注：运单修改时间，yyyy-MM-dd HH:mm:ss
"address":"地址11", //类型：String 必有字段 备注：地址
"driverTelNum":"18812354567", //类型：String 可有字段 备注：司机手机号
"driverName":"张三", //类型：String 可有字段 备注：司机名字
"creatorName":"发货李四", //类型：String 可有字段 备注：发货人名
"creatorUnitId":"12321", //类型：String 可有字段 备注：发货人三方id
"receiveType":1, //类型：Number 可有字段 备注：收货方式：1地磅，2移动验收
"syncCode":"xrqhhgj", //类型：String 必有字段 备注：项目同步编码
"optFlag":0, //类型：Number 必有字段 备注：操作。新增或修改：0，删除：2
"extend":"{}", //类型：String 可有字段 备注：扩展字段，json
"waybillMaterials":[ //类型：Array 必有字段 备注：发货材料明细
{ //类型：Object 必有字段 备注：无
"unitId":"2021031610190002", //类型：String 必有字段 备注：第三方唯一细表id
"unitPid":"2021031610190001", //类型：String 必有字段 备注：第三方主表运单id
"materialUnitId":"141", //类型：String 必有字段 备注：第三方材料Id，来自于订单材料，与订单材料Id一致
"materialName":"圆钢(Q235)_集成测试131", //类型：String 必有字段 备注：材料名称
"materialCode":"000131", //类型：String 必有字段 备注：材料编码
"specification":"Φ10", //类型：String 可有字段 备注：规格+型号
"unit":"匹", //类型：String 可有字段 备注：材料计量单位
"batchNumber":"批次号1", //类型：String 可有字段 备注：批次号
"wayBillQuantity":14.312, //类型：Number 必有字段 备注：发货量
"extend":"{}", //类型：String 可有字段 备注：扩展字段，json
"positionName":"测试部位", //类型：String 可有字段 备注：材料使用部位名称
"positionUnitId":"20230420001", //类型：String 可有字段 备注：材料使用部位三方id
"additionalCharges":[
{
"unitPid":"2021031610190002", //类型：String 可有字段 备注：第三方运单材料行id
"additionalChargeName":"泵送", //类型：String 必有字段 备注：附加费名称
"additionalChargeUnitId"："20230330002", //类型：String 必有字段 备注：第三方附加费id
"code":"test", //类型：String 可有字段 备注：附加费编码
"unit":"米", //类型：String 可有字段 备注：附加费单位
"extend":"mock" //类型：String 可有字段 备注：扩展字段
}
]
}
]
}
],
"message":"成功:1条，失败:1条" //类型：String 必有字段 备注：结果说明
}
}
系统异常返回结果
{
"errorCode": "system_error", // 类型:String 失败时返回 备注:系统异常，此种情况建议重试
"errorMsg": "系统异常", // 类型：String 失败时返回 备注：系统异常
"success": false, //类型：Boolean 必有字段 备注：接口是否成功
"code":500, // 类型:Number 必填字段 备注：错误码
"data":{ //类型：Object 必有字段 备注：处理结果
"errorList":[ //类型：Array 必有字段 备注：失败列表
{ //类型：Object 必有字段 备注：运单实体
"errMsg":null, //类型：String 必有字段 备注：失败原因
"errCode"：null, //类型：String 必有字段 备注：失败错误码
"unitId":"2021031610190001", //类型：String 必有字段 备注：第三方运单Id
"waybillNum":"waybillNum223", //类型：String 必有字段 备注：运单编号
"carNum":"李A22345", //类型：String 必有字段 备注：车牌号
"orderUnitId":"2021031610190001", //类型：String 必有字段 备注：三方订单id
"providerUnitId":"dsf202105121", //类型：String 必有字段 备注：三方供应商id，与订单供应商一致
"waybillSubmitTime":"2021-07-27 10:01:30", //类型：String 必有字段 备注：发货时间，yyyy-MM-dd HH:mm:ss
"status":1, //类型：Number 必有字段 备注：运单状态：1已发货
"remark":"备注", //类型：String 可有字段 备注：备注
"createTime":"2021-04-26 10:01:30", //类型：String 可有字段 备注：运单创建时间，yyyy-MM-dd HH:mm:ss
"lastModifyTime":"2021-04-28 10:01:30", //类型：String 可有字段 备注：运单修改时间，yyyy-MM-dd HH:mm:ss
"address":"地址11", //类型：String 必有字段 备注：地址
"driverTelNum":"18812354567", //类型：String 可有字段 备注：司机手机号
"driverName":"张三", //类型：String 可有字段 备注：司机名字
"creatorName":"发货李四", //类型：String 可有字段 备注：发货人名
"creatorUnitId":"12321", //类型：String 可有字段 备注：发货人三方id
"receiveType":1, //类型：Number 可有字段 备注：收货方式：1地磅，2移动验收
"syncCode":"xrqhhgj", //类型：String 必有字段 备注：项目同步编码
"optFlag":0, //类型：Number 必有字段 备注：操作。新增或修改：0，删除：2
"extend":"{}", //类型：String 可有字段 备注：扩展字段，json
"waybillMaterials":[ //类型：Array 必有字段 备注：发货材料明细
{ //类型：Object 必有字段 备注：无
"unitId":"2021031610190002", //类型：String 必有字段 备注：第三方唯一细表id
"unitPid":"2021031610190001", //类型：String 必有字段 备注：第三方主表运单id
"materialUnitId":"141", //类型：String 必有字段 备注：第三方材料Id，来自于订单材料，与订单材料Id一致
"materialName":"圆钢(Q235)_集成测试131", //类型：String 必有字段 备注：材料名称
"materialCode":"000131", //类型：String 必有字段 备注：材料编码
"specification":"Φ10", //类型：String 可有字段 备注：规格+型号
"unit":"匹", //类型：String 可有字段 备注：材料计量单位
"batchNumber":"批次号1", //类型：String 可有字段 备注：批次号
"wayBillQuantity":14.312, //类型：Number 必有字段 备注：发货量
"extend":"{}", //类型：String 可有字段 备注：扩展字段，json
"positionName":"测试部位", //类型：String 可有字段 备注：材料使用部位名称
"positionUnitId":"20230420001", //类型：String 可有字段 备注：材料使用部位三方id
"additionalCharges":[
{
"unitPid":"2021031610190002", //类型：String 可有字段 备注：第三方运单材料行id
"additionalChargeName":"泵送", //类型：String 必有字段 备注：附加费名称
"additionalChargeUnitId"："20230330002", //类型：String 必有字段 备注：第三方附加费id
"code":"test", //类型：String 可有字段 备注：附加费编码
"unit":"米", //类型：String 可有字段 备注：附加费单位
"extend":"mock" //类型：String 可有字段 备注：扩展字段
}
]
}
]
}
],
"message":"成功:0条，失败:1条", //类型：String 必有字段 备注：结果说明
"successList": [] //类型：Array 必有字段 备注：成功列表
}
}