feat: 添加希音订单接口v8

王富国
1 parent c4cc9bd3
Showing 1 changed file with 134 additions and 6 deletions Show diff stats
order/truck/shein/order.md
@@ -131,7 +131,7 @@ public class Sample {
 }
 ```
  
-#### 下单
+#### 创建订单
  
 ##### 接口信息
  
@@ -226,7 +226,7 @@ public class Sample {
     public static void main(String[] args_) {
         String appKey = "appkey";
         String appSecret = "appSecret";
-        String jsonData = "下单Body参数JSON数据";
+        String jsonData = "创建订单Body参数JSON数据";
         ZYClient zyClient = new ZYClient(appKey, appSecret);
         HttpResponseData httpResponseData = 
 zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/shein/add", "accessToken", jsonData);
@@ -257,6 +257,136 @@ zyClient.doPost(Constants.TEST_HOST + &quot;/oms-service-api/shein/add&quot;, &quot;accessToken
 }
 ```
  
+
+
+#### 修改订单
+
+##### 接口信息
+
+###### 请求方式：
+
+post
+
+###### 请求地址：
+
+* 生产：https://gw.shjiuze.cn/oms-service-api/shein/modify
+* 测试：https://test.shjiuze.cn/oms-service-api/shein/modify
+
+###### Headers参数
+
+| 名称          | 类型   | 必填                       | 示例值                           | 描述                                                         |
+| ------------- | ------ | -------------------------- | -------------------------------- | ------------------------------------------------------------ |
+| Authorization | String | 是&nbsp;&nbsp;&nbsp;&nbsp; | Bearer a2c5680001                | 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。 |
+| appKey        | String | 是                         | 0867ef5f23ef6483749e19e1692b     | 则一提供                                                     |
+| timestamp     | String | 是                         | 1643251533306                    | 当前时间戳毫秒值                                             |
+| nonce         | String | 是                         | gdst9t                           | 6位小写字母数字组合随机串                                    |
+| sign          | String | 是                         | fa3ed338d6dfe18e7273c8692234ee70 | 签名：appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 |
+
+###### Body参数(跟创建任务单一致)
+
+| 名称                | 类型     | 必填 | 示例值                            | 描述                                                         |
+| ------------------- | -------- | ---- | --------------------------------- | ------------------------------------------------------------ |
+| customerOrderCode   | String   | 是   | ZY230101000000001                 | 任务编号                                                     |
+| customerSn          | String   | 否   | 220101000001                      | 客户委托单号                                                 |
+| placeOrderTime      | Number   | 是   | 1643251533306                     | 创建时间，时间戳毫秒值                                       |
+| loadTime            | Number   | 是   | 1643251533306                     | 装货时间，时间戳毫秒值                                       |
+| expectArrivalTime   | Number   | 否   | 1643251533306                     | 期望送达时间，时间戳毫秒值                                   |
+| receiptType         | String   | 否   | ELECTRON_TYPE                     | 回单类型：ELECTRON_TYPE/电子回单,PAPER_TYPE/纸质回单,NONE/无 |
+| receiptNumber       | Number   | 否   | 1                                 | 回单张数                                                     |
+| receiptCode         | String   | 否   | A2022012602278                    | 回单号                                                       |
+| payType             | String   | 否   | PAY_IN_CASH                       | 付款方式：PAY_IN_CASH/现付,PAY_ON_DELIVERY/到付,PAY_ARREARS/欠付,PAY_MONTH/月结,PAY_BACK/回付,PAY_MULTIPLE/多笔付,PAY_FREE/免费 |
+| lineName            | String   | 否   | 上海-天津-北京                    | 线路名称                                                     |
+| demandVanType       | String   | 是   | MOTOR_VAN                         | 需求厢型：MOTOR_VAN/厢车,GAOLAN_VAN/高栏,SLAB_VAN/平板,REFRIGERATOR_CAR/冷藏,IVECO/依维柯,JINBEI/金杯,MINI_VAN/小面包,ELSE_VAN/其他 |
+| demandSpecification | String   | 是   | 9.6                               | 需求车型：2.7/3.8/4.2/6.8/7.6/9.6/11/12.5/13.5/15/16.5/17.5/19/21 |
+| demandNumber        | Number   | 否   | 1                                 | 为空则默认1                                                  |
+| vehicleDemand       | String   | 否   | 车辆需要带雨布和尾板              | 车辆要求描述                                                 |
+| remark              | String   | 否   | 全程高速,48h核酸,往返             | 订单备注                                                     |
+| loadAddress         | Object[] | 是   |                                   | 装货地址信息                                                 |
+| stationId           | String   | 是   | 11212abc                          | 园区id                                                       |
+| stationName         | String   | 是   | 高明新宜园区                      | 园区名称                                                     |
+| addressId           | String   | 是   | 123abc                            | 地址id                                                       |
+| addressName         | String   | 是   | 高明新宜园区-新宜6号仓-二楼18号门 | 装货地址名称                                                 |
+| lat                 | String   | 是   | 36.221825                         | 纬度(GPS坐标系：高德的，GCJ-02)                              |
+| lng                 | String   | 是   | 120.632908                        | 经度(GPS坐标系：高德的，GCJ-02)                              |
+| contactName         | String   | 否   | 张三                              | 联系人                                                       |
+| contactMobile       | String   | 否   | 18801000001                       | 联系人电话                                                   |
+| expectArrivalTime   | Number   | 否   | 1643251533306                     | 预计到达时间，时间戳毫秒值                                   |
+| expectDepartTime    | Number   | 否   | 1643251533306                     | 预计发车时间，时间戳毫秒值                                   |
+| sort                | Number   | 否   | 1                                 | 经停点顺序，如果不传则默认按数组顺序                         |
+| unloadAddress       | Object[] | 是   |                                   | 卸货地址信息                                                 |
+| stationId           | String   | 是   | 11212abc                          | 园区id                                                       |
+| stationName         | String   | 是   | 高明新宜园区                      | 园区名称                                                     |
+| addressId           | String   | 是   | 123abc                            | 地址id                                                       |
+| addressName         | String   | 是   | 高明新宜园区-新宜6号仓-二楼18号门 | 卸货地址名称                                                 |
+| lat                 | String   | 是   | 36.221825                         | 纬度(GPS坐标系：高德的，GCJ-02)                              |
+| lng                 | String   | 是   | 120.632908                        | 经度(GPS坐标系：高德的，GCJ-02)                              |
+| contactName         | String   | 否   | 李四                              | 联系人                                                       |
+| contactMobile       | String   | 否   | 18801000002                       | 联系人电话                                                   |
+| expectArrivalTime   | Number   | 否   | 1643251533306                     | 预计到达时间，时间戳毫秒值                                   |
+| expectDepartTime    | Number   | 否   | 1643251533306                     | 预计发车时间，时间戳毫秒值                                   |
+| sort                | Number   | 否   | 1                                 | 经停点顺序，如果不传则默认按数组顺序                         |
+| goods               | Object[] | 否   |                                   | 订单货物信息                                                 |
+| barCode             | String   | 否   | 21616162626                       | 商品条码                                                     |
+| skuId               | String   | 否   | 1223233536436                     | 商品sku_id                                                   |
+| name                | String   | 是   | 鞋子                              | 货物名称                                                     |
+| packageType         | String   | 否   |                                   | 包装规格                                                     |
+| piece               | Number   | 否   | 200                               | 件数                                                         |
+| weight              | Number   | 否   | 200000                            | 重量                                                         |
+| volume              | Number   | 否   | 50                                | 体积                                                         |
+| addService          | Object[] | 否   |                                   | 增值服务                                                     |
+| serviceType         | String   | 否   |                                   | 服务类型                                                     |
+| serviceName         | String   | 是   | 包装服务                          | 服务名称                                                     |
+| serviceDemand       | String   | 否   | 纸箱包装                          | 服务要求                                                     |
+| tags                | Object[] | 否   |                                   | 订单标签                                                     |
+| tagName             | String   | 是   | 易碎物品                          | 标签名称                                                     |
+| vehicleCode         | String   | 否   | 12313                             | 车辆编号                                                     |
+| vehicleLicenseNum   | String   | 否   | 沪DP2312                          | 车牌号                                                       |
+| driverCode          | String   | 否   | 123123                            | 司机编号                                                     |
+| driverName          | String   | 否   | 张三                              | 司机姓名                                                     |
+| driverMobile        | String   | 否   | 18801733666                       | 司机电话                                                     |
+
+##### 请求示例
+
+###### Java-sdk方式    [下载SDK](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar)
+
+```java
+public class Sample {
+    public static void main(String[] args_) {
+        String appKey = "appkey";
+        String appSecret = "appSecret";
+        String jsonData = "修改订单Body参数JSON数据";
+        ZYClient zyClient = new ZYClient(appKey, appSecret);
+        HttpResponseData httpResponseData = 
+zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/shein/modify", "accessToken", jsonData);
+        if(httpResponseData == null) {    
+            throw new BusinessException("则一请求失败,返回结果为空!");
+         }
+        if(httpResponseData.getStatus() == HttpURLConnection.HTTP_UNAUTHORIZED) {   
+        //重新获取token再次请求    
+        httpResponseData = zyClient.doPost(Constants.TEST_HOST + 
+        "/oms-service-api/shein/modify", "accessToken", jsonData);
+        }
+    }
+}
+```
+
+##### 返回示例
+
+```json
+{
+    "success": true,
+    "businessException": false,
+    "errorCode": null,
+    "message": null,
+    "result": {
+        "code": "则一订单号",
+        "customerOrderCode": "任务单号"
+    }
+}
+```
+
+
+
 #### 取消订单
  
 ##### 接口信息
@@ -335,8 +465,6 @@ zyClient.doPost(Constants.TEST_HOST + &quot;/oms-service-api/shein/cancel&quot;, &quot;accessTo
  
  
  
-### 2023-05-06更新日志
+### 2023-05-23更新日志
  
-- [x] 增加靠站签到接口
-- [x] 增加卸车确认接口
-- [x] 增加签收接口
 \ No newline at end of file
+- [x] 增加接口
 \ No newline at end of file
...	...	@@ -131,7 +131,7 @@ public class Sample {
131	131	}
132	132	```
133	133
134		-#### 下单
	134	+#### 创建订单
135	135
136	136	##### 接口信息
137	137
...	...	@@ -226,7 +226,7 @@ public class Sample {
226	226	public static void main(String[] args_) {
227	227	String appKey = "appkey";
228	228	String appSecret = "appSecret";
229		- String jsonData = "下单Body参数JSON数据";
	229	+ String jsonData = "创建订单Body参数JSON数据";
230	230	ZYClient zyClient = new ZYClient(appKey, appSecret);
231	231	HttpResponseData httpResponseData =
232	232	zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/shein/add", "accessToken", jsonData);
...	...	@@ -257,6 +257,136 @@ zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/shein/add", "accessToken
257	257	}
258	258	```
259	259
	260	+
	261	+
	262	+#### 修改订单
	263	+
	264	+##### 接口信息
	265	+
	266	+###### 请求方式：
	267	+
	268	+post
	269	+
	270	+###### 请求地址：
	271	+
	272	+* 生产：https://gw.shjiuze.cn/oms-service-api/shein/modify
	273	+* 测试：https://test.shjiuze.cn/oms-service-api/shein/modify
	274	+
	275	+###### Headers参数
	276	+
	277	+\| 名称 \| 类型 \| 必填 \| 示例值 \| 描述 \|
	278	+\| ------------- \| ------ \| -------------------------- \| -------------------------------- \| ------------------------------------------------------------ \|
	279	+\| Authorization \| String \| 是     \| Bearer a2c5680001 \| 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。 \|
	280	+\| appKey \| String \| 是 \| 0867ef5f23ef6483749e19e1692b \| 则一提供 \|
	281	+\| timestamp \| String \| 是 \| 1643251533306 \| 当前时间戳毫秒值 \|
	282	+\| nonce \| String \| 是 \| gdst9t \| 6位小写字母数字组合随机串 \|
	283	+\| sign \| String \| 是 \| fa3ed338d6dfe18e7273c8692234ee70 \| 签名：appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 \|
	284	+
	285	+###### Body参数(跟创建任务单一致)
	286	+
	287	+\| 名称 \| 类型 \| 必填 \| 示例值 \| 描述 \|
	288	+\| ------------------- \| -------- \| ---- \| --------------------------------- \| ------------------------------------------------------------ \|
	289	+\| customerOrderCode \| String \| 是 \| ZY230101000000001 \| 任务编号 \|
	290	+\| customerSn \| String \| 否 \| 220101000001 \| 客户委托单号 \|
	291	+\| placeOrderTime \| Number \| 是 \| 1643251533306 \| 创建时间，时间戳毫秒值 \|
	292	+\| loadTime \| Number \| 是 \| 1643251533306 \| 装货时间，时间戳毫秒值 \|
	293	+\| expectArrivalTime \| Number \| 否 \| 1643251533306 \| 期望送达时间，时间戳毫秒值 \|
	294	+\| receiptType \| String \| 否 \| ELECTRON_TYPE \| 回单类型：ELECTRON_TYPE/电子回单,PAPER_TYPE/纸质回单,NONE/无 \|
	295	+\| receiptNumber \| Number \| 否 \| 1 \| 回单张数 \|
	296	+\| receiptCode \| String \| 否 \| A2022012602278 \| 回单号 \|
	297	+\| payType \| String \| 否 \| PAY_IN_CASH \| 付款方式：PAY_IN_CASH/现付,PAY_ON_DELIVERY/到付,PAY_ARREARS/欠付,PAY_MONTH/月结,PAY_BACK/回付,PAY_MULTIPLE/多笔付,PAY_FREE/免费 \|
	298	+\| lineName \| String \| 否 \| 上海-天津-北京 \| 线路名称 \|
	299	+\| demandVanType \| String \| 是 \| MOTOR_VAN \| 需求厢型：MOTOR_VAN/厢车,GAOLAN_VAN/高栏,SLAB_VAN/平板,REFRIGERATOR_CAR/冷藏,IVECO/依维柯,JINBEI/金杯,MINI_VAN/小面包,ELSE_VAN/其他 \|
	300	+\| demandSpecification \| String \| 是 \| 9.6 \| 需求车型：2.7/3.8/4.2/6.8/7.6/9.6/11/12.5/13.5/15/16.5/17.5/19/21 \|
	301	+\| demandNumber \| Number \| 否 \| 1 \| 为空则默认1 \|
	302	+\| vehicleDemand \| String \| 否 \| 车辆需要带雨布和尾板 \| 车辆要求描述 \|
	303	+\| remark \| String \| 否 \| 全程高速,48h核酸,往返 \| 订单备注 \|
	304	+\| loadAddress \| Object[] \| 是 \| \| 装货地址信息 \|
	305	+\| stationId \| String \| 是 \| 11212abc \| 园区id \|
	306	+\| stationName \| String \| 是 \| 高明新宜园区 \| 园区名称 \|
	307	+\| addressId \| String \| 是 \| 123abc \| 地址id \|
	308	+\| addressName \| String \| 是 \| 高明新宜园区-新宜6号仓-二楼18号门 \| 装货地址名称 \|
	309	+\| lat \| String \| 是 \| 36.221825 \| 纬度(GPS坐标系：高德的，GCJ-02) \|
	310	+\| lng \| String \| 是 \| 120.632908 \| 经度(GPS坐标系：高德的，GCJ-02) \|
	311	+\| contactName \| String \| 否 \| 张三 \| 联系人 \|
	312	+\| contactMobile \| String \| 否 \| 18801000001 \| 联系人电话 \|
	313	+\| expectArrivalTime \| Number \| 否 \| 1643251533306 \| 预计到达时间，时间戳毫秒值 \|
	314	+\| expectDepartTime \| Number \| 否 \| 1643251533306 \| 预计发车时间，时间戳毫秒值 \|
	315	+\| sort \| Number \| 否 \| 1 \| 经停点顺序，如果不传则默认按数组顺序 \|
	316	+\| unloadAddress \| Object[] \| 是 \| \| 卸货地址信息 \|
	317	+\| stationId \| String \| 是 \| 11212abc \| 园区id \|
	318	+\| stationName \| String \| 是 \| 高明新宜园区 \| 园区名称 \|
	319	+\| addressId \| String \| 是 \| 123abc \| 地址id \|
	320	+\| addressName \| String \| 是 \| 高明新宜园区-新宜6号仓-二楼18号门 \| 卸货地址名称 \|
	321	+\| lat \| String \| 是 \| 36.221825 \| 纬度(GPS坐标系：高德的，GCJ-02) \|
	322	+\| lng \| String \| 是 \| 120.632908 \| 经度(GPS坐标系：高德的，GCJ-02) \|
	323	+\| contactName \| String \| 否 \| 李四 \| 联系人 \|
	324	+\| contactMobile \| String \| 否 \| 18801000002 \| 联系人电话 \|
	325	+\| expectArrivalTime \| Number \| 否 \| 1643251533306 \| 预计到达时间，时间戳毫秒值 \|
	326	+\| expectDepartTime \| Number \| 否 \| 1643251533306 \| 预计发车时间，时间戳毫秒值 \|
	327	+\| sort \| Number \| 否 \| 1 \| 经停点顺序，如果不传则默认按数组顺序 \|
	328	+\| goods \| Object[] \| 否 \| \| 订单货物信息 \|
	329	+\| barCode \| String \| 否 \| 21616162626 \| 商品条码 \|
	330	+\| skuId \| String \| 否 \| 1223233536436 \| 商品sku_id \|
	331	+\| name \| String \| 是 \| 鞋子 \| 货物名称 \|
	332	+\| packageType \| String \| 否 \| \| 包装规格 \|
	333	+\| piece \| Number \| 否 \| 200 \| 件数 \|
	334	+\| weight \| Number \| 否 \| 200000 \| 重量 \|
	335	+\| volume \| Number \| 否 \| 50 \| 体积 \|
	336	+\| addService \| Object[] \| 否 \| \| 增值服务 \|
	337	+\| serviceType \| String \| 否 \| \| 服务类型 \|
	338	+\| serviceName \| String \| 是 \| 包装服务 \| 服务名称 \|
	339	+\| serviceDemand \| String \| 否 \| 纸箱包装 \| 服务要求 \|
	340	+\| tags \| Object[] \| 否 \| \| 订单标签 \|
	341	+\| tagName \| String \| 是 \| 易碎物品 \| 标签名称 \|
	342	+\| vehicleCode \| String \| 否 \| 12313 \| 车辆编号 \|
	343	+\| vehicleLicenseNum \| String \| 否 \| 沪DP2312 \| 车牌号 \|
	344	+\| driverCode \| String \| 否 \| 123123 \| 司机编号 \|
	345	+\| driverName \| String \| 否 \| 张三 \| 司机姓名 \|
	346	+\| driverMobile \| String \| 否 \| 18801733666 \| 司机电话 \|
	347	+
	348	+##### 请求示例
	349	+
	350	+###### Java-sdk方式 [下载SDK](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar)
	351	+
	352	+```java
	353	+public class Sample {
	354	+ public static void main(String[] args_) {
	355	+ String appKey = "appkey";
	356	+ String appSecret = "appSecret";
	357	+ String jsonData = "修改订单Body参数JSON数据";
	358	+ ZYClient zyClient = new ZYClient(appKey, appSecret);
	359	+ HttpResponseData httpResponseData =
	360	+zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/shein/modify", "accessToken", jsonData);
	361	+ if(httpResponseData == null) {
	362	+ throw new BusinessException("则一请求失败,返回结果为空!");
	363	+ }
	364	+ if(httpResponseData.getStatus() == HttpURLConnection.HTTP_UNAUTHORIZED) {
	365	+ //重新获取token再次请求
	366	+ httpResponseData = zyClient.doPost(Constants.TEST_HOST +
	367	+ "/oms-service-api/shein/modify", "accessToken", jsonData);
	368	+ }
	369	+ }
	370	+}
	371	+```
	372	+
	373	+##### 返回示例
	374	+
	375	+```json
	376	+{
	377	+ "success": true,
	378	+ "businessException": false,
	379	+ "errorCode": null,
	380	+ "message": null,
	381	+ "result": {
	382	+ "code": "则一订单号",
	383	+ "customerOrderCode": "任务单号"
	384	+ }
	385	+}
	386	+```
	387	+
	388	+
	389	+
260	390	#### 取消订单
261	391
262	392	##### 接口信息
...	...	@@ -335,8 +465,6 @@ zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/shein/cancel", "accessTo
335	465
336	466
337	467
338		-### 2023-05-06更新日志
	468	+### 2023-05-23更新日志
339	469
340		-- [x] 增加靠站签到接口
341		-- [x] 增加卸车确认接口
342		-- [x] 增加签收接口
343	470	\ No newline at end of file
	471	+- [x] 增加接口
344	472	\ No newline at end of file
...	...