|
@@ -427,380 +427,6 @@ https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c
|
|
|
|**orderMatchUpList** <br>*必填*|撮合运单列表,单次最多50个 <br>**长度** : `1 - 50`|< [撮合运单](#撮合运单) > array|
|
|
|
|**organizationName** <br>*可选*|组织机构名称,会创建至对应组织机构下,默认创建到总部|string|
|
|
|
|
|
|
-
|
|
|
-## 接口简介:
|
|
|
-
|
|
|
-本文档为网络货运开放接口文档,对接流程为:
|
|
|
-1. 注册并开通网络货运账号(正式环境账号联系我司实施或者商务获取);
|
|
|
-2. 使用网络货运的账号密码获取接口访问令牌(accessToken);
|
|
|
-3. 使用`accessToken`调用其他接口;
|
|
|
-
|
|
|
-**请使用主账号获取对应的token再调用其他接口!!!**
|
|
|
-
|
|
|
-## 相关说明(请仔细阅读!):
|
|
|
-1. **什么是主账号**:<br>即贵公司在我们系统中创建的第一个账号,其后所有的贵公司系统中的账号都是子账号。如果不知道自己是否使用的主账号或者主账号具体是哪个请联系相关负责人。
|
|
|
-
|
|
|
-2. **接口统一URL地址**:<br>测试环境=https://openapi.wlhy.ali.56fanyun.com ,正式环境=https://openapi.wlhy.56fanyun.com
|
|
|
-
|
|
|
-3. **测试环境系统地址**:<br>https://wlhy.ali.56fanyun.com
|
|
|
-
|
|
|
-4. **测试环境账号**:<br>联系我司对接负责人获取。账号并不互通,测试账号对应的是测试环境的域名,正式环境无法使用!
|
|
|
-
|
|
|
-5. **调用接口方式**:<br>`URL` + `?access_token=生成的token`,参数传递使用JSON格式。
|
|
|
-`Content-Type: application/json;charset=UTF-8`。例:
|
|
|
-https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-848c-d08a885095a5
|
|
|
-**请勿将请求参数拼接在URL中传递!**
|
|
|
-
|
|
|
-6. **调试接口**:<br>推荐使用Postman,或者访问接口URL,会跳转至调试界面
|
|
|
-
|
|
|
-7. **时间格式**:<br>如无特殊说明,接口中所有时间均使用时间戳,精确到秒
|
|
|
-
|
|
|
-8. **调用限制**:<br>为防止恶意攻击和滥用,接口都加上了调用限制,不同接口限制不同,请参考接口中调用限制的相关说明。例:60次/分钟,表示一分钟内最多请求60次,超过限制会拒绝请求,返回`操作太频繁`。
|
|
|
-
|
|
|
-9. **状态码**:
|
|
|
-
|
|
|
-|状态码|说明|
|
|
|
-|:---:|---|
|
|
|
-|200|调用接口成功|
|
|
|
-|401|授权失败,需要重新登陆获取access_token|
|
|
|
-|404|接口不存在,请检查调用的接口地址,协议的格式是否正确|
|
|
|
-|500|服务异常,具体错误原因会在返回结果中说明|
|
|
|
-
|
|
|
-10. **返回字段**:
|
|
|
-
|
|
|
-|名称|说明|
|
|
|
-|:---:|---|
|
|
|
-|code|状态码|
|
|
|
-|data|返回数据,接口调用成功(状态码为 200)之后返回的数据|
|
|
|
-|message|错误信息,当接口调用失败(状态码为 非200)时,返回的错误信息,调用成功时返回null|
|
|
|
-
|
|
|
-
|
|
|
-# 接口凭证
|
|
|
-
|
|
|
-## 获取登陆凭证接口
|
|
|
-
|
|
|
-**简要描述:** 获取登陆凭证,accessToken有效期`72小时`,refreshToken有效期`100天`,有效期内获取token返回的结果一样,accessToken到期后建议使用refreshToken进行刷新,而不是使用用户名密码重新获取
|
|
|
-
|
|
|
-**请求 URL:** `/user/generate_access_token`
|
|
|
-
|
|
|
-**请求方式:** POST
|
|
|
-
|
|
|
-**需要AccessToken:** 否
|
|
|
-
|
|
|
-**调用限制:** 60次/分钟
|
|
|
-
|
|
|
-**请求参数:**
|
|
|
-
|
|
|
-|名称|说明|类型|
|
|
|
-|---|---|---|
|
|
|
-|**userName** <br>*必填*|账号|string|
|
|
|
-|**password** <br>*必填*|密码|string|
|
|
|
-
|
|
|
-**返回示例**
|
|
|
-
|
|
|
-- 调用成功示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 200,
|
|
|
- "message": null,
|
|
|
- "data": {
|
|
|
- "accessToken": "9d0dfe02-2349-421c-90ec-4b9ea174701b",
|
|
|
- "refreshToken": "9f8326bc-c29f-4a28-a512-26caa1a9850a"
|
|
|
- }
|
|
|
-}
|
|
|
-```
|
|
|
-- 调用失败示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 500,
|
|
|
- "message": "账号或密码不正确"
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-## 更新登陆凭证接口
|
|
|
-
|
|
|
-**简要描述:** 更新登陆凭证,会同时更新accessToken和refreshToken,更新后原accessToken和refreshToken将失效
|
|
|
-
|
|
|
-**请求 URL:** `/user/refresh_access_token`
|
|
|
-
|
|
|
-**请求方式:** POST
|
|
|
-
|
|
|
-**需要AccessToken:** 否
|
|
|
-
|
|
|
-**调用限制:** 60次/分钟
|
|
|
-
|
|
|
-**请求参数:**
|
|
|
-
|
|
|
-|名称|说明|类型|
|
|
|
-|---|---|---|
|
|
|
-|**userName** <br>*必填*|账号|string|
|
|
|
-|**refreshToken** <br>*必填*|刷新凭证|string|
|
|
|
-
|
|
|
-**返回示例**
|
|
|
-
|
|
|
-- 调用成功示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 200,
|
|
|
- "message": null,
|
|
|
- "data": {
|
|
|
- "accessToken": "9d0dfe02-2349-421c-90ec-4b9ea174701b",
|
|
|
- "refreshToken": "9f8326bc-c29f-4a28-a512-26caa1a9850a"
|
|
|
- }
|
|
|
-}
|
|
|
-```
|
|
|
-- 调用失败示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 500,
|
|
|
- "message": "账号或刷新凭证不正确"
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-
|
|
|
-# 运单类接口
|
|
|
-
|
|
|
-## 创建运单接口
|
|
|
-
|
|
|
-**简要描述:** 开单
|
|
|
-
|
|
|
-**请求 URL:** `/order/create_order`
|
|
|
-
|
|
|
-**请求方式:** POST
|
|
|
-
|
|
|
-**需要AccessToken:** 是
|
|
|
-
|
|
|
-**调用限制:** 3次/秒
|
|
|
-
|
|
|
-**请求参数:**
|
|
|
-
|
|
|
-|名称|说明|类型|
|
|
|
-|---|---|---|
|
|
|
-|**orders** <br>*必填*|运单列表,一次最多50单 <br>**长度** : `1 - 50`|< [运单](#运单) > array|
|
|
|
-|**organizationName** <br>*可选*|组织机构名称,会创建至对应组织机构下,默认创建到总部|string|
|
|
|
-
|
|
|
-**返回示例**
|
|
|
-
|
|
|
-- 调用成功示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 200,
|
|
|
- "data": ["S2004221802969563"],
|
|
|
- "message": null
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-- 调用失败示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 500,
|
|
|
- "message": "订单创建失败"
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-
|
|
|
-## 更新运单接口
|
|
|
-
|
|
|
-**简要描述:** 更新运单
|
|
|
-
|
|
|
-**请求 URL:** `/order/update_order`
|
|
|
-
|
|
|
-**请求方式:** POST
|
|
|
-
|
|
|
-**需要AccessToken:** 是
|
|
|
-
|
|
|
-**调用限制:** 3次/秒
|
|
|
-
|
|
|
-**请求参数:**
|
|
|
-
|
|
|
-请参考:[运单](#运单)
|
|
|
-
|
|
|
-**返回示例**
|
|
|
-
|
|
|
-- 调用成功示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 200,
|
|
|
- "data": true,
|
|
|
- "message": null
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-- 调用失败示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 500,
|
|
|
- "message": "xxxxxxxx"
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-
|
|
|
-## 签收运单接口
|
|
|
-
|
|
|
-**简要描述:** 签收运单
|
|
|
-
|
|
|
-**请求 URL:** `/order/signOff_order`
|
|
|
-
|
|
|
-**请求方式:** POST
|
|
|
-
|
|
|
-**需要AccessToken:** 是
|
|
|
-
|
|
|
-**调用限制:** 3次/秒
|
|
|
-
|
|
|
-**请求参数:**
|
|
|
-
|
|
|
-|名称|说明|类型|
|
|
|
-|---|---|---|
|
|
|
-|**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/query_order`
|
|
|
-
|
|
|
-**请求方式:** POST
|
|
|
-
|
|
|
-**需要AccessToken:** 是
|
|
|
-
|
|
|
-**调用限制:** 5次/秒
|
|
|
-
|
|
|
-**请求参数:**
|
|
|
-
|
|
|
-|名称|说明|类型|
|
|
|
-|---|---|---|
|
|
|
-|**page** <br>*必填*|当前页 <br>**最小值** : `1` <br>**最大值** : `1000`|string|
|
|
|
-|**size** <br>*必填*|单页数量 <br>**最小值** : `1` <br>**最大值** : `50`|string|
|
|
|
-|**orderNumbers** <br>*可选*|运单号列表,一次最多50单 <br>**长度** : `1 - 50`|< string > array|
|
|
|
-|**timeType** <br>*可选*|时间类型 <br>**取值** : `created(创建时间),opened(开单时间),signed(完成时间),arrivedTime(到达时间),appointArriveTime(预约送达时间)`|string|
|
|
|
-|**beginDate** <br>*可选*|开始时间 <br>**格式** : `yyyy-MM-dd HH:mm:ss`|string|
|
|
|
-|**endDate** <br>*可选*|结束时间 <br>**格式** : `yyyy-MM-dd HH:mm:ss`|string|
|
|
|
-|**originalOrderNumber** <br>*可选*|客户单号,支持模糊搜索|string|
|
|
|
-|**startAddress** <br>*可选*|起始地 <br>**长度** : `0 - 20`|string|
|
|
|
-|**endAddress** <br>*可选*|目的地 <br>**长度** : `0 - 20`|string|
|
|
|
-|**consignerName** <br>*可选*|发货方姓名 <br>**长度** : `0 - 45`|string|
|
|
|
-|**consignerPhone** <br>*可选*|发货方电话 <br>**长度** : `0 - 20`|string|
|
|
|
-|**consigneeName** <br>*可选*|收货方姓名 <br>**长度** : `0 - 45`|string|
|
|
|
-|**consigneePhone** <br>*可选*|收货方电话 <br>**长度** : `0 - 20`|string|
|
|
|
-
|
|
|
-**返回示例**
|
|
|
-
|
|
|
-- 调用成功示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 200,
|
|
|
- "message": null,
|
|
|
- "data": {
|
|
|
- "page": 1, //当前页
|
|
|
- "size": 10, //当页数量
|
|
|
- "total": 3, //返回数据总数
|
|
|
- "totalPagesCount": 1, //总页数
|
|
|
- "elements": [....] //运单数据
|
|
|
- }
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-- 调用失败示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 500,
|
|
|
- "message": "xxxxxxxx"
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-
|
|
|
-## 撤销运单接口
|
|
|
-
|
|
|
-**简要描述:** 撤销运单
|
|
|
-
|
|
|
-**请求 URL:** `/order/cancel_order`
|
|
|
-
|
|
|
-**请求方式:** POST
|
|
|
-
|
|
|
-**需要AccessToken:** 是
|
|
|
-
|
|
|
-**调用限制:** 3次/秒
|
|
|
-
|
|
|
-**请求参数:**
|
|
|
-
|
|
|
-|名称|说明|类型|
|
|
|
-|---|---|---|
|
|
|
-|**orderNumbers** <br>*必填*|运单号列表,一次最多50单 <br>**长度** : `1 - 50`|< string > array|
|
|
|
-
|
|
|
-**返回示例**
|
|
|
-
|
|
|
-- 调用成功示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 200,
|
|
|
- "data": true,
|
|
|
- "message": null
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-- 调用失败示例
|
|
|
-
|
|
|
-```java
|
|
|
-{
|
|
|
- "code": 500,
|
|
|
- "message": "xxxxxxxx"
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-## 创建运单接口(撮合)
|
|
|
-
|
|
|
-**简要描述:** 撮合开单
|
|
|
-
|
|
|
-**请求 URL:** `/order_match_up/create_order_match_up`
|
|
|
-
|
|
|
-**请求方式:** POST
|
|
|
-
|
|
|
-**需要AccessToken:** 是
|
|
|
-
|
|
|
-**调用限制:** 3次/秒
|
|
|
-
|
|
|
-**请求参数:**
|
|
|
-
|
|
|
-|名称|说明|类型|
|
|
|
-|---|---|---|
|
|
|
-|**orderMatchUpList** <br>*必填*|撮合运单列表,单次最多50个 <br>**长度** : `1 - 50`|< [撮合运单](#撮合运单) > array|
|
|
|
-|**organizationName** <br>*可选*|组织机构名称,会创建至对应组织机构下,默认创建到总部|string|
|
|
|
-
|
|
|
**返回示例**
|
|
|
|
|
|
- 调用成功示例
|