# 接口说明
- 1.查询外卖订单列表接口 通过该接口可以查询企业使用分贝通APP下的外卖订单信息
- 2.该接口一次最多可查询50条数据,如订单数超过50,则需要分页查询
| 名称 | 描述 |
|---|---|
| HTTP方法 | POST |
| Content-Type | application/x-www-form-urlencoded |
| method | /openapi/func/orders/takeaway/list |
| 字段 | 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| timestamp | 时间戳 | long | Y | 13位时间戳 |
| sign | 签名 | string | Y | gaghegsgd535te3534 |
| access_token | token | string | Y | 登录 token |
| employee_id | 操作人id | string | Y | 操作人id,调用接口人 id |
| employee_type | 用户类型 | string | Y | 类型,0为分贝用户,1为第三方用户 |
| data | 请求数据 | jsonobject | N | |
| data.order_id | 订单编号 | string | N | 订单编号精准匹配 |
| data.status | 订单状态 | int | N | 订单状态详见14.14 外卖状态码表 |
| data.page_index | 起始页 | int | N | 默认为1 |
| data.page_size | 每页显示的条数 | int | N | 默认为30 最大为500 |
| data.user_name | 下单人电话 | string | N | 下单人电话 |
| data.user_phone | 下单人名字 | string | N | 下单人名字 |
| data.consignee_name | 消费人的名字 | string | N | 消费人的名字 |
| data.create_time_begin | 订单的开始时间 | string | N | 订单的开始时间/订单创建时间 格式:"2020-05-27 15:43:23" |
| data.create_time_end | 订单的结束时间 | string | N | 格式:"2020-05-29 20:43:23" |
| data.order_type | 订单类别 | integer | N | 1:因公 2:因私 |
请求示例:
"access_token":"5747fbc10f0e60e0709d8d722",
"sign":"oihfnlyeofdh98",
"timestamp":124124325,
"employee_id":"59b74c1323445f2d54dd07922",
"employee_type":"1",
"data":{"order_id":"OTA202007171639074190420","status":700, "user_name":"闵文超","user_phone":"13261635230", "create_time_begin":"2020-07-17 15:43:23", "create_time_end":"2020-07-17 20:43:23","consignee_name":"米", "page_index":1,"page_size":10}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
响应结果示例:
# 响应数据:
| 字段 | 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 响应码 | integer | Y | 0:成功;1:失败 |
| msg | 响应信息 | string | N | success |
| data | 响应数据 | jsonObject | N | |
| data.total_count | 总行数 | integer | Y | 1 3 |
| data.total_pages | 总页数 | integer | Y | 1 |
| data.page_index | 当前页码 | integer | Y | 1 |
| data.page_size | 每页大小 | integer | Y | 10 |
| data.results | 订单列表 | jsonArray | N |
# 订单列表results:
| 字段 | 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| results.order_info | 订单信息 | jsonobject | Y | 订单信息 |
| results.user_info | 下单人信息 | jsonobject | Y | 下单人信息 |
| results.price_info | 订单金额信息 | jsonobject | Y | 订单金额信息 |
| results.consignee_info | 消费者信息 | jsonobject | Y | 消费者信息 |
# 订单信息order_info:
| 字段 | 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| order_id | 订单编号 | string | Y | OMS202004291108520124863 |
| supplier_order_id | 三方订单Id | string | Y | 三方订单Id |
| restaurant_name | 外卖店名称 | string | Y | 外卖店名称 |
| order_create_time | 创建时间 | string | Y | 2020-04-29 11:08:52 |
| status | 状态码 | integer | Y | 700 |
| status_name | 状态名称 | string | Y | 已完成 |
| supplier_name | 供应商名称 | string | Y | 曹操 |
# 下单人信息user_info:
| 字段 | 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | 下单人id | string | Y | 5d70ba9b23445f04bc031156 |
| name | 下单人姓名 | string | Y | 强仔 |
| phone | 下单人手机号 | integer | Y | 18310480640 |
# 订单金额信息price_info:
| 字段 | 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| total_price | 订单总金额 | double | Y | 1 |
# 消费者信息 consignee_info:
| 字段 | 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| consignee_info | 消费者信息 | jsonobject | Y | |
| consignee_info.name | 消费者名称 | string | Y | 消费者名称 |
| consignee_info.phone | 消费者手机号 | string | Y | 消费者手机号 |
| consignee_info.address | 消费者地址 | string | Y | 消费者地址 |
| consignee_info.city | 消费者城市 | string | Y | 消费者城市 |
# 三方信息third_info:
| 字段 | 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| user_id | 三方员工id | string | N | 三方员工id |
| dept_id | 三方部门id | string | N | 三方部门id |
| apply_id | 外卖审批id | string | N | 外卖审批id |
{
"code": 0,
"msg": "success",
"data": {
"total_count": 1,
"page_index": 1,
"total_pages": 1,
"results": [{
"order_info": {
"order_id": "OTA202007151733474134720",
"status": 81,
"status_name": "已关闭",
"supplier_order_id": "2130112381131912387",
"restaurant_name": "仔皇煲煲仔饭(世贸天阶店)",
"supplier_name": "饿了么",
"create_time": "2020-07-15 17:33:47"
},
"price_info": {
"total_price": 41.0
},
"user_info": {
"id": "5afba91523445f22dd043d92",
"name": "闵文超",
"phone": "13261635230"
},
"consignee_info": {
"name": "米**",
"phone": "132****5230",
"address": "北京市朝阳区呼家楼街道东大桥路小区(秀水社区北)润****",
"city": "北京市"
},
"third_info": {
"user_id": "23122222222112",
"dept_id": "146f0295-fbbc-4448-b9ec-c6dc171de573",
"apply_id": "263487264872"
}
}],
"page_size": 10
},
"request_id": "JCnGfEmV6eIoO4ti"
}
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43