帮助中心
帮助中心主页
HTTP API
Modbus API
常见问题
通过运单号查询运单状态

请求

  • 功能:查询运单状态
  • 方法:GET
  • 接口说明:/orderDetails/{id}
json
GET "http://host:8088/orderDetails/{id}"
1

路径参数

NameTypeDescriptionRequired
idstring运单的id,需唯一

请求示例

查询名称为 test 的运单信息

json
GET "http://host:8088/orderDetails/test"
1

响应

此接口可以查询两种不同形式的运单,普通运单拼合单普通运单拼合单查询返回的数据结构不同。

响应数据

查询普通运单

NameTypeDescription
idstring运单 id,需要宇宙唯一
vehiclestring接单机器人的机器人vehicle id,若无机器人接单,则不含该字段
createTimeint运单创建的时间戳,若无机器人接单,则不含该字段
terminalTimeint运单结束的时间戳,若运单未完成,则不含该字段
statestring当前运单状态。
已创建=CREATED,
等待=WAITING(block为空或者所有block都已经做完但是因为complete为false导致一直在等待新的block),
正在执行=RUNNING,
暂停=SUSPENDED,
完成=FINISHED,
失败=FAILED(主动失败),
终止=STOPPED(被人为终止),
无法执行=Error(参数错误),
待分配=TOBEDISPATCHED
blocksobject array运单中的动作块,其中每一个 object 代表一个动作块,详情见blocks表
groupstring接单机器人的机器人组
priorityint运单优先级,数字越大越优先
errorsobject array运单 error 错误码
warningsobject array运单 warnings 错误码
noticesobject array运单 notices 错误码
completebool运单是否封口的标示位
msgstring运单信息
startOdodouble开始执行运单时机器人的里程
finishOdodouble运单到终态时机器人的里程
orderOdodoublefinishOdo - startOdo

blocks 字段说明

blocks 中含有的大部分字段名取决于创建运单时填入的 blocks 字段内容,额外的字段如下表所示

NameTypeDescription
statestring动作块状态:
已创建=CREATED,
正在执行=RUNNING,
等待=WAITING(等待拼单或者放行信号),
正在回调=POSTING(正在进行消息回调流程),
暂停=SUSPENDED,
完成=FINISHED,
失败=FAILED,
终止=STOPPED,
手动终止=MANUAL_FINISHED,
无法执行=Error(参数错误)
containerNamestring货物所在的背篓名称

查询拼合单

NameTypeDescription
idstring运单id,需要宇宙唯一
fromLocstringload的目标库位
toLocstringunload的目标库位
containerNamestring货物所在的背篓名称
goodsIdstring货物名称,若创建拼单运单时没有指定货物名称,则不含该字段
vehiclestring接单机器人的机器人vehicle id,若无机器人接单,则该字段为空字符串
createTimeint运单创建的时间戳,若无机器人接单,则不含该字段
terminalTimeint运单结束的时间戳,若运单未完成,则不含该字段
loadOrderIdstring自动载货运单的order id
loadStatestring自动载货运单的运单状态
unloadOrderIdstring自动卸货运单的order id
unloadStatestring自动卸货运单的运单状态
statestring当前运单状态。
已创建=CREATED,
正在执行=RUNNING,
暂停=SUSPENDED,
完成=FINISHED,
失败=FAILED(主动失败),
终止=STOPPED(被人为终止),
无法执行=Error(参数错误),
待分配=TOBEDISPATCHED
statePosterstring拼合单状态变化回调配置字段,详情见拼合单状态变化回调
errorsobject array运单 error 错误码
warningsobject array运单 warnings 错误码
noticesobject array运单 notices 错误码

响应数据示例

Responses Code 200

查询普通运单响应
json
{
    "blocks": [                                 // 动作块的执行情况
        {
            "blockId": "16485534682640-1",      // 动作块 id,宇宙唯一
            "location": "AP4",                  // 终点
            "state": "RUNNING",                 // 动作块状态
            "containerName": "",                // 货物所在的背篓名称
            "goodsId":""                        // 货物名称
        },
        {
            "blockId": "16485534682640-2",
            "location": "AP30",
            "state": "CREATED",
            "containerName": "",
            "goodsId":""
        }
    ],
    "complete": true,                           // 运单是否已封口
    "createTime": 1648553468,                   // 创建时间
    "errors": [],                               // 运单错误码
    "group": "RobotGroup-01",                   // 接单机器人的机器人组
    "id": "16485534682640",                     // 运单 id,宇宙唯一
    "msg": "",                                  // 运单信息
    "notices": [],
    "priority": 0,                              // 运单优先级,数字越大越优先
    "state": "RUNNING",                         // 当前运单状态
    "vehicle": "RD-TEST-1",                     // 接单机器人的机器人vehicle id,若无机器人接单,则不含该字段
    "warnings": []
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

查询拼合单响应
json
{
  "createTime": 1648552818,                   // 创建时间
  "fromLoc": "Loc-03",                        // load的目标点
  "goodsId": "test111",                       // 货物名称
  "id": "16485525947420",                     // task id,任务id,宇宙唯一
  "loadOrderId": "16485525947420_load",       // 自动载货任务的order id
  "loadState": "RUNNING",                     // 载货状态
  "state": "FINISHED",                        // 当前任务状态
  "statePoster": "",
  "terminalTime": 1648552864,                 // 结束时间
  "toLoc": "Loc-04",                          // unload的目标点
  "unloadOrderId": "16485525947420_unload",   // 自动卸货任务的order id
  "unloadState": "CREATED",                   // 卸货状态
  "vehicle": "RD-TEST-1",                     // 接单机器人的机器人vehicle id,若无机器人接单,则该字段为空字符串
  "containerName": "0",                       // 背篓名称
  "goodsId":"goods0",                         // 货物名称
  "errors": [],
  "notices": [],
  "warnings": []
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

Responses Code 404

查询订单不存在
json
{
    "code": 50002,
    "create_on": "2022-02-10T18:21:25.073Z",
    "msg": "order details is empty"
}
1
2
3
4
5
最近更新 2022/11/28
文章内容

请求

路径参数

请求示例

查询名称为 test 的运单信息

响应

响应数据

查询普通运单

查询拼合单

响应数据示例

Responses Code 200

Responses Code 404