{ "module": "system", "description": "系统接口标准入口,method 对应系统内置方法,全部使用 POST 请求,参数统一放在 body 内", "version": "0.3.0", "updatedAt": "2026-03-23", "headers": [ { "name": "platform", "type": "string", "required": true, "description": "客户端平台标识,如 web/pda/app", "list": [ { "value": "web", "name": "网页端" }, { "value": "pda", "name": "PDA端" }, { "value": "app", "name": "APP端" }, { "value": "wx", "name": "微信端" }, { "value": "miniProgram", "name": "小程序端" }, { "value": "other", "name": "其他" } ] }, { "type": "string", "required": true, "name": "project", "description": "项目标识,如 all/warehouse/store/tms", "list": [ { "value": "all", "name": "全部" }, { "value": "warehouse", "name": "仓库" }, { "value": "store", "name": "货主" }, { "value": "tms", "name": "物流" } ] } ], "methods": { "groups": [ { "groupName": "配置模块", "module": "config", "list": [ { "method": "config.list", "description": "config.list 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] } ] }, { "groupName": "看板模块", "module": "dashboard", "list": [ { "method": "dashboard.storeStats", "description": "dashboard.storeStats 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "dashboard.warehouseStats", "description": "dashboard.warehouseStats 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "dashboard.hot_order_rank", "description": "dashboard.hot_order_rank 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "dashboard.express_ratio", "description": "dashboard.express_ratio 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "dashboard.platform_distribution", "description": "dashboard.platform_distribution 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "dashboard.order_trend", "description": "dashboard.order_trend 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] } ] }, { "groupName": "基础模块", "module": "index", "list": [ { "method": "index.fastWhereTree", "description": "index.fastWhereTree 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "type", "type": "string", "required": false, "source": "body", "description": "type 参数" } ], "response": [], "errors": [] }, { "method": "index.loadStores", "description": "index.loadStores 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "index.getCOSUploadConfig", "description": "index.getCOSUploadConfig 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "data", "type": "object", "required": false, "source": "body", "description": "data 参数" } ], "response": [], "errors": [] }, { "method": "index.getImages", "description": "index.getImages 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "index.uploadSuccessNotify", "description": "index.uploadSuccessNotify 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "index.ReferenceFile", "description": "index.ReferenceFile 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "index.getMessageDetail", "description": "index.getMessageDetail 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "index.getI18nMessage", "description": "index.getI18nMessage 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "language", "type": "string", "required": false, "source": "body|query", "description": "language 参数" } ], "response": [], "errors": [] }, { "method": "index.putI18nCollect", "description": "index.putI18nCollect 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "keys", "type": "array", "required": false, "source": "body", "description": "keys 参数" }, { "name": "locale", "type": "string", "required": false, "source": "body", "description": "locale 参数" }, { "name": "project", "type": "string", "required": false, "source": "body", "description": "project 参数" }, { "name": "source", "type": "string", "required": false, "source": "body", "description": "source 参数" } ], "response": [], "errors": [] }, { "method": "index.tryAutoTranslateNewKeys", "description": "index.tryAutoTranslateNewKeys 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "index.searchSpace", "description": "index.searchSpace 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "index.getExpressList", "description": "index.getExpressList 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] } ] }, { "groupName": "订单模块", "module": "order", "list": [ { "method": "order.getOrderModels", "description": "order.getOrderModels 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "order.list", "description": "分页查询订单列表", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "pagination", "type": "object", "required": false, "source": "body", "description": "pagination 参数" }, { "name": "where", "type": "object", "required": false, "source": "body", "description": "where 参数" } ], "response": [], "errors": [] }, { "method": "order.detail", "description": "查询订单详情", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "delivery_order_code", "type": "string", "required": false, "source": "body", "description": "delivery_order_code 参数" }, { "name": "id", "type": "number", "required": false, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "order.listItems", "description": "查询订单商品明细", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "delivery_order_code", "type": "string", "required": false, "source": "body", "description": "delivery_order_code 参数" }, { "name": "order_id", "type": "number", "required": false, "source": "body", "description": "order_id 参数" } ], "response": [], "errors": [] }, { "method": "order.stats", "description": "订单统计", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "where", "type": "object", "required": false, "source": "body", "description": "where 参数" } ], "response": [], "errors": [] }, { "method": "order.getreviewOrderlist", "description": "分页查询订单审核列表", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "pagination", "type": "object", "required": false, "source": "body", "description": "pagination 参数" }, { "name": "where", "type": "object", "required": false, "source": "body", "description": "where 参数,支持 inspection_status/operator_name/operate_time_start/operate_time_end" } ], "response": [], "errors": [] }, { "method": "order.updateStatus", "description": "更新订单状态", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "claim_status", "type": "string", "required": false, "source": "body", "description": "claim_status 参数" }, { "name": "delivery_order_code", "type": "string", "required": false, "source": "body", "description": "delivery_order_code 参数" }, { "name": "delivery_time", "type": "string", "required": false, "source": "body", "description": "delivery_time 参数" }, { "name": "id", "type": "number", "required": false, "source": "body", "description": "id 参数" }, { "name": "inspection_status", "type": "string", "required": false, "source": "body", "description": "inspection_status 参数" }, { "name": "intercept_status", "type": "string", "required": false, "source": "body", "description": "intercept_status 参数" }, { "name": "lock_status", "type": "string", "required": false, "source": "body", "description": "lock_status 参数" }, { "name": "outbound_status", "type": "string", "required": false, "source": "body", "description": "outbound_status 参数" }, { "name": "pack_status", "type": "string", "required": false, "source": "body", "description": "pack_status 参数" }, { "name": "pick_status", "type": "string", "required": false, "source": "body", "description": "pick_status 参数" }, { "name": "post_status", "type": "string", "required": false, "source": "body", "description": "post_status 参数" }, { "name": "print_status", "type": "string", "required": false, "source": "body", "description": "print_status 参数" }, { "name": "status", "type": "string", "required": false, "source": "body", "description": "status 参数" }, { "name": "storage_status", "type": "string", "required": false, "source": "body", "description": "storage_status 参数" } ], "response": [], "errors": [] }, { "method": "order.updateDeliveryTime", "description": "更新发货时间", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "delivery_time", "type": "string", "required": true, "source": "body", "description": "delivery_time 参数" } ], "response": [], "errors": [] }, { "method": "order.reviewOrder", "description": "订单审核", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "delivery_order_code", "type": "string", "required": false, "source": "body", "description": "delivery_order_code 参数" }, { "name": "id", "type": "number", "required": false, "source": "body", "description": "id 参数" }, { "name": "inspection_status", "type": "string", "required": false, "source": "body", "description": "inspection_status 参数(兼容入参)" }, { "name": "review_status", "type": "string", "required": false, "source": "body", "description": "review_status 参数,默认 fin" }, { "name": "operator_name", "type": "string", "required": false, "source": "body", "description": "operator_name 参数" }, { "name": "operate_time", "type": "string", "required": false, "source": "body", "description": "operate_time 参数" } ], "response": [], "errors": [] }, { "method": "order.reviewOrder.getreviewOrderlist", "description": "分页查询订单审核列表(目录化路由)", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "pagination", "type": "object", "required": false, "source": "body", "description": "pagination 参数" }, { "name": "where", "type": "object", "required": false, "source": "body", "description": "where 参数,支持 inspection_status/operator_name/operate_time_start/operate_time_end" } ], "response": [], "errors": [] }, { "method": "order.reviewOrder.reviewOrder", "description": "订单审核(目录化路由)", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "delivery_order_code", "type": "string", "required": false, "source": "body", "description": "delivery_order_code 参数" }, { "name": "id", "type": "number", "required": false, "source": "body", "description": "id 参数" }, { "name": "inspection_status", "type": "string", "required": false, "source": "body", "description": "inspection_status 参数(兼容入参)" }, { "name": "review_status", "type": "string", "required": false, "source": "body", "description": "review_status 参数,默认 fin" }, { "name": "operator_name", "type": "string", "required": false, "source": "body", "description": "operator_name 参数" }, { "name": "operate_time", "type": "string", "required": false, "source": "body", "description": "operate_time 参数" } ], "response": [], "errors": [] }, { "method": "order.deliveryOrder.getdeliveryOrderlist", "description": "分页查询已进入出库流程的订单列表", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "pagination", "type": "object", "required": false, "source": "body", "description": "pagination 参数" }, { "name": "where", "type": "object", "required": false, "source": "body", "description": "where 参数,默认 outbound_status != none" } ], "response": [], "errors": [] }, { "method": "order.pendingOrder.getpendingOrderlist", "description": "分页查询待处理订单列表", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "pagination", "type": "object", "required": false, "source": "body", "description": "pagination 参数" }, { "name": "where", "type": "object", "required": false, "source": "body", "description": "where 参数,默认 status in [pedding, created] 且 outbound_status = none" } ], "response": [], "errors": [] }, { "method": "order.expectionOrder.getexpectionOrderlist", "description": "分页查询异常订单列表", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "pagination", "type": "object", "required": false, "source": "body", "description": "pagination 参数" }, { "name": "where", "type": "object", "required": false, "source": "body", "description": "where 参数,默认筛选各流程 error 或拦截 exception" } ], "response": [], "errors": [] }, { "method": "order.archiveOrder.getarchiveOrderlist", "description": "分页查询归档订单列表(暂使用当前订单表完成态数据)", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "pagination", "type": "object", "required": false, "source": "body", "description": "pagination 参数" }, { "name": "where", "type": "object", "required": false, "source": "body", "description": "where 参数,默认 outbound_status = fin" } ], "response": [], "errors": [] } ] }, { "groupName": "打印模块", "module": "print", "list": [ { "method": "print.send", "description": "print.send 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "computerId", "type": "string", "required": false, "source": "body", "description": "computerId 参数" }, { "name": "count", "type": "number", "required": false, "source": "body", "description": "count 参数" }, { "name": "data", "type": "object", "required": false, "source": "body", "description": "data 参数" }, { "name": "printer", "type": "string", "required": false, "source": "body", "description": "printer 参数" }, { "name": "template", "type": "object", "required": false, "source": "body", "description": "template 参数" }, { "name": "timestamp", "type": "string", "required": false, "source": "body", "description": "timestamp 参数" }, { "name": "type", "type": "string", "required": false, "source": "body", "description": "type 参数" } ], "response": [], "errors": [] }, { "method": "print.getPrintResult", "description": "print.getPrintResult 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "printId", "type": "string", "required": true, "source": "body", "description": "printId 参数" } ], "response": [], "errors": [] }, { "method": "print.getPrintRecordItem", "description": "print.getPrintRecordItem 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "print.getList", "description": "print.getList 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "page", "type": "number", "required": false, "source": "body", "description": "page 参数" }, { "name": "pageSize", "type": "number", "required": false, "source": "body", "description": "pageSize 参数" }, { "name": "where", "type": "object", "required": false, "source": "body", "description": "where 参数" } ], "response": [], "errors": [] }, { "method": "print.getItem", "description": "print.getItem 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "print.add", "description": "print.add 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "computer_id", "type": "number", "required": true, "source": "body", "description": "computer_id 参数" }, { "name": "name", "type": "string", "required": true, "source": "body", "description": "name 参数" }, { "name": "custom_barcode", "type": "string", "required": false, "source": "body", "description": "custom_barcode 参数" }, { "name": "default_printer_name", "type": "string", "required": false, "source": "body", "description": "default_printer_name 参数" } ], "response": [], "errors": [] }, { "method": "print.hasName", "description": "print.hasName 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "name", "type": "string", "required": true, "source": "body", "description": "name 参数" }, { "name": "id", "type": "number", "required": false, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "print.updateItem", "description": "print.updateItem 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" }, { "name": "computer_id", "type": "number", "required": false, "source": "body", "description": "computer_id 参数" }, { "name": "custom_barcode", "type": "string", "required": false, "source": "body", "description": "custom_barcode 参数" }, { "name": "name", "type": "string", "required": false, "source": "body", "description": "name 参数" } ], "response": [], "errors": [] }, { "method": "print.del", "description": "print.del 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids", "type": "array", "required": false, "source": "body", "description": "ids 参数" } ], "response": [], "errors": [] }, { "method": "print.getComputer", "description": "print.getComputer 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "print.getComputerPrinter", "description": "print.getComputerPrinter 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "print.savePrinters", "description": "print.savePrinters 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "defaultPrinter", "type": "string", "required": true, "source": "body", "description": "defaultPrinter 参数" }, { "name": "express", "type": "array", "required": false, "source": "body", "description": "express 参数" }, { "name": "print_station_id", "type": "number", "required": false, "source": "body", "description": "print_station_id 参数" } ], "response": [], "errors": [] } ] }, { "groupName": "打印机站点模块", "module": "printer.station", "list": [ { "method": "printer.station.list", "description": "获取打印站点列表", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] } ] }, { "groupName": "打印模板模块", "module": "setting.printTemplate", "list": [ { "method": "setting.printTemplate.list", "description": "获取打印模板树", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "setting.printTemplate.save", "description": "保存打印模板", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "setting.printTemplate.create", "description": "创建打印模板(platform 固定为 default,template_type 固定为 CUSTOM,template_url 固定为空字符串)", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "template_name", "type": "string", "required": true, "source": "body", "description": "模板名称" }, { "name": "business_type", "type": "string", "required": true, "source": "body", "description": "业务类型" }, { "name": "page_width", "type": "number", "required": true, "source": "body", "description": "页面宽度(mm)" }, { "name": "page_height", "type": "number", "required": true, "source": "body", "description": "页面高度(mm)" }, { "name": "template_content", "type": "array", "required": false, "source": "body", "description": "模板内容,可省略;省略时默认创建空模板内容" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "新建模板ID" } ], "errors": [ { "code": "400", "description": "参数错误(缺少 template_name、business_type、page_width 或 page_height)" }, { "code": "409", "description": "同一业务类型和平台下已存在自定义模板" } ] }, { "method": "setting.printTemplate.delete", "description": "删除打印模板(软删除)", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "模板ID" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "删除的模板ID" } ], "errors": [ { "code": "400", "description": "参数错误(缺少 id)" }, { "code": "404", "description": "模板不存在或无权限" } ] }, { "method": "setting.printTemplate.listTemplatesByType", "description": "按业务类型查询模板", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "businessType", "type": "string", "required": true, "source": "body", "description": "businessType 参数" } ], "response": [], "errors": [] } ] }, { "groupName": "商品模块", "module": "stock", "list": [ { "method": "stock.warehouse.list", "description": "仓库商品列表查询(支持 where 条件与分页)", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "pagination", "type": "object", "required": false, "source": "body", "description": "pagination 参数" }, { "name": "where", "type": "object", "required": false, "source": "body", "description": "where 参数" } ], "response": [], "errors": [] }, { "method": "stock.warehouse.getProhibitedType", "description": "查询违禁品类型列表(系统预设+仓库自定义)", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.getInfo", "description": "查询仓库商品详情", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.saveWarehouseStock", "description": "更新仓库商品资料", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.createWarehouseStock", "description": "新建仓库商品资料", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.getBarcodes", "description": "查询商品条码列表", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.saveWarehouseStockBarcode", "description": "保存商品条码信息", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.getStoreStocks", "description": "查询仓库商品与货主关联列表", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.bindItem", "description": "绑定货主商品关系", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.unbindItem", "description": "解绑货主商品关系", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.checkItemCodeUnique", "description": "校验商品编码在货主维度唯一性", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "item_code", "type": "string", "required": true, "source": "body", "description": "item_code 参数" }, { "name": "store_id", "type": "number", "required": true, "source": "body", "description": "store_id 参数" }, { "name": "id", "type": "number", "required": false, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "stock.warehouse.queryStockLogs", "description": "查询库存操作日志", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouseId", "type": "string", "required": false, "source": "body", "description": "warehouseId 参数" } ], "response": [], "errors": [] }, { "method": "stock.warehouse.handleBatchDelete", "description": "批量删除仓库商品资料", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.deleteUnit", "description": "删除库存单位", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.deleteProhibited", "description": "删除违禁品类型", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.handleBatchChange", "description": "批量修改仓库商品字段", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.getStockUnits", "description": "查询可用库存单位(系统+仓库)", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.getUnitList", "description": "查询当前仓库自定义单位列表", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "stock.warehouse.createProhibited", "description": "新增违禁品类型", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "name", "type": "string", "required": true, "source": "body", "description": "name 参数" } ], "response": [], "errors": [] }, { "method": "stock.warehouse.createUnit", "description": "新增库存单位", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "name", "type": "string", "required": true, "source": "body", "description": "name 参数" } ], "response": [], "errors": [] }, { "method": "stock.warehouse.search", "description": "仓库商品关键字搜索", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] } ] }, { "groupName": "库存模块", "module": "storage", "list": [ { "method": "storage.receiving.getReceivingList", "description": "storage.receiving.getReceivingList 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "pagination", "type": "object", "required": false, "source": "body", "description": "分页参数,支持 page/pageSize" }, { "name": "where", "type": "object", "required": false, "source": "body", "description": "筛选参数,支持 quickWhere、status、store_id、日期区间等" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "收货单列表" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" }, { "name": "summary", "type": "object", "required": true, "description": "汇总信息(total_quantity、total_locked、total_available、total_items)" } ], "errors": [ { "code": "500", "description": "查询失败" } ] }, { "method": "storage.receiving.getReceivingDetail", "description": "storage.receiving.getReceivingDetail 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "收货单ID" }, { "name": "pagination", "type": "object", "required": true, "source": "body", "description": "明细分页参数,支持 page/pageSize" } ], "response": [ { "name": "receiving", "type": "object", "required": true, "description": "收货单详情(含 details、images、pagination)" } ], "errors": [ { "code": "0", "description": "无记录或无权访问" }, { "code": "500", "description": "服务器错误" } ] }, { "method": "storage.receiving.batchCancelReceiving", "description": "storage.receiving.batchCancelReceiving 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids", "type": "array", "required": true, "source": "body", "description": "待作废收货单ID数组" } ], "response": [ { "name": "message", "type": "string", "required": true, "description": "批量作废处理结果" } ], "errors": [ { "code": "0", "description": "部分单据不存在、无权访问或状态不允许作废" }, { "code": "500", "description": "服务器错误" } ] }, { "method": "storage.receiving.create", "description": "storage.receiving.create 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "delivery_method", "type": "string", "required": true, "source": "body", "description": "到货方式:truck/express/air_freight/sea_freight/other" }, { "name": "loading_method", "type": "string", "required": true, "source": "body", "description": "装卸方式:with_pallet/without_pallet" }, { "name": "license_plate", "type": "string", "required": false, "source": "body", "description": "车牌号(delivery_method=truck 时建议传)" }, { "name": "tracking_number", "type": "string", "required": false, "source": "body", "description": "物流单号(非 truck/other 场景建议传)" }, { "name": "store_id", "type": "number", "required": false, "source": "body", "description": "货主ID" }, { "name": "total_boxes", "type": "number", "required": false, "source": "body", "description": "总箱数" }, { "name": "total_pallets", "type": "number", "required": false, "source": "body", "description": "总托盘数" }, { "name": "remark", "type": "string", "required": false, "source": "body", "description": "备注" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "新建收货单ID" }, { "name": "receiving_number", "type": "string", "required": true, "description": "收货单号" } ], "errors": [ { "code": "0", "description": "创建失败(如字段枚举不合法、数据库约束异常)" } ] }, { "method": "storage.receiving.addItem", "description": "storage.receiving.addItem 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": false, "source": "body", "description": "id 参数" }, { "name": "item", "type": "object", "required": false, "source": "body", "description": "item 参数" } ], "response": [], "errors": [] }, { "method": "storage.receiving.removeItem", "description": "storage.receiving.removeItem 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": false, "source": "body", "description": "id 参数" }, { "name": "item_id", "type": "number", "required": false, "source": "body", "description": "item_id 参数" } ], "response": [], "errors": [] }, { "method": "storage.receiving.saveReceiving", "description": "storage.receiving.saveReceiving 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "storage.receiving.get", "description": "storage.receiving.get 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "storage.receiving.addDetail", "description": "storage.receiving.addDetail 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "storage.receiving.deleteDetail", "description": "storage.receiving.deleteDetail 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "storage.receiving.detailChange", "description": "storage.receiving.detailChange 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "storage.receiving.cancel", "description": "storage.receiving.cancel 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "storage.receiving.completeReceiving", "description": "storage.receiving.completeReceiving 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] } ] }, { "groupName": "主体模块", "module": "store", "list": [ { "method": "store.createStore", "description": "store.createStore 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "store.createWarehouse", "description": "store.createWarehouse 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "store.joinStore", "description": "store.joinStore 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "store.joinWarehouse", "description": "store.joinWarehouse 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "store.getStoreRoles", "description": "store.getStoreRoles 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "code", "type": "string", "required": true, "source": "body", "description": "申请码(join_token)" } ], "response": [], "errors": [] }, { "method": "store.auditApply", "description": "store.auditApply 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "audit_status", "type": "string", "required": true, "source": "body", "description": "审核状态(approved/rejected)" }, { "name": "code", "type": "string", "required": true, "source": "body", "description": "申请码(join_token)" }, { "name": "store_id", "type": "number", "required": true, "source": "body", "description": "当前审批门店ID" }, { "name": "role_ids", "type": "array", "required": true, "source": "body", "description": "分配角色ID数组" }, { "name": "reject_reason", "type": "string", "required": false, "source": "body", "description": "拒绝原因(audit_status=rejected 时可传)" } ], "response": [], "errors": [] } ] }, { "groupName": "用户模块", "module": "user", "list": [ { "method": "user.login", "description": "用户登录(仅返回 token)", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "password", "type": "string", "required": false, "source": "body", "description": "password 参数" }, { "name": "username", "type": "string", "required": false, "source": "body", "description": "username 参数" } ], "response": [], "errors": [] }, { "method": "user.loginByCode", "description": "登录码登录(使用 ye4s_user.tmp_code)", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [ { "name": "code", "type": "string", "required": true, "source": "body", "description": "登录码,对应 ye4s_user.tmp_code" } ], "response": [], "errors": [] }, { "method": "user.getBindWechatCode", "description": "获取微信绑定码(默认立即返回;显式开启长轮询后,最长等待60秒,状态变化立即返回)", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "forceRefresh", "type": "boolean", "required": false, "source": "body", "description": "是否强制刷新状态,true 时跳过缓存等待窗口" }, { "name": "waitForChange", "type": "boolean", "required": false, "source": "body", "description": "是否显式开启长轮询等待(推荐字段);true 时进入最长60秒等待" }, { "name": "longPoll", "type": "boolean", "required": false, "source": "body", "description": "长轮询开关(兼容字段);true 时进入最长60秒等待" }, { "name": "waitTimeoutMs", "type": "number", "required": false, "source": "body", "description": "等待超时毫秒数;后端自动封顶60000" }, { "name": "init", "type": "boolean", "required": false, "source": "body", "description": "初始化请求标记;true 时强制立即返回,不进入长等待" } ], "response": [], "errors": [] }, { "method": "user.unbindWechat", "description": "解绑微信账号(清理 ye4s 关联账号数据)", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "user.logout", "description": "用户登出", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "user.info", "description": "获取当前用户信息", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "user.changeRole", "description": "user.changeRole 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "user.register", "description": "user.register 接口", "isNeedAuth": false, "isNeedLogin": false, "headers": [], "params": [], "response": [], "errors": [] } ] }, { "groupName": "仓库模块", "module": "warehouse", "list": [ { "method": "warehouse.getWarehouseZones", "description": "warehouse.getWarehouseZones 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "warehouse.getWarehouseTree", "description": "warehouse.getWarehouseTree 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouseId", "type": "number", "required": true, "source": "body", "description": "warehouseId 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.getChildren", "description": "warehouse.getChildren 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "zoneId", "type": "number", "required": true, "source": "body", "description": "zoneId 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.create", "description": "warehouse.create 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [], "errors": [] }, { "method": "warehouse.update", "description": "warehouse.update 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" }, { "name": "aisles", "type": "string", "required": false, "source": "body", "description": "aisles 参数" }, { "name": "cell_height", "type": "string", "required": false, "source": "body", "description": "cell_height 参数" }, { "name": "cell_length", "type": "string", "required": false, "source": "body", "description": "cell_length 参数" }, { "name": "cell_width", "type": "string", "required": false, "source": "body", "description": "cell_width 参数" }, { "name": "direction", "type": "string", "required": false, "source": "body", "description": "direction 参数" }, { "name": "height", "type": "number", "required": false, "source": "body", "description": "height 参数" }, { "name": "length", "type": "number", "required": false, "source": "body", "description": "length 参数" }, { "name": "rack_columns", "type": "string", "required": false, "source": "body", "description": "rack_columns 参数" }, { "name": "rack_levels", "type": "string", "required": false, "source": "body", "description": "rack_levels 参数" }, { "name": "rack_rows", "type": "string", "required": false, "source": "body", "description": "rack_rows 参数" }, { "name": "width", "type": "number", "required": false, "source": "body", "description": "width 参数" }, { "name": "x", "type": "number", "required": false, "source": "body", "description": "x 参数" }, { "name": "y", "type": "number", "required": false, "source": "body", "description": "y 参数" }, { "name": "z", "type": "number", "required": false, "source": "body", "description": "z 参数" }, { "name": "zone_code", "type": "string", "required": false, "source": "body", "description": "zone_code 参数" }, { "name": "zone_name", "type": "string", "required": false, "source": "body", "description": "zone_name 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.delete", "description": "warehouse.delete 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.detail", "description": "warehouse.detail 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.checkBarcodeUnique", "description": "warehouse.checkBarcodeUnique 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "barcode", "type": "string", "required": true, "source": "body", "description": "barcode 参数" }, { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.toggleActive", "description": "warehouse.toggleActive 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" }, { "name": "isActive", "type": "string", "required": false, "source": "body", "description": "isActive 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.getPath", "description": "warehouse.getPath 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.createRack", "description": "warehouse.createRack 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "height", "type": "number", "required": true, "source": "body", "description": "height 参数" }, { "name": "length", "type": "number", "required": true, "source": "body", "description": "length 参数" }, { "name": "rack_columns", "type": "number", "required": true, "source": "body", "description": "rack_columns 参数" }, { "name": "rack_levels", "type": "number", "required": true, "source": "body", "description": "rack_levels 参数" }, { "name": "rack_rows", "type": "number", "required": true, "source": "body", "description": "rack_rows 参数" }, { "name": "warehouse_id", "type": "number", "required": true, "source": "body", "description": "warehouse_id 参数" }, { "name": "width", "type": "number", "required": true, "source": "body", "description": "width 参数" }, { "name": "x", "type": "number", "required": true, "source": "body", "description": "x 参数" }, { "name": "y", "type": "number", "required": true, "source": "body", "description": "y 参数" }, { "name": "zone_code", "type": "string", "required": true, "source": "body", "description": "zone_code 参数" }, { "name": "zone_name", "type": "string", "required": true, "source": "body", "description": "zone_name 参数" }, { "name": "color", "type": "string", "required": false, "source": "body", "description": "color 参数" }, { "name": "direction", "type": "string", "required": false, "source": "body", "description": "direction 参数" }, { "name": "parent_id", "type": "number", "required": false, "source": "body", "description": "parent_id 参数" }, { "name": "z", "type": "number", "required": false, "source": "body", "description": "z 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.getPickPath", "description": "warehouse.getPickPath 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouse_id", "type": "number", "required": true, "source": "query", "description": "warehouse_id 参数" }, { "name": "include_spaces", "type": "string", "required": false, "source": "query", "description": "include_spaces 参数" }, { "name": "limit", "type": "number", "required": false, "source": "query", "description": "limit 参数" }, { "name": "sort_by", "type": "string", "required": false, "source": "query", "description": "sort_by 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.updateRackPosition", "description": "warehouse.updateRackPosition 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "x", "type": "number", "required": true, "source": "body", "description": "x 参数" }, { "name": "y", "type": "number", "required": true, "source": "body", "description": "y 参数" }, { "name": "rack_id", "type": "number", "required": false, "source": "path", "description": "rack_id 参数" }, { "name": "z", "type": "number", "required": false, "source": "body", "description": "z 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.recalculatePickPath", "description": "warehouse.recalculatePickPath 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouse_id", "type": "number", "required": true, "source": "body", "description": "warehouse_id 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.updateNeighbors", "description": "warehouse.updateNeighbors 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouse_id", "type": "number", "required": true, "source": "body", "description": "warehouse_id 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.getAreaRacks", "description": "warehouse.getAreaRacks 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "area_id", "type": "number", "required": true, "source": "query", "description": "area_id 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.getSpacesByRack", "description": "warehouse.getSpacesByRack 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.createRackWithSpaces", "description": "warehouse.createRackWithSpaces 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.getSpaceInfo", "description": "warehouse.getSpaceInfo 接口", "isNeedAuth": false, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": false, "source": "body", "description": "id 参数" } ], "response": [], "errors": [] }, { "method": "warehouse.updateSpaceInfo", "description": "warehouse.updateSpaceInfo 接口", "isNeedAuth": true, "isNeedLogin": true, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "source": "body", "description": "id 参数" }, { "name": "custom_barcode", "type": "string", "required": false, "source": "body", "description": "custom_barcode 参数" }, { "name": "custom_name", "type": "string", "required": false, "source": "body", "description": "custom_name 参数" }, { "name": "location_type_id", "type": "number", "required": false, "source": "body", "description": "location_type_id 参数" }, { "name": "pick_sequence", "type": "string", "required": false, "source": "body", "description": "pick_sequence 参数" }, { "name": "space_status", "type": "string", "required": false, "source": "body", "description": "space_status 参数" } ], "response": [], "errors": [] } ] } ] } }