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

接口介绍

API可以使用动作块(blockId)来查询创建运单中创建的运单状态。

需注意:若 blockId 在所有运单中不唯一,则只能查询到最后一个包含该 blockId 的运单状态

请求

  • 功能:通过动作块 id 查询运单信息
  • 方法:GET
  • 接口说明:/orderDetailsByBlockId/{blockId}
json
GET "http://host:8088/orderDetailsByBlockId/{blockId}"
1

路径参数

NameTypeDescriptionRequired
blockIdstring动作块 id

请求示例

查询包含动作块 b1 的运单状态

json
GET "http://host:8088/orderDetailsByBlockId/b1"
1

响应

响应数据

返回数据结构可参考通过运单号查询运单状态。需注意:通过 blockId 只能查询到普通运单的状态,因为拼合单没有 blockId 这一个字段。

响应数据示例

Responses Code 200

查询 blockId 为 b1 的运单状态的响应
json
{
    "blocks": [
        {
            "binTask": "",
            "blockId": "b1",
            "goodsId": "",
            "location": "AP29",
            "operation": "",
            "operation_args": "null",
            "script_args": "null",
            "script_name": "",
            "state": "FINISHED"
        }
    ],
    "complete": true,
    "createTime": 1652090505,
    "error": "",
    "executionTimeCost": 19,
    "externalId": "e2",
    "group": "",
    "id": "16520905057740",
    "joinable": false,
    "msg": "",
    "receiveTime": 1652090505,
    "state": "FINISHED",
    "terminalTime": 1652090524,
    "type": 0,
    "vehicle": "RD-TEST-1"
}
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

Responses Code 404

不存在运单包含此 blockId 时
json
{
    "code": 50002,
    "create_on": "2022-05-09T19:10:37.459Z",
    "msg": "order details by block id is empty"		// 不存在任何运单包含该 blockId
}
1
2
3
4
5
最近更新 2022/11/28
文章内容

接口介绍

请求

路径参数

请求示例

查询包含动作块 b1 的运单状态

响应

响应数据

响应数据示例

Responses Code 200

Responses Code 404