Browse Source

新增接口

gmw 4 years ago
parent
commit
e8f1650a97
1 changed files with 124 additions and 0 deletions
  1. 124 0
      README.md

+ 124 - 0
README.md

@@ -12,6 +12,9 @@
     - [更新登陆凭证接口](#%E6%9B%B4%E6%96%B0%E7%99%BB%E9%99%86%E5%87%AD%E8%AF%81%E6%8E%A5%E5%8F%A3)
 - [运单类接口](#%E8%BF%90%E5%8D%95%E7%B1%BB%E6%8E%A5%E5%8F%A3)
     - [创建运单接口](#%E5%88%9B%E5%BB%BA%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
+    - [更新运单接口](#%E6%9B%B4%E6%96%B0%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
+    - [签收运单接口](#%E7%AD%BE%E6%94%B6%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
+    - [撤销运单接口](#%E6%92%A4%E9%94%80%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
 - [基础信息类接口](#%E5%9F%BA%E7%A1%80%E4%BF%A1%E6%81%AF%E7%B1%BB%E6%8E%A5%E5%8F%A3)
     - [批量创建司机接口](#%E6%89%B9%E9%87%8F%E5%88%9B%E5%BB%BA%E5%8F%B8%E6%9C%BA%E6%8E%A5%E5%8F%A3)
     - [修改司机信息接口](#%E4%BF%AE%E6%94%B9%E5%8F%B8%E6%9C%BA%E4%BF%A1%E6%81%AF%E6%8E%A5%E5%8F%A3)
@@ -214,6 +217,126 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 ```
 
 
+## 更新运单接口
+
+**简要描述:** 更新运单
+
+**请求 URL:** `/order/update_order`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 10000次/小时
+
+**请求参数:**
+
+请参考:[运单](#运单)
+
+**返回示例**
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+
+## 签收运单接口
+
+**简要描述:** 签收运单
+
+**请求 URL:** `/order/signOff_order`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 10000次/小时
+
+**请求参数:**
+
+|名称|说明|类型|
+|---|---|---|
+|**orderNumbers**  <br>*必填*|运单号列表,一次最多50单  <br>**长度** : `1 - 50`|< string > array|
+|**signer**  <br>*选填*|签收人  <br>**长度** : `0 - 20`|string|
+|**signTime**  <br>*选填*|签收时间,时间戳,精确到秒|integer (int32)|
+
+**返回示例**
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+
+## 撤销运单接口
+
+**简要描述:** 撤销运单
+
+**请求 URL:** `/order/cancel_order`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 10000次/小时
+
+**请求参数:**
+
+|名称|说明|类型|
+|---|---|---|
+|**orderNumbers**  <br>*必填*|运单号列表,一次最多50单  <br>**长度** : `1 - 50`|< string > array|
+
+**返回示例**
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+
 # 基础信息类接口
 
 ## 批量创建司机接口
@@ -605,6 +728,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 
 |名称|说明|类型|
 |---|---|---|
+|**orderNumber**  <br>*更新运单时必填*|运单号,更新运单时必填,创建运单时不需要填写|string|
 |**originalOrderNumber**  <br>*必填*|客户单号  <br>**长度** : `1 - 50`|string|
 |**businessType**  <br>*必填*|业务类型|enum (干线普货运输, 城市配送, 农村配送, 集装箱运输, 其他)|
 |**carrier**  <br>*必填*|承运人|[承运人](#承运人)|