导入项目订单接口

接口说明

接口地址: /gys/material-track/order/batchSave

接口用途: 项目层订单导入接口

请求方式: POST

请求参数: JSON格式字符串

注意事项:

  • 单次请求条数不超过100条,大于100条,请分批次推送

重点说明

一、若需要关联第三方合同,请提前使用“导入项目合同信息接口”或“导入公司层合同信息接口” 导入合同

二、若入参订单状态为“全部发货完成”(status=3),库中无相同三方订单id的订单记录则新增订单,库中有相同单方订单id的订单记录则仅更新订单状态不修改其他字段

三、接口支持将“待发货”的订单进行作废,作废之后允许三方系统修改该订单,并重新将订单状态由”已作废”改为”待发货”

HTTP请求方式

POST

请求参数

参数 类型 必须 取值范围 默认值 描述
jsonStr String Y json对象 详细格式见下

订单主表属性

参数 类型 必须 取值范围(字符长度) 默认值 描述
syncCode String 50 项目同步编码
optFlag Number 2 操作。新增或修改:0,删除:2
unitId String 100 第三方订单id
orderNum String 255 订单编号
providerUnitId String 255 三方供应商ID
providerName String 255 供应商名称
creater String 20 下单人
projectName String 255 收货单位
address String 255 收货地址
orderMaterials Array 订单材料。属性详见【订单材料orderMaterials属性】
providerCode String 255 供应商编码(若未提前集成供应商则该字段必填)
providerCreditCode String 255 供应商统一信用代码(若未提前集成供应商则该字段必填)
createrUnitId String 100 三方下单人Id
submitTime String 20 下单时间,yyyy-MM-dd HH:mm:ss
note String 900 备注
useTime String 20 到场开始时间,yyyy-MM-dd HH:mm:ss
incomeEndDate String 20 到场结束时间,yyyy-MM-dd HH:mm:ss
orderBasis Number 2 下单依据 1 合同 2备用金
contractUnitId String 100 三方合同ID
contractName String 255 合同名称
contractCode String 255 合同编码
orderMaterialType Number 8 订单类型 1:混凝土、2:钢材、3:其他主材、4:零星材料、5:起租、6:退租
status Number 2 1 状态 1:待发货,3:全部发货完成
receiveType Number 8 收货方式:1:地磅,2:移动验收
positionName String 255 使用部位
positionUnitId String 255 使用部位三方ID
additionalChargeName String 255 附加费用
additionalChargeUnitId String 255 附加费用三方ID
consignee String 50 收货人
consigneeTelNum String 50 收获联系方式
extend String 扩展字段
src String 50 来源

订单材料orderMaterials属性

参数 类型 必须 取值范围(字符长度) 默认值 描述
unitId String 100 第三方唯一细表id
unitPid String 100 第三方主表订单id
materialUnitId String 255 第三方材料id
materialName String 255 材料名称
materialCode String 64 材料编码
orderQuantity Number 18,2 订单数量
incomeDate String 20 到场时间,yyyy-MM-dd HH:mm:ss
specification String 255 规格+型号
unit String 255 单位
slump String 100 坍落度
extend String 扩展字段
positionName String 255 材料使用部位名称
positionUnitId String 255 材料使用部位三方Id
note String 255 备注
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条

常见异常信息

响应端异常提示 请求端处理意见
参数集合不能为空 调用接口前校验入参列表非空
每次请求不允许超过100条数据 分批调用接口,每批100条数据
XXXX不允许为空 必填字段为空
XXXX长度不允许大于XX 字段超长
XX类型非法 枚举字段值不在提供范围
项目同步编码查询失败 建议重试此次同步订单
待作废订单XXX在库里不存在 待作废的订单需要提前集成到系统中
项目同步编码XXX,在库中不存在 检查授权文件是否与当前项目一致;检查syncCode是否正确
订单类型必须是“混凝土”、“钢材”、“其他主材”、“零星材料”、“起租”、“退租”其中一种 订单类型必须是指定的几种
订单类型必须是“地磅”、“移动验收”其中一种 订单收货方式必须是指定的几种
订单状态必须是“待发货”,“全部发货完成”其中一种 订单状态必须是指定的几种
订单材料明细列表不能为空 订单材料明细不能为空
第三方材料id不允许重复 检查材料id是否重复
未找到该订单对应项目 检查授权文件是否与当前项目一致;检查syncCode是否正确
第三方合同IDXXX,在字典中不存在 检查合同id是否是已集成过的合法数据
第三方供应商IDXXX集成失败,在字典中不存在 检查供应商id是否是已集成过的合法数据
导入第三方材料IDXXX失败,请检查材料信息是否重复或错误 检查材料信息是否合法
作废订单失败XXX 根据后面的具体提示信息做响应的修改即可,如:订单已作废,不允许再作废 ;或 只能作废本人创建的订单等

请求参数jsonStr具体格式:

[                //类型:Array  必有字段  备注:订单列表,调用接口时把外层的对象和list名称去掉
    {                //类型:Object  必有字段  备注:订单数据
        "unitId":"2021031610190001",                //类型:String  必有字段  备注:第三方订单id
        "syncCode":"HXSJYQ",                //类型:String  必有字段  备注:项目同步编码
        "orderNum":"orderNum123454",                //类型:String  必有字段  备注:订单编号
        "providerUnitId":"DSFGYS202103161020004",                //类型:String  必有字段  备注:三方供应商ID
        "providerName":"物料测试WQL有限公司A220210316004",                //类型:String  必有字段  备注:供应商名称
        "providerCode":"DSFJCHT20210316-00034",                //类型:String  可有字段  备注:供应商编码
        "providerCreditCode":"HTJCHZDW1202103160A4",                //类型:String  可有字段  备注:供应商统一信用代码
        "createrUnitId":"1440723",                //类型:String  可有字段  备注:三方下单人Id
        "creater":"物料验收测试专用管理员",                //类型:String  必有字段  备注:下单人
        "submitTime":"2020-04-09 08:00",                //类型:String  可有字段  备注:下单时间,yyyy-MM-dd HH:mm:ss
        "projectName":"花香四季",                //类型:String  必有字段  备注:收货单位
        "address":"我家",                //类型:String  必有字段  备注:收货地址
        "note":"备注弄",                //类型:String  可有字段  备注:备注
        "useTime":"2020-04-09 10:00",                //类型:String  可有字段  备注:到场开始时间,yyyy-MM-dd HH:mm:ss
        "incomeEndDate":"2020-04-09 10:00",                //类型:String  可有字段  备注:到场结束时间,yyyy-MM-dd HH:mm:ss
        "orderBasis":1,                //类型:Number  可有字段  备注:下单依据 1 合同 2备用金
        "contractUnitId":"2021031610190004",                //类型:String  可有字段  备注:三方合同ID
        "contractName":"集成测试合同1221",                //类型:String  可有字段  备注:合同名称
        "contractCode":"DSFJCHT20210316-00034",                //类型:String  可有字段  备注:合同编码
        "status":1,                           //状态 1:待发货,3:全部发货完成
        "orderMaterialType":1,                //类型:Number  可有字段  备注:订单类型(NEW) 1:混凝土、2:钢材、3:其他主材、4:零星材料
        "receiveType":1,                //类型:Number  可有字段  备注:收货方式(NEW):1:地磅,2:移动验收
        "positionName":"部位1",                //类型:String  可有字段  备注:使用部位(NEW)
        "positionUnitId":"122uint",                //类型:String  可有字段  备注:使用部位三方ID(NEW)
        "additionalChargeName":"附加费1",                //类型:String  可有字段  备注:附加费用(NEW)
        "additionalChargeUnitId":"fjf1001",                //类型:String  可有字段  备注:附加费用三方ID(NEW)
        "consignee":"收货人1",                //类型:String  可有字段  备注:收货人(NEW)
        "consigneeTelNum":"188222455",                //类型:String  可有字段  备注:收获联系方式(NEW)
        "optFlag":0,                //类型:Number  必有字段  备注:操作。新增或修改:0,删除:2
        "extend":"mock",                //类型:String  可有字段  备注:扩展字段(NEW)
        "orderMaterials":[                //类型:Array  必有字段  备注:订单材料
            {                //类型:Object  必有字段  备注:订单材料
                "unitId":"2021031610190002",                //类型:String  必有字段  备注:第三方唯一细表id(如果没值传-1)
                "unitPid":"2021031610190001",                //类型:String  必有字段  备注:第三方主表订单id
                "materialUnitId":"141",                //类型:String  必有字段  备注:第三方材料id
                "materialName":"圆钢(Q235)_集成测试131",                //类型:String  必有字段  备注:材料名称
                "materialCode":"000131",                //类型:String  必有字段  备注:材料编码
                "specification":"Φ10",                //类型:String  可有字段  备注:规格+型号
                "unit":"匹",                //类型:String  可有字段  备注:单位
                "orderQuantity":33,                //类型:Number  必有字段  备注:订单数量
                "incomeDate":"2020-04-09 10:00",                //类型:String  必有字段  备注:到场时间,yyyy-MM-dd HH:mm:ss
                "slump":"180±20",                //类型:String  可有字段  备注:坍落度(NEW)
                "extend":"mock",                //类型:String  可有字段  备注:扩展字段(NEW)
                "positionName":"测试部位"//类型:String  可有字段 备注:材料使用部位名称
                "positionUnitId":"20230330001",     //类型:String 可有字段  备注:材料使用部位三方id
                "note":"备注",                //类型:String  可有字段  备注:备注
                "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
                "syncCode":"HXSJYQ",                //类型:String  必有字段  备注:项目同步编码
                "orderNum":"orderNum123454",                //类型:String  必有字段  备注:订单编号
                "providerUnitId":"DSFGYS202103161020004",                //类型:String  必有字段  备注:三方供应商ID
                "providerName":"物料测试WQL有限公司A220210316004",                //类型:String  必有字段  备注:供应商名称
                "providerCode":"DSFJCHT20210316-00034",                //类型:String  可有字段  备注:供应商编码
                "providerCreditCode":"HTJCHZDW1202103160A4",                //类型:String  可有字段  备注:供应商统一信用代码
                "createrUnitId":"1440723",                //类型:String  可有字段  备注:三方下单人Id
                "creater":"物料验收测试专用管理员",                //类型:String  必有字段  备注:下单人
                "submitTime":"2020-04-09 08:00",                //类型:String  可有字段  备注:下单时间,yyyy-MM-dd HH:mm:ss
                "projectName":"花香四季",                //类型:String  必有字段  备注:收货单位
                "address":"我家",                //类型:String  必有字段  备注:收货地址
                "note":"备注弄",                //类型:String  可有字段  备注:备注
                "useTime":"2020-04-09 10:00",                //类型:String  可有字段  备注:到场开始时间,yyyy-MM-dd HH:mm:ss
                "incomeEndDate":"2020-04-09 10:00",                //类型:String  可有字段  备注:到场结束时间,yyyy-MM-dd HH:mm:ss
                "orderBasis":1,                //类型:Number  可有字段  备注:下单依据 1 合同 2备用金
                "contractUnitId":"2021031610190004",                //类型:String  可有字段  备注:三方合同ID
                "contractName":"集成测试合同1221",                //类型:String  可有字段  备注:合同名称
                "contractCode":"DSFJCHT20210316-00034",                //类型:String  可有字段  备注:合同编码
                "optFlag":0,                //类型:Number  必有字段  备注:操作。新增或修改:0,删除:2
                "orderMaterials":[                //类型:Array  必有字段  备注:订单材料
                    {                //类型:Object  必有字段  备注:订单材料
                        "unitId":"2021031610190002",                //类型:String  必有字段  备注:第三方唯一细表id(如果没值传-1)
                        "unitPid":"2021031610190001",                //类型:String  必有字段  备注:第三方主表订单id
                        "materialUnitId":"141",                //类型:String  必有字段  备注:第三方材料id
                        "materialName":"圆钢(Q235)_集成测试131",                //类型:String  必有字段  备注:材料名称
                        "materialCode":"000131",                //类型:String  必有字段  备注:材料编码
                        "specification":"Φ10",                //类型:String  必有字段  备注:规格+型号
                        "unit":"匹",                //类型:String  必有字段  备注:单位
                        "orderQuantity":33,                //类型:Number  必有字段  备注:订单数量
                        "incomeDate":"2020-04-09 10:00",                //类型:String  必有字段  备注:到场时间,yyyy-MM-dd HH:mm:ss
                        "positionName":"测试部位"//类型:String  可有字段 备注:材料使用部位名称
                        "positionUnitId":"20230330001"     //类型:String 可有字段  备注:材料使用部位三方id
                        "note":"备注",                //类型:String  可有字段  备注:备注
                        "additionalCharges":[
                            {
                                "unitPid":"2021031610190002",    //类型:String 可有字段 备注:第三方订单材料行id
                                "additionalChargeName":"泵送",    //类型:String 必有字段 备注:附加费名称
                                "additionalChargeUnitId""20230330002",      //类型:String 必有字段 备注:第三方附加费id
                                "code":"test",  //类型:String 可有字段 备注:附加费编码
                                "unit":"米",     //类型:String 可有字段 备注:附加费单位
                                "extend":"mock"     //类型:String 可有字段 备注:扩展字段
                            }
                         ]
                    }
                ]
            }
        ],
        "errorList":[                //类型:Array  必有字段  备注:无
            {                //类型:Object  必有字段  备注:订单数据
                "unitId":"2021031610190001",                //类型:String  必有字段  备注:第三方订单id
                "syncCode":"HXSJYQ",                //类型:String  必有字段  备注:项目同步编码
                "orderNum":"orderNum123454",                //类型:String  必有字段  备注:订单编号
                "providerUnitId":"DSFGYS202103161020004",                //类型:String  必有字段  备注:三方供应商ID
                "providerName":"物料测试WQL有限公司A220210316004",                //类型:String  必有字段  备注:供应商名称
                "providerCode":"DSFJCHT20210316-00034",                //类型:String  可有字段  备注:供应商编码
                "providerCreditCode":"HTJCHZDW1202103160A4",                //类型:String  可有字段  备注:供应商统一信用代码
                "createrUnitId":"1440723",                //类型:String  可有字段  备注:三方下单人Id
                "creater":"物料验收测试专用管理员",                //类型:String  必有字段  备注:下单人
                "submitTime":"2020-04-09 08:00",                //类型:String  可有字段  备注:下单时间,yyyy-MM-dd HH:mm:ss
                "projectName":"花香四季",                //类型:String  必有字段  备注:收货单位
                "address":"我家",                //类型:String  必有字段  备注:收货地址
                "note":"备注弄",                //类型:String  可有字段  备注:备注
                "useTime":"2020-04-09 10:00",                //类型:String  可有字段  备注:到场开始时间,yyyy-MM-dd HH:mm:ss
                "incomeEndDate":"2020-04-09 10:00",                //类型:String  可有字段  备注:到场结束时间,yyyy-MM-dd HH:mm:ss
                "orderBasis":1,                //类型:Number  可有字段  备注:下单依据 1 合同 2备用金
                "contractUnitId":"2021031610190004",                //类型:String  可有字段  备注:三方合同ID
                "contractName":"集成测试合同1221",                //类型:String  可有字段  备注:合同名称
                "contractCode":"DSFJCHT20210316-00034",                //类型:String  可有字段  备注:合同编码
                "optFlag":0,                //类型:Number  必有字段  备注:操作。新增或修改:0,删除:2
                "orderMaterials":[                //类型:Array  必有字段  备注:订单材料
                    {                //类型:Object  必有字段  备注:订单材料
                        "unitId":"2021031610190002",                //类型:String  必有字段  备注:第三方唯一细表id(如果没值传-1)
                        "unitPid":"2021031610190001",                //类型:String  必有字段  备注:第三方主表订单id
                        "materialUnitId":"141",                //类型:String  必有字段  备注:第三方材料id
                        "materialName":"圆钢(Q235)_集成测试131",                //类型:String  必有字段  备注:材料名称
                        "materialCode":"000131",                //类型:String  必有字段  备注:材料编码
                        "specification":"Φ10",                //类型:String  必有字段  备注:规格+型号
                        "unit":"匹",                //类型:String  必有字段  备注:单位
                        "orderQuantity":33,                //类型:Number  必有字段  备注:订单数量
                        "incomeDate":"2020-04-09 10:00",                //类型:String  必有字段  备注:到场时间,yyyy-MM-dd HH:mm:ss
                        "positionName":"测试部位"//类型:String  可有字段 备注:材料使用部位名称
                        "positionUnitId":"20230330001"     //类型:String 可有字段  备注:材料使用部位三方id
                        "note":"备注",                //类型:String  可有字段  备注:备注
                        "additionalCharges":[
                            {
                                "unitPid":"2021031610190002",    //类型:String 可有字段 备注:第三方订单材料行id
                                "additionalChargeName":"泵送",    //类型:String 必有字段 备注:附加费名称
                                "additionalChargeUnitId""20230330002",      //类型:String 必有字段 备注:第三方附加费id
                                "code":"test",  //类型:String 可有字段 备注:附加费编码
                                "unit":"米",     //类型:String 可有字段 备注:附加费单位
                                "extend":"mock"     //类型:String 可有字段 备注:扩展字段
                            }
                         ]
                    }
                ],
                "errMsg":"下单人名称不允许为空",                //类型:String  必有字段  备注:错误信息
                "errCode":"biz_error"                      //类型:String  必有字段  备注:错误码
            }
        ],
        "message":"成功:1条,失败:1条"                //类型:String  必有字段  备注:结果说明。
    }
}

系统异常返回结果:

{
    "success":false,                //类型:Boolean  必有字段  备注:是否成功
    "data":{                //类型:Object  必有字段  备注:无
        "successList":[],                //类型:Array  必有字段  备注:无
        "errorList":[                //类型:Array  必有字段  备注:无
            {                //类型:Object  必有字段  备注:订单数据
                "unitId":"2021031610190001",                //类型:String  必有字段  备注:第三方订单id
                "syncCode":"HXSJYQ",                //类型:String  必有字段  备注:项目同步编码
                "orderNum":"orderNum123454",                //类型:String  必有字段  备注:订单编号
                "providerUnitId":"DSFGYS202103161020004",                //类型:String  必有字段  备注:三方供应商ID
                "providerName":"物料测试WQL有限公司A220210316004",                //类型:String  必有字段  备注:供应商名称
                "providerCode":"DSFJCHT20210316-00034",                //类型:String  可有字段  备注:供应商编码
                "providerCreditCode":"HTJCHZDW1202103160A4",                //类型:String  可有字段  备注:供应商统一信用代码
                "createrUnitId":"1440723",                //类型:String  可有字段  备注:三方下单人Id
                "creater":"物料验收测试专用管理员",                //类型:String  必有字段  备注:下单人
                "submitTime":"2020-04-09 08:00",                //类型:String  可有字段  备注:下单时间,yyyy-MM-dd HH:mm:ss
                "projectName":"花香四季",                //类型:String  必有字段  备注:收货单位
                "address":"我家",                //类型:String  必有字段  备注:收货地址
                "note":"备注弄",                //类型:String  可有字段  备注:备注
                "useTime":"2020-04-09 10:00",                //类型:String  可有字段  备注:到场开始时间,yyyy-MM-dd HH:mm:ss
                "incomeEndDate":"2020-04-09 10:00",                //类型:String  可有字段  备注:到场结束时间,yyyy-MM-dd HH:mm:ss
                "orderBasis":1,                //类型:Number  可有字段  备注:下单依据 1 合同 2备用金
                "contractUnitId":"2021031610190004",                //类型:String  可有字段  备注:三方合同ID
                "contractName":"集成测试合同1221",                //类型:String  可有字段  备注:合同名称
                "contractCode":"DSFJCHT20210316-00034",                //类型:String  可有字段  备注:合同编码
                "optFlag":0,                //类型:Number  必有字段  备注:操作。新增或修改:0,删除:2
                "orderMaterials":[                //类型:Array  必有字段  备注:订单材料
                    {                //类型:Object  必有字段  备注:订单材料
                        "unitId":"2021031610190002",                //类型:String  必有字段  备注:第三方唯一细表id(如果没值传-1)
                        "unitPid":"2021031610190001",                //类型:String  必有字段  备注:第三方主表订单id
                        "materialUnitId":"141",                //类型:String  必有字段  备注:第三方材料id
                        "materialName":"圆钢(Q235)_集成测试131",                //类型:String  必有字段  备注:材料名称
                        "materialCode":"000131",                //类型:String  必有字段  备注:材料编码
                        "specification":"Φ10",                //类型:String  必有字段  备注:规格+型号
                        "unit":"匹",                //类型:String  必有字段  备注:单位
                        "orderQuantity":33,                //类型:Number  必有字段  备注:订单数量
                        "incomeDate":"2020-04-09 10:00",                //类型:String  必有字段  备注:到场时间,yyyy-MM-dd HH:mm:ss
                        "positionName":"测试部位"//类型:String  可有字段 备注:材料使用部位名称
                        "positionUnitId":"20230330001"     //类型:String 可有字段  备注:材料使用部位三方id
                        "note":"备注弄",                //类型:String  可有字段  备注:备注
                        "additionalCharges":[
                            {
                                "unitPid":"2021031610190002",    //类型:String 可有字段 备注:第三方订单材料行id
                                "additionalChargeName":"泵送",    //类型:String 必有字段 备注:附加费名称
                                "additionalChargeUnitId""20230330002",      //类型:String 必有字段 备注:第三方附加费id
                                "code":"test",  //类型:String 可有字段 备注:附加费编码
                                "unit":"米",     //类型:String 可有字段 备注:附加费单位
                                "extend":"mock"     //类型:String 可有字段 备注:扩展字段
                            }
                         ]
                    }
                ],
                "errMsg":null,                //类型:String  必有字段  备注:错误信息
                "errCode":null                     //类型:String  必有字段  备注:错误码
            }
           ],
         "message":"成功:0条,失败:1条",  //类型:String  必有字段  备注:结果说明。
      },
      "message":null,                //类型:String  必有字段  备注:结果说明。
      "errorCode": "system_error",            //类型:String 失败时返回 备注:系统异常,此种情况允许重试
      "errorMsg": "系统异常",                // 类型:String 失败时返回 备注:系统异常
      "code": 500               // 类型:Number 必填字段  备注:错误码
}

results matching ""

    No results matching ""