4.1 订单数据导入(城配版)

4.1.1 说明

请求方式:通过POST方式进行接口请求,以JSON格式返回结果。

接口名称:v1/import_order_bystore.php

简要描述:用于企业ERP/WMS/外部订单系统导入订单信息数据到物流云平台(发货人和收货人信息必须存在于门店/配送中心/客户关系网库),导入成功后,可通过“物流云平台 -> 运单管理”进行管理。客户订单号存在时则覆盖,否则新增。

错误编码:0,1001,1002,1003,1004,1005,1009,1900,2000

4.1.2 请求参数

参数名称格式描述参与签名必填
sourcecode String 客户订单号(作为对接订单的唯一标识) Y Y
customer_note String 客户备注 Y N
goods_des String 货物种类(与“物流云平台 -> 数据字典 -> 运单管理 -> 货物种类”中名称一致) Y N
arrive_starttime String 要求送达时间(此时间之后送达。格式:YYYY-MM-DD HH:mm:ss 例如:2017-01-01或2017-01-01 08:10或2017-01-01 08:10:02) Y Y
arrive_endtime String 要求送达时间(此时间之前送达。格式:YYYY-MM-DD HH:mm:ss 例如:2017-01-01或2017-01-01 08:10或2017-01-01 08:10:02) Y Y
receivables_from Integer 收款方(0为无、1为收货人、2为发货人;货运类型为提并送时才有效) Y N
receivables Float 应收金额(元) Y N
freight_type Integer 货运类型(1为送货、2为提货、3为提并送) Y Y
org_name String 所属机构(与“物流云平台 -> 组织管理”中名称一致;默认为此公司的根节点组织机构) Y N
storecode String 送货点编码(门店编码 / 配送中心编码 / 客户关系编码) Y Y
warehousecode String 装货点编码(门店编码 / 配送中心编码 / 客户关系编码) Y Y
lineno String 路由编号(不传此参数时,若送货点编码/装货点编码可关联到固定路由且只有一条,则系统自动关联此固定路由) Y N
goods code Json
(Array)
String 货物编码(不传此参数则系统自动生成编码) Y N
name String 货物名称 Y Y
package String 预留,暂未启用。将用于多种周转箱的名称,系统暂时只支持一种周转箱。 Y N
amount Integer 整件数量 Y N
unit String 整件单位(如:箱、框;与“物流云平台 -> 数据字典 -> 运单管理 -> 货物单位”中名称一致) Y N
weight Float 总重量(公斤) Y N
volume Float 整件体积(立方,即为自带包装的整件体积) Y N
pvolume Float 周转箱体积(立方,即为拆零货物在周转箱中的占用体积) Y N
公共输入参数 详见公共请求参数

PS:参数goods为打包好的货物列表,JSON数组字符串,每个订单最多支持20种打包的货物,格式如:goods=[{"name":"西瓜",amount:10,"unit":"框"}]

4.1.3 返回结果

参数名称格式描述
errcode Integer 错误编码(详见错误编码
errmsg String 错误提示

4.2 审核订单数据

4.2.1 说明

请求方式:通过POST方式进行接口请求,以JSON格式返回结果。

接口名称:v1/check_order.php

简要描述:用于企业ERP/WMS/外部订单系统批量审核订单数据,审核通过的订单更改为已提交状态,审核不通过则作废订单(已删除状态)。请求参数orders为客户订单号的集合,前提是订单必须存在于运货单库中,且状态为新增。

错误编码:0,1001,1002,1003,1004,1005,1009,1900,2000

4.2.2 请求参数

参数名称格式描述参与签名必填
ischeck Integer 审核状态(1为审核通过,2为审核不通过) Y Y
orders Json
(Array<String>)
客户订单号集合(单次最多传100个订单号) Y Y
公共输入参数 详见公共请求参数

PS:参数orders为JSON数组字符串,格式如:orders=["170906263330","170905014066"]

4.2.3 返回结果

参数名称格式描述
errcode Integer 错误编码(详见错误编码
errmsg String 错误提示
orders_success Json(Array<String>) 审核成功的客户订单号集合
orders_fail Json(Array<String>) 审核失败的客户订单号集合

4.3 生成配送任务单

4.3.1 说明

请求方式:通过POST方式进行接口请求,以JSON格式返回结果。

接口名称:v1/import_taskplan.php

简要描述:用于企业外部系统导入已生成的配送任务单(装车单)到物流云平台,导入成功后,可通过“物流云平台 -> 运输计划”进行管理。装车任务号存在时则覆盖记录,否则为新增。请求参数orders为客户订单号的集合,前提是订单必须存在于运货单库中,JSON数组成员的先后顺序即为默认线路顺序。

参数orders中的订单需要按以下规则进行装车:

货运类型 规则
送货 必须是相同的发货地址
提货 必须是相同的收货地址
提并送 不能与其他货运类型混合
提货和送货混合 提货的收货地址与送货的发货地址必须是相同地址

错误编码:0,1001,1002,1003,1004,1005,1009,1900,2000

4.3.2 请求参数

参数名称格式描述参与签名必填
taskkey String 装车任务号(作为对接配送任务单的唯一标识) Y Y
carlicense String 运输车辆的车牌号码(与“物流云平台 -> 运力管理 -> 车辆管理”中号码一致) Y Y
drmobile String 配送司机手机号(与“物流云平台 -> 运力管理 -> 配送人管理”中号码一致) Y Y
departtime Integer 发车时间(UTC时间戳) Y Y
orders Json
(Array<String>)
客户订单号集合(数量有限制,以实际配置为准) Y Y
atsendtime Integer 任务单计划发送给司机/送货人员/装货人员时间(UTC时间戳) Y N
atidxtype Integer 发送线路顺序(1为默认线路、2为优化线路) Y N
remark String 配送备注 Y N
sendmobile1 String 送货人员1手机号(与“物流云平台 -> 运力管理 -> 配送人管理”中号码一致) Y N
sendmobile2 String 送货人员2手机号(与“物流云平台 -> 运力管理 -> 配送人管理”中号码一致) Y N
loadmobile1 String 装货人员1手机号(与“物流云平台 -> 运力管理 -> 配送人管理”中号码一致) Y N
loadmobile2 String 装货人员2手机号(与“物流云平台 -> 运力管理 -> 配送人管理”中号码一致) Y N
warehousecode String 回程点(门店编码 / 配送中心编码 / 客户关系编码) Y N
公共输入参数 详见公共请求参数

PS:参数orders为JSON数组字符串,格式如:orders=["170906263330","170905014066"]

4.3.3 返回结果

参数名称格式描述
errcode Integer 错误编码(详见错误编码
errmsg String 错误提示
taskid Integer 生成的配送任务ID(由12位数字组成,成功时此值才有效,【64位整型,长度为8个字节】)

4.4 获取配送任务单明细

4.4.1 说明

请求方式:通过POST方式进行接口请求,以JSON格式返回结果。

接口名称:v1/get_taskplan_base.php

简要描述:用于获取配送任务单(装车单)的配送顺序、预估里程/时长、实际行驶里程/时长、配送任务单状态等信息。返回结果orders为订单基本信息集合,JSON数组成员的先后顺序即为配送线路顺序。

错误编码:0,1001,1002,1003,1004,1005,1009,1900,2000

4.4.2 请求参数

参数名称格式描述参与签名必填
taskid Integer 配送任务ID(【64位整型,长度为8个字节】) Y Y
公共输入参数 详见公共请求参数

4.4.3 返回结果

参数名称格式描述
errcode Integer 错误编码(详见错误编码
errmsg String 错误提示
task carlicense Object String 运输车辆的车牌号码
departtime Integer 发车时间(UTC时间戳)
drmobile String 配送司机手机号
drname String 配送司机姓名
sendmobile1 String 送货人员1手机号
sendname1 String 送货人员1姓名
sendmobile2 String 送货人员2手机号
sendname2 String 送货人员2姓名
loadmobile1 String 装货人员1手机号
loadname1 String 装货人员1姓名
loadmobile2 String 装货人员2手机号
loadname2 String 装货人员2姓名
predistance Integer 预估里程(单位:米)
pretime Integer 预估时长(单位:分钟)
distance Integer 实际里程(单位:米,此值为任务单执行完成且统计分析完成后才有效)
time Integer 实际时长(单位:分钟,此值为任务单执行完成且统计分析完成后才有效)
配送任务单状态 Integer

车辆属性

0 待运货(已计划)

1 运货中(作业中)

2 已完成

3 暂停运货(作业中)

4 中止运货(作业中)

255 已删除

orders cut_orderid Array String 客户订单号
status Integer

运货状态

0 待运货

1 运货中

2 已完成

3 已完成

4 暂停运货

5 中止运货

255 已删除

orderstatus Integer

订单状态

20 已计划

21 已发布

30 作业中(待提货)

31 作业中(提货中)

32 作业中(已提货)

40 作业中(送货中)

50 已完成

51 已删除

finishtime Integer 运货完成时间

4.5 拉取配送任务单列表

4.5.1 说明

请求方式:通过POST方式进行接口请求,以JSON格式返回结果。

接口名称:v1/get_taskplan_list.php

简要描述:用于查询一定发车时间范围内的配送任务单(装车单)列表,列表中的配送任务单记录可通过“获取配送任务单明细”接口获取明细信息。

错误编码:0,1001,1002,1003,1004,1005,1009,1900,2000

4.5.2 请求参数

参数名称格式描述参与签名必填
btime Integer 开始时间(UTC时间戳,以发车时间查询) Y Y
etime Integer 结束时间(UTC时间戳,以发车时间查询,时间跨度不允许超过一个月) Y Y
carlicense String 车牌号码(按车辆查询任务单) Y N
pagesize Integer 每页条数(取值范围1-100,默认10) Y N
pageindex Integer 页码(从1开始计算) Y N
公共输入参数 详见公共请求参数

4.5.3 返回结果

参数名称格式描述
errcode Integer 错误编码(详见错误编码
errmsg String 错误提示
total Integer 总记录数
tasks taskid Array Integer 配送任务ID(由12位数字组成,【64位整型,长度为8个字节】)
carlicense String 运输车辆的车牌号码
departtime Integer 发车时间(UTC时间戳)
drmobile String 配送司机手机号
drname String 配送司机姓名
sendmobile1 String 送货人员1手机号
sendname1 String 送货人员1姓名
sendmobile2 String 送货人员2手机号
sendname2 String 送货人员2姓名
loadmobile1 String 装货人员1手机号
loadname1 String 装货人员1姓名
loadmobile2 String 装货人员2手机号
loadname2 String 装货人员2姓名
predistance Integer 预估里程(单位:米)
pretime Integer 预估时长(单位:分钟)
status Integer

配送任务单状态

0 待运货(已计划)

1 运货中(作业中)

2 已完成

3 暂停运货(作业中)

4 中止运货(作业中)

255 已删除

4.6 纠正配送任务单

4.6.1 说明

请求方式:通过POST方式进行接口请求,以JSON格式返回结果。

接口名称:v1/edit_taskplan.php

简要描述:用于分拣后纠正配送任务单(装车单)的配送线路顺序或订单范围。只有未开始的配送任务单才允许纠正。请求参数orders为客户订单号的集合,前提是订单必须存在于运货单库中,JSON数组成员的先后顺序即为配送线路顺序。

参数orders中的订单需要按以下规则进行装车:

货运类型 规则
送货 必须是相同的发货地址
提货 必须是相同的收货地址
提并送 不能与其他货运类型混合
提货和送货混合 提货的收货地址与送货的发货地址必须是相同地址

错误编码:0,1001,1002,1003,1004,1005,1009,1900,2000

4.6.2 请求参数

参数名称格式描述参与签名必填
taskid Integer 配送任务ID(【64位整型,长度为8个字节】) Y Y
orders Json
(Array<String>)
客户订单号集合(数量有限制,以实际配置为准) Y Y
公共输入参数 详见公共请求参数

PS:参数orders为JSON数组字符串,格式如:orders=["170906263330","170905014066"]

4.6.3 返回结果

参数名称格式描述
errcode Integer 错误编码(详见错误编码
errmsg String 错误提示
taskid Integer 配送任务ID(【64位整型,长度为8个字节】)

4.7 回传分拣结果和配送箱框借出信息(城配版)

4.7.1 说明

请求方式:通过POST方式进行接口请求,以JSON格式返回结果。

接口名称:v1/upload_taskplan_sortresult.php

简要描述:用于分拣后回传运货单(订单)的分拣结果和配送箱框借出信息。回传成功后,运货单附加状态会更改为已拣货。请求参数orders为当前传参门店的送货/提货订单集合,前提是订单必须存在于运货单库中。

错误编码:0,1001,1002,1003,1004,1005,1009,1900,2000

4.7.2 请求参数

请求参数的POST数据举例:

sortkey=201801010052&storecode=AF078&tool={"name":"周转箱","owenum":2,"loannum":3}&amount=1&weight=20.57&volume=0.95&pickarea=A01&orders=[{"sourcecode":"47858989","iscancel":0}]

参数名称格式描述参与签名必填
sortkey String 出货单号(作为对接分拣结果的唯一标识) Y Y
storecode String 门店编码 Y Y
tool name Json
(Object)
String 周转箱名称(用于多种周转箱规格的名称,系统暂时只支持一种周转箱。可不传此参数,系统自动从“物流云平台”的配置中获取默认名称。) Y N
owenum Integer 原欠数量
loannum Integer 新借数量(本次出车的数量)
amount Integer 整件数量 Y N
weight Float 总重量(公斤,包含整件和周转箱) Y N
volume Float 总体积(立方,包含整件和周转箱) Y N
pickarea String 集货区 Y N
orders sourcecode String 客户订单号 Y Y
iscancel Integer 是否取消送货(1为取消送货,0为有效) Y Y
公共输入参数 详见公共请求参数

PS:参数orders为JSON数组字符串,格式如:orders=[{"sourcecode":"47858989","iscancel":0}]

4.7.3 返回结果

参数名称格式描述
errcode Integer 错误编码(详见错误编码
errmsg String 错误提示

4.8 获取随车工具归还记录

4.8.1 说明

请求方式:通过POST方式进行接口请求,以JSON格式返回结果。

接口名称:v1/get_taskplan_tools.php

简要描述:用于获取配送任务单(装车单)的随车工具归还记录。

错误编码:0,1001,1002,1003,1004,1005,1009,1900,2000

4.8.2 请求参数

参数名称格式描述参与签名必填
taskid Integer 配送任务ID(【64位整型,长度为8个字节】) Y Y
公共输入参数 详见公共请求参数

4.8.3 返回结果

参数名称格式描述
errcode Integer 错误编码(详见错误编码
errmsg String 错误提示
datas storecode String 门店编码(0代表为其它,否则为门店)
tools_owe name String 随车工具名称
num Integer 原欠数量
tools_loan name String 随车工具名称
num Integer 新借数量(本次出车的数量)
tools_return name String 随车工具名称
num Integer 归还数量(本次回车的数量,即回收箱数)
update_time Integer 记录更新时间(UTC时间戳)

PS:以上“随车工具名称”包含【周转箱】记录。

4.9 回传出回车信息

4.9.1 说明

请求方式:通过POST方式进行接口请求,以JSON格式返回结果。

接口名称:v1/upload_taskplan_travelinfo.php

简要描述:用于企业ERP/WMS/外部订单系统回传出车和回车信息数据。

错误编码:0,1001,1002,1003,1004,1005,1009,1900,2000

4.9.2 请求参数

参数名称格式描述参与签名必填
taskid Integer 配送任务ID(【64位整型,长度为8个字节】) Y Y
mileage_start Integer 手抄出车里程(公里) Y Y
mileage_end Integer 手抄回车里程(公里) Y Y
outtime Integer 手抄出车时间(UTC时间戳) Y N
backtime Integer 手抄回车时间(UTC时间戳) Y N
公共输入参数 详见公共请求参数

4.9.3 返回结果

参数名称格式描述
errcode Integer 错误编码(详见错误编码
errmsg String 错误提示
 
版权所有 ©马蹄圈,并保留所有权利。
粤ICP备16121480号