OMS 对外开放接口说明

OMS 对外开放接口说明


查询产品列表

<h5>简要描述</h5> <ul> <li>查询产品列表</li> </ul> <h5>请求URL</h5> <ul> <li><code>/v1/product/list</code> </li> </ul> <h5>请求方式</h5> <ul> <li>post</li> </ul> <h5>请求参数示例</h5> <pre><code>{ "checkEndDate": "2022-05-26", "checkStartDate": "2022-05-19", "createTimeBeginDate": "2022-05-19", "createTimeEndDate": "2022-05-26", "pageNum": 0, "pageSize": 10, "productCode": [ "string" ], "productCoding": [ "string" ], "productName": [ "string" ], "sku": [ "SKU-A01", "SKU-A02" ], "statusCheck": [ "string" ], "statusImage": [ "string" ], "statusProduct": [ "string" ], "updateTimeBeginDate": "2022-05-19", "updateTimeEndDate": "2022-05-26" } </code></pre> <h5>json字段说明</h5> <table> <thead> <tr> <th style="text-align: left;">字段名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">checkEndDate</td> <td style="text-align: left;">否</td> <td>date</td> <td>核验结束日期</td> </tr> <tr> <td style="text-align: left;">checkStartDate</td> <td style="text-align: left;">否</td> <td>date</td> <td>核验开始日期 开始结束日期不超过一周</td> </tr> <tr> <td style="text-align: left;">createTimeBeginDate</td> <td style="text-align: left;">否</td> <td>date</td> <td>开始创建日期</td> </tr> <tr> <td style="text-align: left;">createTimeEndDate</td> <td style="text-align: left;">否</td> <td>date</td> <td>结束创建日期 开始结束日期不超过一周</td> </tr> <tr> <td style="text-align: left;">pageNum</td> <td style="text-align: left;">否</td> <td>int</td> <td>当前页</td> </tr> <tr> <td style="text-align: left;">pageSize</td> <td style="text-align: left;">否</td> <td>int</td> <td>当前页有几条数据</td> </tr> <tr> <td style="text-align: left;">productCode</td> <td style="text-align: left;">否</td> <td>array</td> <td>产品条码</td> </tr> <tr> <td style="text-align: left;">productCoding</td> <td style="text-align: left;">否</td> <td>array</td> <td>第三方条码</td> </tr> <tr> <td style="text-align: left;">productName</td> <td style="text-align: left;">否</td> <td>array</td> <td>产品名称</td> </tr> <tr> <td style="text-align: left;">sku</td> <td style="text-align: left;">否</td> <td>array</td> <td>sku编码</td> </tr> <tr> <td style="text-align: left;">statusCheck</td> <td style="text-align: left;">否</td> <td>array</td> <td>核验状态</td> </tr> <tr> <td style="text-align: left;">statusImage</td> <td style="text-align: left;">否</td> <td>array</td> <td>是否有图</td> </tr> <tr> <td style="text-align: left;">statusProduct</td> <td style="text-align: left;">否</td> <td>array</td> <td>产品状态</td> </tr> <tr> <td style="text-align: left;">updateTimeBeginDate</td> <td style="text-align: left;">否</td> <td>date</td> <td>开始更新日期</td> </tr> <tr> <td style="text-align: left;">updateTimeEndDate</td> <td style="text-align: left;">否</td> <td>date</td> <td>结束更新日期 开始结束日期不超过一周</td> </tr> </tbody> </table> <h5>成功返回示例</h5> <pre><code>{ "total": 21, "rows": [ { "sku": "SKU-YTD-RED-API-0001", "productName": "SKU-YTD-RED-API-0001-NAME", "productCode": "XOD6000693", "weight": 10.5, "materialDescription": "string", "hsCode": "string", "volumeWeightVo": "0.167", "declareNameCn": "declareNameCn", "declareNameEn": "declareNameEn", "declarePrice": 0, "salePrice": 0, "length": 10, "width": 10, "height": 10, "includeBattery": false, "includeLiquid": false, "includeMagnetic": false, "productUrl": "string", "brandName": "string", "customerCode": "YTD", "notes": "string", "imageUrl": "http:\/\/218.17.60.210:840\/statics\/2022\/05\/19\/35e95955-b8cd-4a99-923e-0d7b478c4a27.jpg", "status": 10, "attachmentUrl": "http:\/\/218.17.60.210:840\/statics\/2022\/05\/19\/29b77d26-93f3-4148-ac83-9046d1488b60.txt", "snFlag": true, "manufactureBatchFlag": false, "productCodingList": [ "string" ], "productCheckList": null, "inventoryWarns": [ { "warehouseName": "深圳测试仓", "warehouseCode": "SZTEST", "inventoryWarnQty": 10 } ], "createUser": "admin", "createTime": "2022-04-20 17:06:56.579", "updateUser": "admin", "updateTime": "2022-04-22 15:10:45.713" }, { "sku": "sku202251201", "productName": " 是测试茶农", "productCode": "XOD6000691", "weight": 34, "materialDescription": null, "hsCode": null, "volumeWeightVo": "0.001", "declareNameCn": null, "declareNameEn": null, "declarePrice": null, "salePrice": null, "length": 2, "width": 2, "height": 2, "includeBattery": false, "includeLiquid": false, "includeMagnetic": false, "dangerFlag": false, "nineTagFlag": false, "shapeTagFlag": true, "productModel": "test_fa852751ef57", "productUrl": null, "brandName": null, "customerCode": "YTD", "notes": null, "imageUrl": null, "status": 20, "attachmentUrl": null, "snFlag": true, "manufactureBatchFlag": false, "productCodingList": [ "436532" ], "productCheckList": [ { "checkedLength": 1.1, "checkedWidth": 1, "checkedHeight": 1, "checkedWeight": 1, "checkedTime": "", "checkedUser": "", "checkedStatus": 10, "imageUrl": "", "warehouseName": "", "warehouseCode": "" } ], "inventoryWarns": [ { "warehouseName": "英国仓", "warehouseCode": "WAREHOUSEUK", "inventoryWarnQty": 21 }, { "warehouseName": "法国仓", "warehouseCode": "FRWAREHOUSE", "inventoryWarnQty": 7 }, { "warehouseName": "德国 菲尔特仓", "warehouseCode": "TENDA", "inventoryWarnQty": 6 }, { "warehouseName": "深圳测试仓", "warehouseCode": "SZTEST", "inventoryWarnQty": 6 }, { "warehouseName": "成运波兰海外仓", "warehouseCode": "OTD ", "inventoryWarnQty": 4 }, { "warehouseName": "GLK 纽伦堡2仓", "warehouseCode": "GLK2", "inventoryWarnQty": 6 }, { "warehouseName": "意大利仓", "warehouseCode": "WAREHOUSEIT", "inventoryWarnQty": 7 } ], "createUser": "admin", "createTime": "2022-04-20 17:06:56.579", "updateUser": "admin", "updateTime": "2022-04-22 15:10:45.713" } ], "code": 200, "msg": "查询成功" } </code></pre> <h5>成功返回示例的参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">total</td> <td style="text-align: left;">string</td> <td>无</td> </tr> <tr> <td style="text-align: left;">rows</td> <td style="text-align: left;">array</td> <td>无</td> </tr> <tr> <td style="text-align: left;">sku</td> <td style="text-align: left;">string</td> <td>sku代码</td> </tr> <tr> <td style="text-align: left;">productName</td> <td style="text-align: left;">string</td> <td>产品名称</td> </tr> <tr> <td style="text-align: left;">productCode</td> <td style="text-align: left;">string</td> <td>产品编码</td> </tr> <tr> <td style="text-align: left;">weight</td> <td style="text-align: left;">number</td> <td>重量单位为克g</td> </tr> <tr> <td style="text-align: left;">materialDescription</td> <td style="text-align: left;">string</td> <td>材质说明</td> </tr> <tr> <td style="text-align: left;">hsCode</td> <td style="text-align: left;">string</td> <td>海关编码</td> </tr> <tr> <td style="text-align: left;">volumeWeightVo</td> <td style="text-align: left;">string</td> <td>体积重</td> </tr> <tr> <td style="text-align: left;">declareNameCn</td> <td style="text-align: left;">string</td> <td>报关中文名</td> </tr> <tr> <td style="text-align: left;">declareNameEn</td> <td style="text-align: left;">string</td> <td>报关英文名</td> </tr> <tr> <td style="text-align: left;">declarePrice</td> <td style="text-align: left;">number</td> <td>报关价值美元</td> </tr> <tr> <td style="text-align: left;">salePrice</td> <td style="text-align: left;">number</td> <td>销售价格欧元</td> </tr> <tr> <td style="text-align: left;">length</td> <td style="text-align: left;">number</td> <td>长单位cm</td> </tr> <tr> <td style="text-align: left;">width</td> <td style="text-align: left;">number</td> <td>宽单位cm</td> </tr> <tr> <td style="text-align: left;">height</td> <td style="text-align: left;">number</td> <td>高单位cm</td> </tr> <tr> <td style="text-align: left;">includeBattery</td> <td style="text-align: left;">boolean</td> <td>是否含电</td> </tr> <tr> <td style="text-align: left;">includeLiquid</td> <td style="text-align: left;">boolean</td> <td>是否含液体</td> </tr> <tr> <td style="text-align: left;">includeMagnetic</td> <td style="text-align: left;">boolean</td> <td>是否包含磁性</td> </tr> <tr> <td style="text-align: left;">productUrl</td> <td style="text-align: left;">string</td> <td>产品链接</td> </tr> <tr> <td style="text-align: left;">brandName</td> <td style="text-align: left;">string</td> <td>品牌名称</td> </tr> <tr> <td style="text-align: left;">customerCode</td> <td style="text-align: left;">string</td> <td>客户代码</td> </tr> <tr> <td style="text-align: left;">notes</td> <td style="text-align: left;">string</td> <td>备注</td> </tr> <tr> <td style="text-align: left;">imageUrl</td> <td style="text-align: left;">string</td> <td>产品图片URL最多3张,多个以;分隔</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>状态10可用20作废</td> </tr> <tr> <td style="text-align: left;">attachmentUrl</td> <td style="text-align: left;">string</td> <td>附件文件URL</td> </tr> <tr> <td style="text-align: left;">productCodingList</td> <td style="text-align: left;">array</td> <td>第三方条码</td> </tr> <tr> <td style="text-align: left;">productCodingList</td> <td style="text-align: left;">array</td> <td>第三方条码</td> </tr> <tr> <td style="text-align: left;">productCheckList</td> <td style="text-align: left;">array</td> <td>核验尺寸</td> </tr> <tr> <td style="text-align: left;">productCheckList.checkedLength</td> <td style="text-align: left;">number</td> <td>核验长</td> </tr> <tr> <td style="text-align: left;">productCheckList.checkedWidth</td> <td style="text-align: left;">number</td> <td>核验宽</td> </tr> <tr> <td style="text-align: left;">productCheckList.checkedHeight</td> <td style="text-align: left;">number</td> <td>核验高</td> </tr> <tr> <td style="text-align: left;">productCheckList.checkedWeight</td> <td style="text-align: left;">number</td> <td>核验高重量g</td> </tr> <tr> <td style="text-align: left;">productCheckList.checkedTime</td> <td style="text-align: left;">string</td> <td>核验时间yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">productCheckList.checkedUser</td> <td style="text-align: left;">string</td> <td>核验人</td> </tr> <tr> <td style="text-align: left;">productCheckList.checkedStatus</td> <td style="text-align: left;">string</td> <td>10待核验20通过30不通过</td> </tr> <tr> <td style="text-align: left;">productCheckList.imageUrl</td> <td style="text-align: left;">string</td> <td>核验图片</td> </tr> <tr> <td style="text-align: left;">productCheckList.warehouseName</td> <td style="text-align: left;">string</td> <td>仓库名称</td> </tr> <tr> <td style="text-align: left;">productCheckList.warehouseCode</td> <td style="text-align: left;">string</td> <td>仓库code</td> </tr> <tr> <td style="text-align: left;">inventoryWarns</td> <td style="text-align: left;">array</td> <td>库存预警</td> </tr> <tr> <td style="text-align: left;">inventoryWarns.warehouseName</td> <td style="text-align: left;">string</td> <td>仓库名称</td> </tr> <tr> <td style="text-align: left;">inventoryWarns.warehouseCode</td> <td style="text-align: left;">string</td> <td>仓库code</td> </tr> <tr> <td style="text-align: left;">snFlag</td> <td style="text-align: left;">boolean</td> <td>是否支持一物一码</td> </tr> <tr> <td style="text-align: left;">manufactureBatchFlag</td> <td style="text-align: left;">boolean</td> <td>是否开启生产批次管理</td> </tr> <tr> <td style="text-align: left;">inventoryWarns.inventoryWarnQty</td> <td style="text-align: left;">int</td> <td>预警库存数量</td> </tr> <tr> <td style="text-align: left;">createUser</td> <td style="text-align: left;">string</td> <td>创建者</td> </tr> <tr> <td style="text-align: left;">createTime</td> <td style="text-align: left;">date</td> <td>创建时间 yyyy-MM-dd HH:mm:ss.SSS</td> </tr> <tr> <td style="text-align: left;">updateUser</td> <td style="text-align: left;">string</td> <td>更新者</td> </tr> <tr> <td style="text-align: left;">updateTime</td> <td style="text-align: left;">date</td> <td>更新时间yyyy-MM-dd HH:mm:ss.SSS</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">string</td> <td>无</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">string</td> <td>无</td> </tr> <tr> <td style="text-align: left;">dangerFlag</td> <td style="text-align: left;">boolean</td> <td>危险品</td> </tr> <tr> <td style="text-align: left;">nineTagFlag</td> <td style="text-align: left;">boolean</td> <td>九类标签</td> </tr> <tr> <td style="text-align: left;">shapeTagFlag</td> <td style="text-align: left;">boolean</td> <td>异形标签</td> </tr> <tr> <td style="text-align: left;">productModel</td> <td style="text-align: left;">string</td> <td>产品型号</td> </tr> </tbody> </table> <h5>失败返回示例</h5> <pre><code>{ "errcode": "10046", "msg": "是否有图不符合格式", "code": 500 } </code></pre> <h5>失败返回示例的参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">errcode</td> <td style="text-align: left;">string</td> <td>无</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">string</td> <td>无</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">string</td> <td>无</td> </tr> </tbody> </table>

页面列表

ITEM_HTML