Commit 89fbce4037ab2f676a280f587ec691f73445647e
1 parent
4d059bb1
Exists in
master
通鲁接口文档
Showing
1 changed file
with
513 additions
and
0 deletions
Show diff stats
| @@ -0,0 +1,513 @@ | @@ -0,0 +1,513 @@ | ||
| 1 | +[toc] | ||
| 2 | + | ||
| 3 | +# 仓储订单对接API | ||
| 4 | + | ||
| 5 | +则一提供了不同规范的API，调用服务端API前，需了解开发前须知及调用流程。本文提供了调用则一服务端API示例，供开发者参考。 | ||
| 6 | + | ||
| 7 | +## 白名单 | ||
| 8 | + | ||
| 9 | +则一服务端API接口访问有IP白名单限制，需要接口调用方提供调用API的服务器IP地址。 | ||
| 10 | + | ||
| 11 | +## 数据加签 | ||
| 12 | + | ||
| 13 | +采用md5(32位小写)算法生成签名 | ||
| 14 | +appKey(则一提供) + appSecret(则一提供) + timestamp(当前时间戳毫秒) + nonce(6位随机码大小写字母数子组合) + data(请求数据) | ||
| 15 | + | ||
| 16 | +## 数据加密 | ||
| 17 | + | ||
| 18 | +数据加密采用AES算法 | ||
| 19 | +加密模式： CBC | ||
| 20 | +填充方式：PKCS5Padding | ||
| 21 | +偏移量：iv(则一提供) | ||
| 22 | +加密内容：appKey(则一提供) + timestamp(当前时间戳毫秒) + nonce(6位随机码大小写字母数子组合) + data(加密数据) | ||
| 23 | +密钥： appSecret(则一提供) | ||
| 24 | +输出：base64 | ||
| 25 | +字符集：utf-8 | ||
| 26 | +注：无敏感数据则无需加密 | ||
| 27 | + | ||
| 28 | +## 获取访问凭证 | ||
| 29 | + | ||
| 30 | +### 概述 | ||
| 31 | + | ||
| 32 | +调用则一服务API时，都需要先获取对应权限类型的访问凭证accessToken。访问凭证（accessToken）是由则一权限系统颁发的，用来校验调用者的身份信息，确保调用者具有要执行的操作的权限。 | ||
| 33 | +**说明**： 在使用accessToken时，请注意： | ||
| 34 | + | ||
| 35 | +* accessToken的有效期默认为30天，有效期内重复获取会返回相同结果，过期后获取会返回新的accessToken。 | ||
| 36 | +* 开发者需要缓存accessToken，用于后续接口的调用。不能频繁调用获取accessToken接口，否则会受到频率拦截。 | ||
| 37 | +* 当调用业务API时，如果返回状态码为401，则说明accessToken不正确或已过期，这时需要重新获取accessToken后再调用对应的API。 | ||
| 38 | + | ||
| 39 | +### 接口信息 | ||
| 40 | + | ||
| 41 | +#### 请求方式： | ||
| 42 | + | ||
| 43 | +post | ||
| 44 | + | ||
| 45 | +#### 请求地址： | ||
| 46 | + | ||
| 47 | +* 生产：https://gw.shjiuze.cn/auth-service-api/login/password | ||
| 48 | +* 测试：https://test.shjiuze.cn/auth-service-api/login/password | ||
| 49 | + | ||
| 50 | +#### Body参数 | ||
| 51 | + | ||
| 52 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 53 | +| -------- | ------ | ---- | ----------- | ---------------- | | ||
| 54 | +| username | String | 是 | zhangsan | 用户名，则一提供 | | ||
| 55 | +| password | String | 是 | password123 | 密码，则一提供 | | ||
| 56 | + | ||
| 57 | +#### 返回参数 | ||
| 58 | + | ||
| 59 | +| 名称 | 类型 | 示例值 | 描述 | | ||
| 60 | +| ------------------------------ | ---------- | -------------------------------- | -------------------------------------------------- | | ||
| 61 | +| success | boolean | true | 成功标识: true 成功，false 失败 | | ||
| 62 | +| businessException | boolean | false | 业务异常标识: true 业务异常，false 正常 | | ||
| 63 | +| errorCode | String | 200 | 错误码: 200 业务异常，500 系统异常， 空表示无错误 | | ||
| 64 | +| message | String | 订单号不能为空 | 错误信息，无错误则返回空 | | ||
| 65 | +| result | ZYTokenDto | | accessToken结果数据 | | ||
| 66 | +| accessToken | String | 000626f15b4b41bba6fe56216a5d2f73 | accessToken | | ||
| 67 | +| expiresIn | Integer | 2060 | 有效期限单位秒，accessToken在2060秒后过期 | | ||
| 68 | +| tokenType | String | bearer | token类型 | | ||
| 69 | + | ||
| 70 | +#### 请求示例 | ||
| 71 | + | ||
| 72 | +##### Http方式 | ||
| 73 | + | ||
| 74 | +```http | ||
| 75 | +POST /auth-service-api/login/password HTTP/1.1 | ||
| 76 | +Host:test.shjiuze.cn | ||
| 77 | +Content-Type:application/json | ||
| 78 | + | ||
| 79 | +{ | ||
| 80 | + "username" : "zeyi", | ||
| 81 | + "password" : "test1111" | ||
| 82 | +} | ||
| 83 | +``` | ||
| 84 | + | ||
| 85 | +##### Java-sdk方式 | ||
| 86 | + | ||
| 87 | +##### [下载SDK](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar) | ||
| 88 | + | ||
| 89 | +```java | ||
| 90 | +public class Sample { | ||
| 91 | + public static void main(String[] args_) { | ||
| 92 | + String appKey = "appkey"; | ||
| 93 | + String appSecret = "appSecret"; | ||
| 94 | + ZYClient zyClient = new ZYClient(appKey, appSecret); | ||
| 95 | + ZYTokenRequestDto zyTokenRequest = new ZYTokenRequestDto(); | ||
| 96 | + zyTokenRequest.setUsername("zeyi"); | ||
| 97 | + zyTokenRequest.setPassword("test1111"); | ||
| 98 | + String body = gson.toJson(zyTokenRequest); | ||
| 99 | + HttpResponseData httpResponseData = zyClient.doPost(Constants.TEST_HOST + Constants.TOKEN_PATH, body); | ||
| 100 | + if(httpResponseData == null) { | ||
| 101 | + throw new TokenException("则一Token请求失败,返回为空!"); | ||
| 102 | + } | ||
| 103 | + ZYResponse<ZYTokenDto> zyResponse = gson.fromJson(httpResponseData.getBody(), new TypeToken<ZYResponse<ZYTokenDto>>(){}.getType()); | ||
| 104 | + if(!Boolean.TRUE.equals(zyResponse.isSuccess())) { | ||
| 105 | + throw new TokenException("则一Token请求返回失败!" + zyResponse.getMessage()); | ||
| 106 | + } | ||
| 107 | + if(zyResponse.getResult() == null) { | ||
| 108 | + throw new TokenException("则一Token请求返回失败,返回结果为空!" + zyResponse.getMessage()); | ||
| 109 | + } | ||
| 110 | + if(StringUtils.isBlank(zyResponse.getResult().getAccessToken())) { | ||
| 111 | + throw new TokenException("则一Token请求返回数据异常,AccessToken为空!" + zyResponse.getMessage()); | ||
| 112 | + } | ||
| 113 | + // 结果 zyResponse.getResult(); | ||
| 114 | + } | ||
| 115 | +} | ||
| 116 | +``` | ||
| 117 | + | ||
| 118 | +#### 返回示例 | ||
| 119 | + | ||
| 120 | +```json | ||
| 121 | +{ | ||
| 122 | + "success": true, | ||
| 123 | + "businessException": false, | ||
| 124 | + "errorCode": null, | ||
| 125 | + "message": null, | ||
| 126 | + "result": { | ||
| 127 | + "accessToken": "64d7f367-609b-4f7d-a84d-a3d2a0b5ad85", | ||
| 128 | + "expiresIn": 602105, | ||
| 129 | + "tokenType": "bearer" | ||
| 130 | + } | ||
| 131 | +} | ||
| 132 | +``` | ||
| 133 | + | ||
| 134 | +## 入库下单 | ||
| 135 | + | ||
| 136 | +### 简要描述 | ||
| 137 | + | ||
| 138 | +入库单创建接口， 通鲁提供 | ||
| 139 | + | ||
| 140 | +### 请求URL | ||
| 141 | + | ||
| 142 | +· 测试环境：${host}/warehouseOrder/inStock | ||
| 143 | + | ||
| 144 | +· 生产环境：${host}/warehouseOrder/inStock | ||
| 145 | + | ||
| 146 | +### 请求方式 | ||
| 147 | + | ||
| 148 | +POST | ||
| 149 | + | ||
| 150 | +### Headers参数 | ||
| 151 | + | ||
| 152 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 153 | +| ------------- | ------ | -------------------------- | -------------------------------- | ------------------------------------------------------------ | | ||
| 154 | +| Authorization | String | 是 | Bearer a2c5680001 | 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。 | | ||
| 155 | +| appKey | String | 是 | 0867ef5f23ef446483749e19e1692b40 | 则一提供 | | ||
| 156 | +| timestamp | String | 是 | 1643251533306 | 当前时间戳毫秒值 | | ||
| 157 | +| nonce | String | 是 | gdst9t | 6位小写字母数字组合随机串 | | ||
| 158 | +| sign | String | 是 | fa3ed338d6dfe18e7273c8692234ee70 | 签名：appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 | | ||
| 159 | + | ||
| 160 | +### Body参数 | ||
| 161 | + | ||
| 162 | +| 参数名 | 必传 | 类型 | 说明 | | ||
| 163 | +| ------------------------------------------ | ---- | ------ | ----------------------------------------- | | ||
| 164 | +| code | 是 | string | 客户单号(PO) | | ||
| 165 | +| supplier | 否 | string | 供应商 | | ||
| 166 | +| planTime | 否 | string | 预计操作日期时间戳(毫秒)-->入库通知日期 | | ||
| 167 | +| billTime | 否 | string | 单据日期时间戳(毫秒)(如无默认当前时间) | | ||
| 168 | +| remark | 否 | string | 备注 | | ||
| 169 | +| goodList | 是 | list | 商品集合 | | ||
| 170 | +| warehouseCode | 是 | string | 仓库编号(默认：ZY_MA_AN_SHAN_WH) | | ||
| 171 | +| warehouseAreaCode | 否 | string | 库区编号 | | ||
| 172 | +| warehouseLocCode | 否 | string | 库位编号 | | ||
| 173 | +| warehouseStatus | 是 | string | 库存状态（KCZ00 【正常】、KCZ01【冻结】） | | ||
| 174 | +| code | 是 | string | 商品编码 | | ||
| 175 | +| name | 否 | string | 商品名称 | | ||
| 176 | +| barCode | 否 | string | 商品条码 | | ||
| 177 | +| packageType | 否 | string | 包装规格 | | ||
| 178 | +| unit | 否 | string | 单位 | | ||
| 179 | +| produceDate | 否 | string | 生产日期时间戳(毫秒) | | ||
| 180 | +| expiryDate | 否 | string | 过期日期时间戳(毫秒) | | ||
| 181 | +| number | 是 | int | 入库数量 | | ||
| 182 | +| weight | 否 | int | 重量 | | ||
| 183 | +| volume | 否 | int | 体积 | | ||
| 184 | +| transactionSubCode | 否 | string | 交易子单号(PO号) | | ||
| 185 | +| lineNumber | 否 | string | 单据行号 | | ||
| 186 | +| batchNumber | 否 | string | 批次号 | | ||
| 187 | +| remark | 否 | string | 备注 | | ||
| 188 | + | ||
| 189 | +### 返回结果正常示例 | ||
| 190 | + | ||
| 191 | + {"success":true, "businessException":false, "result": {"inStockCode": "RK220928000001"}} //返回通鲁入库单号 | ||
| 192 | + | ||
| 193 | +### 返回结果异常示例 | ||
| 194 | + | ||
| 195 | + { "success": false, "businessException": true, "errorCode": "500", "message": "XXX异常!"} | ||
| 196 | + | ||
| 197 | +### 请求示例 | ||
| 198 | + | ||
| 199 | +#### Java-sdk方式 [下载SDK](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar) | ||
| 200 | + | ||
| 201 | +```java | ||
| 202 | +public class Sample { | ||
| 203 | + public static void main(String[] args_) { | ||
| 204 | + String appKey = "appkey"; | ||
| 205 | + String appSecret = "appSecret"; | ||
| 206 | + String jsonData = "订单下单Body参数JSON数据"; | ||
| 207 | + ZYClient zyClient = new ZYClient(appKey, appSecret); | ||
| 208 | + HttpResponseData httpResponseData = | ||
| 209 | +zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/warehouseOrder/inStock", "accessToken", jsonData); | ||
| 210 | + if(httpResponseData == null) { | ||
| 211 | + throw new BusinessException("则一请求失败,返回结果为空!"); | ||
| 212 | + } | ||
| 213 | + if(httpResponseData.getStatus() == HttpURLConnection.HTTP_UNAUTHORIZED) { | ||
| 214 | + //重新获取token再次请求 | ||
| 215 | + httpResponseData = zyClient.doPost(Constants.TEST_HOST + | ||
| 216 | + "/oms-service-api/warehouseOrder/inStock", "accessToken", jsonData); | ||
| 217 | + } | ||
| 218 | + } | ||
| 219 | +} | ||
| 220 | +``` | ||
| 221 | + | ||
| 222 | + | ||
| 223 | + | ||
| 224 | +## 出库下单 | ||
| 225 | + | ||
| 226 | +### 简要描述 | ||
| 227 | + | ||
| 228 | +出库单创建接口，通鲁提供 | ||
| 229 | + | ||
| 230 | +### 请求URL | ||
| 231 | + | ||
| 232 | +· 测试环境：${host}/warehouseOrder/outStock | ||
| 233 | + | ||
| 234 | +· 生产环境：${host}/warehouseOrder/outStock | ||
| 235 | + | ||
| 236 | +### 请求方式 | ||
| 237 | + | ||
| 238 | +POST | ||
| 239 | + | ||
| 240 | +### Headers参数 | ||
| 241 | + | ||
| 242 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 243 | +| ------------- | ------ | -------------------------- | -------------------------------- | ------------------------------------------------------------ | | ||
| 244 | +| Authorization | String | 是 | Bearer a2c5680001 | 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。 | | ||
| 245 | +| appKey | String | 是 | 0867ef5f23ef446483749e19e1692b40 | 则一提供 | | ||
| 246 | +| timestamp | String | 是 | 1643251533306 | 当前时间戳毫秒值 | | ||
| 247 | +| nonce | String | 是 | gdst9t | 6位小写字母数字组合随机串 | | ||
| 248 | +| sign | String | 是 | fa3ed338d6dfe18e7273c8692234ee70 | 签名：appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 | | ||
| 249 | + | ||
| 250 | +### Body参数 | ||
| 251 | + | ||
| 252 | +| 参数名 | 必传 | 类型 | 说明 | | ||
| 253 | +| ------------------------------------------ | ---- | ------ | ----------------------------------------- | | ||
| 254 | +| code | 是 | string | 客户单号(SO) | | ||
| 255 | +| supplier | 否 | string | 供应商 | | ||
| 256 | +| receiverCustomerCode | 否 | string | 收货客户编号 | | ||
| 257 | +| receiver | 是 | string | 收货人 | | ||
| 258 | +| receiverMobile | 否 | string | 收货人电话 | | ||
| 259 | +| receiverAddress | 是 | string | 收货地址 | | ||
| 260 | +| planTime | 否 | string | 预计操作时间-->出库通知日期 | | ||
| 261 | +| billTime | 否 | string | 单据日期时间戳(毫秒)(如无默认当前时间) | | ||
| 262 | +| remark | 否 | string | 备注 | | ||
| 263 | +| goodList | 是 | list | 商品集合 | | ||
| 264 | +| warehouseCode | 是 | string | 仓库编号 | | ||
| 265 | +| warehouseAreaCode | 否 | string | 库区编号 | | ||
| 266 | +| warehouseLocCode | 否 | string | 库位编号 | | ||
| 267 | +| warehouseStatus | 是 | string | 库存状态（KCZ00 【正常】、KCZ01【冻结】） | | ||
| 268 | +| code | 是 | string | 商品编码 | | ||
| 269 | +| name | 否 | string | 商品名称 | | ||
| 270 | +| barCode | 否 | string | 商品条码 | | ||
| 271 | +| packageType | 否 | string | 包装规格 | | ||
| 272 | +| unit | 否 | string | 单位 | | ||
| 273 | +| produceDate | 否 | string | 生产日期时间戳(毫秒) | | ||
| 274 | +| expiryDate | 否 | string | 过期日期时间戳(毫秒) | | ||
| 275 | +| number | 是 | int | 出库数量 | | ||
| 276 | +| weight | 否 | int | 重量 | | ||
| 277 | +| volume | 否 | int | 体积 | | ||
| 278 | +| transactionSubCode | 否 | string | 交易子单号(SO) | | ||
| 279 | +| lineNumber | 否 | string | 单据行号 | | ||
| 280 | +| batchNumber | 否 | string | 批次号 | | ||
| 281 | +| remark | 否 | string | 备注 | | ||
| 282 | + | ||
| 283 | +### 返回结果正常示例 | ||
| 284 | + | ||
| 285 | + {"success":true, "businessException":false, "result": {"outStockCode": "CK220928000001"}} //返回通鲁出库单号 | ||
| 286 | + | ||
| 287 | +### 返回结果异常示例 | ||
| 288 | + | ||
| 289 | + { "success": false, "businessException": true, "errorCode": "500", "message": "XXX异常!"} | ||
| 290 | + | ||
| 291 | +### 请求示例 | ||
| 292 | + | ||
| 293 | +#### Java-sdk方式 [下载SDK](https://zeyi-tms-product.oss-cn-hangzhou.aliyuncs.com/file/jar/java-sdk/zy-java-sdk-1.0.0.jar) | ||
| 294 | + | ||
| 295 | +```java | ||
| 296 | +public class Sample { | ||
| 297 | + public static void main(String[] args_) { | ||
| 298 | + String appKey = "appkey"; | ||
| 299 | + String appSecret = "appSecret"; | ||
| 300 | + String jsonData = "订单下单Body参数JSON数据"; | ||
| 301 | + ZYClient zyClient = new ZYClient(appKey, appSecret); | ||
| 302 | + HttpResponseData httpResponseData = | ||
| 303 | +zyClient.doPost(Constants.TEST_HOST + "/oms-service-api/warehouseOrder/outStock", "accessToken", jsonData); | ||
| 304 | + if(httpResponseData == null) { | ||
| 305 | + throw new BusinessException("则一请求失败,返回结果为空!"); | ||
| 306 | + } | ||
| 307 | + if(httpResponseData.getStatus() == HttpURLConnection.HTTP_UNAUTHORIZED) { | ||
| 308 | + //重新获取token再次请求 | ||
| 309 | + httpResponseData = zyClient.doPost(Constants.TEST_HOST + | ||
| 310 | + "/oms-service-api/warehouseOrder/outStock", "accessToken", jsonData); | ||
| 311 | + } | ||
| 312 | + } | ||
| 313 | +} | ||
| 314 | +``` | ||
| 315 | + | ||
| 316 | + | ||
| 317 | + | ||
| 318 | +## 库存状态转换 | ||
| 319 | + | ||
| 320 | +### 简要描述 | ||
| 321 | + | ||
| 322 | +基于入库单的状态转换(CIQ->正常) | ||
| 323 | + | ||
| 324 | +### 请求URL | ||
| 325 | + | ||
| 326 | +· 测试环境：https://test.shjiuze.cn/wms-service-api/warehouseOrder/transferStockStatus | ||
| 327 | + | ||
| 328 | +· 生产环境：https://gw.shjiuze.cn/wms-service-api/warehouseOrder/transferStockStatus | ||
| 329 | + | ||
| 330 | +### 请求方式 | ||
| 331 | + | ||
| 332 | +POST | ||
| 333 | + | ||
| 334 | +### Headers参数 | ||
| 335 | + | ||
| 336 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 337 | +| ------------- | ------ | -------------------------- | -------------------------------- | ------------------------------------------------------------ | | ||
| 338 | +| Authorization | String | 是 | Bearer a2c5680001 | 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。 | | ||
| 339 | +| appKey | String | 是 | 0867ef5f23ef446483749e19e1692b40 | 则一提供 | | ||
| 340 | +| timestamp | String | 是 | 1643251533306 | 当前时间戳毫秒值 | | ||
| 341 | +| nonce | String | 是 | gdst9t | 6位小写字母数字组合随机串 | | ||
| 342 | +| sign | String | 是 | fa3ed338d6dfe18e7273c8692234ee70 | 签名：appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 | | ||
| 343 | + | ||
| 344 | +### Body参数 | ||
| 345 | + | ||
| 346 | +| 参数名 | 必传 | 类型 | 说明 | | ||
| 347 | +| --------------------------------------------- | ---- | ------ | ------------------------------------------------------------ | | ||
| 348 | +| code | 是 | string | 客户单号(PO) | | ||
| 349 | +| billTime | 否 | string | 单据日期时间戳(毫秒)(如无默认当前时间) | | ||
| 350 | +| remark | 否 | string | 备注 | | ||
| 351 | +| goodList | 是 | list | 商品集合 | | ||
| 352 | +| warehouseCode | 是 | string | 仓库编号(默认：ZY_MA_AN_SHAN_WH) | | ||
| 353 | +| warehouseAreaCode | 否 | string | 库区编号 | | ||
| 354 | +| warehouseLocCode | 否 | string | 库位编号 | | ||
| 355 | +| warehouseStatus | 是 | string | 库存状态（KCZ00 【正常】、KCZ01【冻结】、KCZT01【CIQ】） | | ||
| 356 | +| beforeWarehouseStatus | 是 | string | 转换前库存状态（KCZ00 【正常】、KCZ01【冻结】、KCZT01【CIQ】） | | ||
| 357 | +| code | 是 | string | 商品编码 | | ||
| 358 | +| name | 否 | string | 商品名称 | | ||
| 359 | +| barCode | 否 | string | 商品条码 | | ||
| 360 | +| packageType | 否 | string | 包装规格 | | ||
| 361 | +| unit | 否 | string | 单位 | | ||
| 362 | +| produceDate | 否 | string | 生产日期时间戳(毫秒) | | ||
| 363 | +| expiryDate | 否 | string | 过期日期时间戳(毫秒) | | ||
| 364 | +| number | 是 | int | 数量 | | ||
| 365 | +| weight | 否 | int | 重量 | | ||
| 366 | +| volume | 否 | int | 体积 | | ||
| 367 | +| transactionSubCode | 否 | string | 交易子单号(PO号) | | ||
| 368 | +| lineNumber | 否 | string | 单据行号 | | ||
| 369 | +| batchNumber | 否 | string | 批次号 | | ||
| 370 | +| remark | 否 | string | 备注 | | ||
| 371 | + | ||
| 372 | + | ||
| 373 | + | ||
| 374 | +## 入库回调 | ||
| 375 | + | ||
| 376 | +### 简要描述 | ||
| 377 | + | ||
| 378 | +入库完成回调 | ||
| 379 | + | ||
| 380 | +### 请求URL | ||
| 381 | + | ||
| 382 | +· 测试环境：https://test.shjiuze.cn/wms-service-api/warehouseOrder/inStockComplete | ||
| 383 | + | ||
| 384 | +· 生产环境：https://gw.shjiuze.cn/wms-service-api/warehouseOrder/inStockComplete | ||
| 385 | + | ||
| 386 | +### 请求方式 | ||
| 387 | + | ||
| 388 | +POST | ||
| 389 | + | ||
| 390 | +### Headers参数 | ||
| 391 | + | ||
| 392 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 393 | +| ------------- | ------ | -------------------------- | -------------------------------- | ------------------------------------------------------------ | | ||
| 394 | +| Authorization | String | 是 | Bearer a2c5680001 | 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。 | | ||
| 395 | +| appKey | String | 是 | 0867ef5f23ef446483749e19e1692b40 | 则一提供 | | ||
| 396 | +| timestamp | String | 是 | 1643251533306 | 当前时间戳毫秒值 | | ||
| 397 | +| nonce | String | 是 | gdst9t | 6位小写字母数字组合随机串 | | ||
| 398 | +| sign | String | 是 | fa3ed338d6dfe18e7273c8692234ee70 | 签名：appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 | | ||
| 399 | + | ||
| 400 | +### Body参数 | ||
| 401 | + | ||
| 402 | +| 参数名 | 必传 | 类型 | 说明 | | ||
| 403 | +| ------------------------------------------ | ---- | ------ | ----------------------------------------- | | ||
| 404 | +| code | 是 | string | 客户单号(PO) | | ||
| 405 | +| inStockDate | 是 | string | 入库日期时间戳(毫秒)(如无默认当前时间) | | ||
| 406 | +| remark | 否 | string | 备注 | | ||
| 407 | +| goodList | 是 | list | 商品集合 | | ||
| 408 | +| warehouseCode | 是 | string | 仓库编号(默认：ZY_MA_AN_SHAN_WH) | | ||
| 409 | +| warehouseAreaCode | 否 | string | 库区编号 | | ||
| 410 | +| warehouseLocCode | 否 | string | 库位编号 | | ||
| 411 | +| warehouseStatus | 是 | string | 库存状态（KCZ00 【正常】、KCZ01【冻结】） | | ||
| 412 | +| code | 是 | string | 商品编码 | | ||
| 413 | +| name | 否 | string | 商品名称 | | ||
| 414 | +| barCode | 否 | string | 商品条码 | | ||
| 415 | +| packageType | 否 | string | 包装规格 | | ||
| 416 | +| unit | 否 | string | 单位 | | ||
| 417 | +| produceDate | 否 | string | 生产日期时间戳(毫秒) | | ||
| 418 | +| expiryDate | 否 | string | 过期日期时间戳(毫秒) | | ||
| 419 | +| number | 是 | int | 入库数量 | | ||
| 420 | +| weight | 否 | int | 重量 | | ||
| 421 | +| volume | 否 | int | 体积 | | ||
| 422 | +| transactionSubCode | 否 | string | 交易子单号(PO号) | | ||
| 423 | +| lineNumber | 否 | string | 单据行号 | | ||
| 424 | +| batchNumber | 否 | string | 批次号 | | ||
| 425 | +| remark | 否 | string | 备注 | | ||
| 426 | + | ||
| 427 | + | ||
| 428 | + | ||
| 429 | +## 出库回调 | ||
| 430 | + | ||
| 431 | +### 简要描述 | ||
| 432 | + | ||
| 433 | +出库完成回调 | ||
| 434 | + | ||
| 435 | +### 请求URL | ||
| 436 | + | ||
| 437 | +· 测试环境：https://test.shjiuze.cn/wms-service-api/warehouseOrder/outStockComplete | ||
| 438 | + | ||
| 439 | +· 生产环境：https://gw.shjiuze.cn/wms-service-api/warehouseOrder/outStockComplete | ||
| 440 | + | ||
| 441 | +### 请求方式 | ||
| 442 | + | ||
| 443 | +POST | ||
| 444 | + | ||
| 445 | +### Headers参数 | ||
| 446 | + | ||
| 447 | +| 名称 | 类型 | 必填 | 示例值 | 描述 | | ||
| 448 | +| ------------- | ------ | -------------------------- | -------------------------------- | ------------------------------------------------------------ | | ||
| 449 | +| Authorization | String | 是 | Bearer a2c5680001 | 调用服务端API的应用凭证accessToken，通过调用获取访问凭证接口获取。 | | ||
| 450 | +| appKey | String | 是 | 0867ef5f23ef446483749e19e1692b40 | 则一提供 | | ||
| 451 | +| timestamp | String | 是 | 1643251533306 | 当前时间戳毫秒值 | | ||
| 452 | +| nonce | String | 是 | gdst9t | 6位小写字母数字组合随机串 | | ||
| 453 | +| sign | String | 是 | fa3ed338d6dfe18e7273c8692234ee70 | 签名：appKey(则一提供) + appSecret(则一提供) + timestamp + nonce(6位随机码) + data(body参数)通过md5(32位小写)算法生成 | | ||
| 454 | + | ||
| 455 | +### Body参数 | ||
| 456 | + | ||
| 457 | +| 参数名 | 必传 | 类型 | 说明 | | ||
| 458 | +| ------------------------------------------ | ---- | ------ | ----------------------------------------- | | ||
| 459 | +| code | 是 | string | 客户单号(SO) | | ||
| 460 | +| operationBatchNumber | 是 | string | 操作批次号，区分分批回传 | | ||
| 461 | +| outStockDate | 否 | string | 出库日期时间戳(毫秒)(如无默认当前时间) | | ||
| 462 | +| remark | 否 | string | 备注 | | ||
| 463 | +| goodList | 是 | list | 商品集合 | | ||
| 464 | +| warehouseCode | 是 | string | 仓库编号 | | ||
| 465 | +| warehouseAreaCode | 否 | string | 库区编号 | | ||
| 466 | +| warehouseLocCode | 否 | string | 库位编号 | | ||
| 467 | +| warehouseStatus | 是 | string | 库存状态（KCZ00 【正常】、KCZ01【冻结】） | | ||
| 468 | +| code | 是 | string | 商品编码 | | ||
| 469 | +| name | 否 | string | 商品名称 | | ||
| 470 | +| barCode | 否 | string | 商品条码 | | ||
| 471 | +| packageType | 否 | string | 包装规格 | | ||
| 472 | +| unit | 否 | string | 单位 | | ||
| 473 | +| produceDate | 否 | string | 生产日期时间戳(毫秒) | | ||
| 474 | +| expiryDate | 否 | string | 过期日期时间戳(毫秒) | | ||
| 475 | +| number | 是 | int | 出库数量 | | ||
| 476 | +| weight | 否 | int | 重量 | | ||
| 477 | +| volume | 否 | int | 体积 | | ||
| 478 | +| transactionSubCode | 否 | string | 交易子单号(SO) | | ||
| 479 | +| lineNumber | 否 | string | 单据行号 | | ||
| 480 | +| batchNumber | 否 | string | 批次号 | | ||
| 481 | +| remark | 否 | string | 备注 | | ||
| 482 | + | ||
| 483 | + | ||
| 484 | + | ||
| 485 | +------------------------------------------------------------------------------------------ | ||
| 486 | + | ||
| 487 | +## 2022-05-05更新日志 | ||
| 488 | + | ||
| 489 | +1. 接口初始化 | ||
| 490 | + | ||
| 491 | + | ||
| 492 | + | ||
| 493 | +## 2022-05-07更新日志 | ||
| 494 | + | ||
| 495 | +1. 出入库接口外层中warehouseStatus字段删除，商品集合中增加warehouseStatus字段。 | ||
| 496 | +2. 移库接口商品集合中的inStockCount、outStockCount移除，增加number字段。 | ||
| 497 | + | ||
| 498 | + | ||
| 499 | + | ||
| 500 | +## 2022-05-08更新日志 | ||
| 501 | + | ||
| 502 | +1. 出入库接口请求参数商品集合中’库区编号‘命名更改为warehouseAreaCode ，增加’库位编号‘（warehouseLocCode）必填。 | ||
| 503 | + | ||
| 504 | +2. 移库接口请求参数商品集合中’入库库区编号‘、’出库库区编号‘命名更改为inWarehouseAreaCode、 outWarehouseAreaCode ，增加’入库库位编号‘、‘出库库位编号’（inWarehouseLocCode、outWarehouseLocCode）字段且必填。 | ||
| 505 | + | ||
| 506 | + | ||
| 507 | + | ||
| 508 | +## 2022-08-15更新日志 | ||
| 509 | + | ||
| 510 | +1. 增加 pciCode 和 工厂行号 | ||
| 511 | +2. 增加则一入库下单接口和出库下单接口 | ||
| 512 | +3. 增加库存释放接口 | ||
| 513 | +4. 增加货权转移接口 |