diff --git a/docs/java/business/omapi.md b/docs/java/business/omapi.md index 3a38e5c..acc3413 100644 --- a/docs/java/business/omapi.md +++ b/docs/java/business/omapi.md @@ -2,9 +2,15 @@ [[TOC]] +# OM 业务 API + ## 1.仓库 -### 1.1 仓库详情 +### 1.1 仓库详情（ID） + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/warehouse/{id}/get **请求方式** @@ -57,7 +63,68 @@ GET } ``` -### 1.2 仓库列表 +### 1.2 仓库详情（编码） + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/warehouse/get?code=PLA + +**请求方式** + +GET + +**请求参数** + +| 参数 | 名称 | 备注 | +| ---- | -------- | ------------------- | +| code | 仓库编码 | 必填，不可以为 null | + +**返回结果** + +| 字段 | 名称 | 备注 | +| ------------ | ---------------- | ---------------------- | +| id | 仓库主键 ID | | +| code | 仓库编码 | | +| name | 仓库名称 | | +| ledgerNo | 账册号 | | +| type | 仓库类型 | | +| address | 仓库地址 | | +| disabled | 禁用状态 | | +| disabledEnum | 禁用状态描述 | true：禁用 false：启用 | +| - value | 禁用状态值 | | +| - desc | 禁用状态值描述 | | +| - tagType | 前端页面显示 tag | | + +**请求参数示例** + +| 参数 | 请求值 | 备注 | +| ---- | ------ | ------------------- | +| code | PLA | 必填，不可以为 null | + +**返回结果示例** + +```json +{ + "id": "440358434911109", + "code": "PLA", + "name": "普洛斯一期", + "ledgerNo": "123456789015", + "type": 1, + "address": "深圳市盐田区永安北三街盐田港普洛斯物流园出口监管仓一期", + "disabled": false, + "disabledEnum": { + "value": false, + "desc": "启用", + "tagType": "success" + } +} +``` + +### 1.3 仓库列表 + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/warehouse/list?satellite=true **请求方式** @@ -115,15 +182,19 @@ GET ] ``` -### 1.3 缓存说明 +### 1.4 缓存说明 创建缓存，在第一次查询仓库详情时，对返回的结果进行缓存。 -清除缓存，OM 系统中对仓库信息进行编辑更新成功后，监听其事件**`whe-upd`**进行清除缓存。 +清除缓存，OM 系统中对仓库信息进行编辑、禁用、启用成功后，监听其事件**`whe-upd`**进行清除缓存。 ## 2.供应商 -### 2.1 供应商详情 +### 2.1 供应商详情（ID） + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/supplier/{id}/get **请求方式** @@ -176,7 +247,68 @@ GET } ``` -### 2.2 供应商列表 +### 2.2 供应商详情（编码） + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/supplier/get + +**请求方式** + +GET + +**请求参数** + +| 参数 | 名称 | 备注 | +| ---- | ---------- | ------------------- | +| code | 供应商编码 | 必填，不可以为 null | + +**返回结果** + +| 字段 | 名称 | 备注 | +| ------------- | ---------------- | --------------------------------------------------------- | +| id | 供应商 ID | | +| code | 供应商编码 | | +| name | 供应商名称 | | +| type | 供应商类型 | 1：船公司 2：运输公司 3：装卸公司 4：报关公司 5：仓储公司 | +| contactPerson | 联系人 | | +| contactPhone | 联系电话 | | +| disabled | 禁用状态 | true：禁用 false：启用 | +| disabledEnum | 禁用状态描述 | | +| - value | 禁用状态值 | | +| - desc | 禁用状态值描述 | | +| - tagType | 前端页面显示 tag | | + +**请求参数示例** + +| 参数 | 请求值 | 备注 | +| ---- | ------ | ------------------- | +| code | XFWL | 必填，不可以为 null | + +**返回结果示例** + +```json +{ + "id": "440412326409093", + "code": "XFWL", + "name": "祥丰物流", + "type": 2, + "contactPerson": "夏天祥", + "contactPhone": "0755-22321183", + "disabled": false, + "disabledEnum": { + "value": false, + "desc": "启用", + "tagType": "success" + } +} +``` + +### 2.3 供应商列表 + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/supplier/list?type=1 **请求方式** @@ -184,9 +316,9 @@ GET **请求参数** -| 参数 | 名称 | 备注 | -| ---- | ---------- | ------------------------------------------------------------------------------ | -| type | 供应商类型 | 必填，不可以为 null，1：船公司 2：运输公司 3：装卸公司 4：报关公司 5：仓储公司 | +| 参数 | 名称 | 备注 | +| ---- | ---------- | -------------------------------------------------------------------------------------------------------- | +| type | 供应商类型 | 非必填，可以为 null，为 null 时查询所有供应商，1：船公司 2：运输公司 3：装卸公司 4：报关公司 5：仓储公司 | **返回结果** @@ -204,9 +336,9 @@ GET **请求参数示例** -| 参数 | 请求值 | 备注 | -| ---- | ------ | ------------------------------------------------------------------------------ | -| type | 1 | 必填，不可以为 null，1：船公司 2：运输公司 3：装卸公司 4：报关公司 5：仓储公司 | +| 参数 | 请求值 | 备注 | +| ---- | ------ | -------------------------------------------------------------------------------------------------------- | +| type | 1 | 必填，不可以为 null，为 null 时查询所有供应商，1：船公司 2：运输公司 3：装卸公司 4：报关公司 5：仓储公司 | **返回结果示例** @@ -237,14 +369,20 @@ GET ] ``` -### 2.3 缓存说明 +### 2.4 缓存说明 创建缓存，在第一次查询供应商详情时，对返回的结果进行缓存。 -清除缓存，OM 系统中对供应商信息进行编辑更新成功后，监听其事件**`supp-clear`**进行清除缓存。 +清除缓存，OM 系统中对供应商信息进行编辑、禁用、启用成功后，监听其事件**`supp-upd`**进行清除缓存。 ## 3.运输路线 +### 3.1 运输路线详情 + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/transport-route/{id}/get + **请求方式** GET @@ -294,6 +432,10 @@ GET ### 3.2 运输路线列表 +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/transport-route/list + **请求方式** GET @@ -371,11 +513,15 @@ GET 创建缓存，在第一次查询运输路线详情时，对返回的结果进行缓存。 -清除缓存，OM 系统中对运输路线信息进行编辑更新成功后，监听其事件**`tasp-route-clear`**进行清除缓存。 +清除缓存，OM 系统中对运输路线信息进行编辑更新成功后，监听其事件**`transRte-upd`**进行清除缓存。 ## 4.货代 -### 4.1 货代详情 +### 4.1 货代详情（ID） + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/forwarder/{id}/get **请求方式** @@ -424,8 +570,65 @@ GET } ``` +### 4.2 货代详情（编码） + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/forwarder/get + +**请求方式** + +GET + +**请求参数** + +| 参数 | 名称 | 备注 | +| ---- | -------- | ------------------- | +| code | 货代编码 | 必填，不可以为 null | + +**返回结果** + +| 字段 | 名称 | 备注 | +| ------------ | ---------------- | ---------------------- | +| id | 货代 ID | | +| code | 货代编码 | | +| name | 货代名称 | | +| abbreviation | 货代简称 | | +| disabled | 禁用状态 | true：禁用 false：启用 | +| disabledEnum | 禁用状态描述 | | +| - value | 禁用状态值 | | +| - desc | 禁用状态值描述 | | +| - tagType | 前端页面显示 tag | | + +**请求参数示例** + +| 参数 | 请求值 | 备注 | +| ---- | ------ | ------------------- | +| code | KN | 必填，不可以为 null | + +**返回结果示例** + +```json +{ + "id": "440366521914245", + "code": "KN", + "name": "德迅（中国）货运代理有限公司", + "abbreviation": "德迅", + "disabled": false, + "disabledEnum": { + "value": false, + "desc": "启用", + "tagType": "success" + } +} +``` + ### 4.2 货代列表 +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/forwarder/list + **请求方式** GET @@ -477,7 +680,11 @@ GET ## 5.付款方 -### 5.1 付款方详情 +### 5.1 付款方详情（ID） + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/payer/{id}/get **请求方式** @@ -524,7 +731,62 @@ GET } ``` -### 5.2 付款方列表 +### 5.1 付款方详情（编码） + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/payer/get + +**请求方式** + +GET + +**请求参数** + +| 参数 | 名称 | 备注 | +| ---- | ---------- | ------------------- | +| code | 付款方编码 | 必填，不可以为 null | + +**返回结果** + +| 字段 | 名称 | 备注 | +| ------------ | ---------------- | ---------------------- | +| id | 付款方 ID | | +| code | 付款方编码 | | +| name | 付款方名称 | | +| disabled | 禁用状态 | true：禁用 false：启用 | +| disabledEnum | 禁用状态描述 | | +| - value | 禁用状态值 | | +| - desc | 禁用状态值描述 | | +| - tagType | 前端页面显示 tag | | + +**请求参数示例** + +| 参数 | 请求值 | 备注 | +| ---- | ------ | ------------------- | +| code | KNSZ | 必填，不可以为 null | + +**返回结果示例** + +```json +{ + "id": "441165742478213", + "code": "KNSZ", + "name": "德迅深圳", + "disabled": false, + "disabledEnum": { + "value": false, + "desc": "启用", + "tagType": "success" + } +} +``` + +### 5.3 付款方列表 + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/payer/list?forwarder= **请求方式** @@ -606,7 +868,7 @@ GET ] ``` -### 5.3 缓存说明 +### 5.4 缓存说明 创建缓存，在第一次查询付款方详情时，对返回的结果进行缓存。 @@ -614,7 +876,11 @@ GET ## 6.收货方 -### 6.1 收货方详情 +### 6.1 收货方详情（ID） + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/consignee/{id}/get **请求方式** @@ -669,8 +935,75 @@ GET } ``` +### 6.1 收货方详情（编码） + +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/consignee/get + +**请求方式** + +GET + +**请求参数** + +| 参数 | 名称 | 备注 | +| ---- | ---------- | ------------------- | +| code | 收货方编码 | 必填，不可以为 null | + +**返回结果** + +| 字段 | 名称 | 备注 | +| -------------------------------- | ---------------- | --------------------------- | +| id | 收货方 ID | | +| code | 收货方编码 | | +| name | 收货方名称 | | +| type | 收货方类型 | 0：散货 1：标准货 2：普通货 | +| disabled | 禁用状态 | true：禁用 false：启用 | +| disabledEnum | 禁用状态描述 | | +| - value | 禁用状态值 | | +| - desc | 禁用状态值描述 | | +| - tagType | 前端页面显示 tag | | +| weighRatio | 称重比例 | 使用正整数表示 | +| grossWeightDifference | 毛重差异 | 使用正整数表示 | +| customsDeclarationAfterReceiving | 收货后报关 | true：是 false：否 | + +**请求参数示例** + +| 参数 | 请求值 | 备注 | +| ---- | ------ | ------------------- | +| code | KN-SEX | 必填，不可以为 null | + +**返回结果示例** + +```json +{ + "id": "441166221738885", + "code": "KN-SEX", + "name": "KN-SEX", + "type": 0, + "disabled": false, + "disabledEnum": { + "value": false, + "desc": "启用", + "tagType": "success" + }, + "weighRatio": 0, + "grossWeightDifference": 0, + "customsDeclarationAfterReceiving": false +} +``` + ### 6.2 收货方列表 +**请求地址** + +https://dev.leaderrun.org/api/om/rpc/v1/consignee/list?forwarder= + +**请求方式** + +GET + **请求参数** | 参数 | 名称 | 备注 |