|
@@ -11,7 +11,6 @@
|
|
|
- [查询订单接口](#查询订单接口)
|
|
|
- [批量查询订单接口](#批量查询订单接口)
|
|
|
- [撤销订单接口](#撤销订单接口)
|
|
|
-- [撤销订单接口v2](#撤销订单接口v2)
|
|
|
- [创建车次接口](#创建车次接口)
|
|
|
- [更新批次接口](#更新批次接口)
|
|
|
- [创建数据看板接口](#创建数据看板接口)
|
|
@@ -20,7 +19,6 @@
|
|
|
- [修改订单货物接口](#修改订单货物接口)
|
|
|
- [删除订单货物接口](#删除订单货物接口)
|
|
|
- [订单订阅接口](#订单订阅接口)
|
|
|
-- [订单订阅接口v2](#订单订阅接口v2)
|
|
|
- [取消订单订阅接口](#取消订单订阅接口)
|
|
|
- [车次订阅接口](#车次订阅接口)
|
|
|
- [取消车次订阅接口](#取消车次订阅接口)
|
|
@@ -544,44 +542,10 @@
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-
|
|
|
## 撤销订单接口
|
|
|
|
|
|
**简要描述:** 批量撤销订单
|
|
|
|
|
|
-**请求 URL:** `/order/cancel_orders`
|
|
|
-
|
|
|
-**请求方式:** POST, GET form提交
|
|
|
-
|
|
|
-**需要认证:** 是
|
|
|
-
|
|
|
-**请求参数:**
|
|
|
-
|
|
|
-| 参数名 | 必选 | 类型 | 说明 |
|
|
|
-|:----:|:---:|:-----:|:-----:|
|
|
|
-| `numbers` | 是 | `string` | 订单number列表,多个订单用','隔开 |
|
|
|
-
|
|
|
-**返回示例**
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 200,
|
|
|
- "message": null
|
|
|
-}
|
|
|
-```
|
|
|
-- 调用失败示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "status": 500,
|
|
|
- "message": "撤销订单失败原因"
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-## 撤销订单接口v2
|
|
|
-
|
|
|
-**简要描述:** 批量撤销订单v2
|
|
|
-
|
|
|
**请求 URL:** `/order/cancel_orders/v2`
|
|
|
|
|
|
**请求方式:** POST, GET
|
|
@@ -909,67 +873,6 @@
|
|
|
|
|
|
## 订单订阅接口
|
|
|
|
|
|
-**简要描述:** 订单订阅,请使用v2接口
|
|
|
-
|
|
|
-**请求 URL:** `/order/subscribe`
|
|
|
-
|
|
|
-**请求方式:** POST, form提交
|
|
|
-
|
|
|
-**需要认证:** 是
|
|
|
-
|
|
|
-**请求参数:**
|
|
|
-
|
|
|
-| 参数名 | 必选 | 类型 | 说明 |
|
|
|
-|:----:|:---:|:-----:|:-----:|
|
|
|
-| `states` | 否 | `String` | 需要订阅的订单状态,0:已撤销,1:已下单,2:已接单,3:已装货,4:已签收;支持多选,多个状态之间用','隔开 |
|
|
|
-| `callbackUrl` | 是 | `String` | 回调地址,以http://或https://开头,支持每个用户使用不同的回调地址 |
|
|
|
-| `version` | 是 | `String` | 版本号,v1 |
|
|
|
-| `resultFormat` | 否 | `String` | 返回报文格式,默认是json的,可选项json,form |
|
|
|
-| `signMode` | 否 | `String` | 签名方式,v1 |
|
|
|
-| `appKey` | 否 | `String` | 签名appKey,signMode不为空时必填 |
|
|
|
-| `appSecret` | 否 | `String` | 签名appSecret,signMode不为空时必填 |
|
|
|
-| `method` | 否 | `String` | 签名method,signMode不为空时必填 |
|
|
|
-
|
|
|
-**返回示例**
|
|
|
-
|
|
|
-- 调用成功示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 200,
|
|
|
- "message": null
|
|
|
-}
|
|
|
-```
|
|
|
-- 调用失败示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "status": 500,
|
|
|
- "message": ""
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-- 订单订阅返回报文:
|
|
|
-```java
|
|
|
-{
|
|
|
- "number ": "1609171412804505", /*订单号*/
|
|
|
- "wmsNumber": "wmsNumber", /*出库单号*/
|
|
|
- "customerOrderNumber": "111111", /*客户单号*/
|
|
|
- "packNumber": "P20170805094004f32c20dd", /*车次号*/
|
|
|
- "remark": "xx 订单已签收", /*订单日志*/
|
|
|
- "state": 1, /*订单状态*/
|
|
|
- "driver": "某司机", /*司机名称*/
|
|
|
- "carNumber": "浙A12345", /*车牌号码*/
|
|
|
- "phoneNumber": "13812345678" /*司机电话*/
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-### **注意事项**
|
|
|
-
|
|
|
-回调地址的返回结果中,如果成功要在返回信息中包含"code": 200,系统会根据这个值来判断消息是否投递成功,否则会重新进行投递
|
|
|
-
|
|
|
-## 订单订阅接口v2
|
|
|
-
|
|
|
**简要描述:** 订单订阅
|
|
|
|
|
|
**请求 URL:** `/order/subscribe/v2`
|
|
@@ -984,12 +887,8 @@
|
|
|
|:----:|:---:|:-----:|:-----:|
|
|
|
| `states` | 否 | `String` | 需要订阅的订单状态,0:已撤销,1:已下单,2:已接单,3:已装货,4:已签收;支持多选,多个状态之间用','隔开 |
|
|
|
| `callbackUrl` | 是 | `String` | 回调地址,以http://或https://开头,支持每个用户使用不同的回调地址 |
|
|
|
-| `version` | 是 | `String` | 版本号,v1 |
|
|
|
| `resultFormat` | 否 | `String` | 返回报文格式,默认是json的,可选项json,form |
|
|
|
-| `signMode` | 否 | `String` | 签名方式,v1 |
|
|
|
-| `appKey` | 否 | `String` | 签名appKey,signMode不为空时必填 |
|
|
|
-| `appSecret` | 否 | `String` | 签名appSecret,signMode不为空时必填 |
|
|
|
-| `method` | 否 | `String` | 签名method,signMode不为空时必填 |
|
|
|
+
|
|
|
|
|
|
**返回示例**
|
|
|
|
|
@@ -1006,7 +905,7 @@
|
|
|
```java
|
|
|
{
|
|
|
"status": 500,
|
|
|
- "message": ""
|
|
|
+ "message": ""
|
|
|
}
|
|
|
```
|
|
|
|
|
@@ -1024,15 +923,12 @@
|
|
|
"phoneNumber": "13812345678", /*司机电话*/
|
|
|
"groupName": "xx运输队", /*车队*/
|
|
|
"receiptUrls":["http://oss.kuaihuoyun.com/1.png","http://oss.kuaihuoyun.com/2.png"] /*回单照片*/
|
|
|
- "abnormal":true, /*是否异常*/
|
|
|
- "signer":"签收人",
|
|
|
- "note":"异常原因"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
### **注意事项**
|
|
|
|
|
|
-回调地址的返回结果中,如果成功要在返回信息中包含"code": 200,系统会根据这个值来判断消息是否投递成功,否则会重新进行投递
|
|
|
+回调地址的返回结果需要为json格式,如果成功要在返回信息中包含"code": 200,系统会根据这个值来判断消息是否投递成功,否则会重新进行投递
|
|
|
|
|
|
## 取消订单订阅接口
|
|
|
|
|
@@ -1084,12 +980,8 @@
|
|
|
|:----:|:---:|:-----:|:-----:|
|
|
|
| `states` | 否 | `String` | 需要订阅的车次状态,19000:删除/撤销车次,40000:指派车次,40001:更新车次;支持多选,多个状态之间用','隔开 |
|
|
|
| `callbackUrl` | 是 | `String` | 回调地址,以http://或https://开头,支持每个用户使用不同的回调地址 |
|
|
|
-| `version` | 否 | `String` | 版本号,v1 |
|
|
|
| `resultFormat` | 否 | `String` | 返回报文格式,默认是json的,可选项json,form |
|
|
|
-| `signMode` | 否 | `String` | 签名方式,v1 |
|
|
|
-| `appKey` | 否 | `String` | 签名appKey,signMode不为空时必填 |
|
|
|
-| `appSecret` | 否 | `String` | 签名appSecret,signMode不为空时必填 |
|
|
|
-| `method` | 否 | `String` | 签名method,signMode不为空时必填 |
|
|
|
+
|
|
|
|
|
|
**返回示例**
|
|
|
|