网店管家云端版物流分拣对接说明书
前言
本文档目的是定义管家云端版客户端与物流分拣设备的交互接口
接口规范说明
对外服务接口统一使用UTF-8编码，接口通信协议支持HTTP/POST协议。
管家设置
在菜单接口->物流分拣设备下。设置界面如图：
设置选项说明：
分拣服务端口号：开启服务器后开放给硬件设备调用的接口端口号。
自动发货确认：勾选后，如果订单未发货，调用分拣接口后自动发货。
保存日志文件：勾选后，在管家客户端安装目录的log文件夹下记录接口调用日志。
货品重量和预估重量偏差：勾选后，分拣接口将校验实际重量和订单预估重量，如果偏差超过设置的重量，分拣接口返回失败。
状态检测：勾选后分拣接口会检测订单的发货状态和退款状态，如果管家订单已经发货则不检测。
接口地址
接口地址为管家客户安装电脑的地址，端口可在管家客户端配置，参见设置说明。
请求url示例：
http://localhost:50001?method=wdgjyun.trade.logisticsortbyid&bizcontent={"logisticNo":
"78101177282303","weight": 10,"packageCode":"701177282303"}
公共请求参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
method | String | 是 | 50 | 方法名 | wdgjyun.trade.logisticsortbyid |
bizcontent | String | 是 | 不限制 | 业务参数 | {"logisticNo": "78101177282303","weight": 10}
|
公共返回参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
code | int | 是 | 16 | 返回码 | 200 |
msg | String | 是 | 无 | 返回消息 | 未知错误 |
result | Result | 是 | 返回结果 | ||
∟data | Data | 是 | 返回业务数据 |
物流分拣方法
功能描述
分拣设备通过接口传递包裹运单号，重量，包裝条码给管家，管家返回订单的运单号所属快递公司编码，更新管家的重量，包装材。如果设置了订单状态检测且订单检测到退款则返回失败，如果未检测到退款且设置自动发货确认，订单自动完成出库，扣减货品和包装库存。
method：wdgjyun.trade.logisticsortbyid
业务请求参数：
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
logisticNo | String | 是 | 30 | 运单号 | 78101177282303 |
weight | decimal(12,4) | 是 | decimal(12,4) | 包裹重量 | 10.0
|
packageCode | string | 否 | 50 | 包装条码 | 01177282303，不传或者传空则不更新包装材料 |
业务返回参数
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
expressCode | String | 是 | 50 | 快递公司编码 | ZTO |
expressName | String | 是 | 50 | 快递公司名称 | 中通 |
estimateWeight | decimal(12,4) | 是 | decimal(12,4) | 预估重量（单位克） | 10 |
logisticNo | String | 是 | 30 | 运单号 | 78101177282303 |
请求业务参数示例
{
"logisticNo":"78101177282303",
"weight":10
"packageCode":"701177282303"
}
响应示例
{
"code":"200",
"msg":"",
"result": {
"data": {
"expressCode":"ZTO",
"expressName":"中通",
"logisticNo":"78101177282303",
"estimateWeight":10
}
}
}
异常示例
{
"code":"0",
"msg":"未知错误",
"result": {
"data":null,
}
}
打印货运单方法
功能描述
硬件传递订单号或者运单号给网店管家，网店管家根据订单号或运单号打印货运单，并返回打印触发结果（只触发打印机打印，不等待打印机反馈结果）。
method：wdgjyun.trade.printexpress
业务请求参数：
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
keyNo | String | 是 | 30 | 运单号或者管家订单号，根据打印类型判断 | 78101177282303 |
type | int | 是 | 打印类型 | 1=运单号，2=订单号
|
业务返回参数
无 | |||||
请求业务参数示例
{
"keyNo":"78101177282303",
"type":1
}
响应示例
{
"code":"200",
"msg":"",
"result": {
"data":null
}
}
异常示例
{
"code":"0",
"msg":"未知错误",
"result": {
"data":null,
}
}
共有条评论 网友评论