WMS_MAIN/methods/system.json
liufumingren d711ba9c21 0506更新
Co-authored-by: Copilot <copilot@github.com>
2026-05-06 17:53:54 +08:00

12812 lines
617 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"module": "system",
"description": "系统接口标准入口,method 对应系统内置方法,全部使用 POST 请求,参数统一放在 body 内",
"version": "2026.05.03-system-10",
"updatedAt": "2026-05-03",
"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/wms/scm/other",
"list": [
{
"value": "all",
"name": "全部"
},
{
"value": "warehouse",
"name": "仓库"
},
{
"value": "store",
"name": "货主"
},
{
"value": "tms",
"name": "物流"
},
{
"value": "wms",
"name": "WMS"
},
{
"value": "scm",
"name": "SCM"
},
{
"value": "other",
"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.recognizeLicensePlate",
"description": "识别车牌号码(通过 base64 图片)",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "base64",
"type": "string",
"required": true,
"source": "body",
"description": "base64 图片,支持 data URL 前缀(data:image/...;base64,)或纯 base64 字符串"
},
{
"name": "imageBase64",
"type": "string",
"required": false,
"source": "body",
"description": "兼容字段(同 base64)"
},
{
"name": "image_base64",
"type": "string",
"required": false,
"source": "body",
"description": "兼容字段(同 base64)"
}
],
"response": [
{
"name": "licensePlate",
"type": "string",
"description": "识别到的车牌号(对外契约,仅返回该字段)"
}
],
"errors": [
{
"code": "400",
"description": "base64 图片不能为空 / base64 图片格式不正确 / 图片大小不能超过 7MB"
},
{
"code": "500",
"description": "第三方 OCR 服务调用失败或腾讯云配置未设置"
}
]
},
{
"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": "按当前仓库上下文搜索库位(使用 ctx.user.store_id;仅在 location_space 表中按 space_code/custom_barcode 搜索)",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "keyword",
"type": "string",
"required": false,
"source": "body",
"description": "搜索关键字,对 space_code 和 custom_barcode 做模糊匹配(%keyword%);为空时返回当前仓库下前 50 条"
}
],
"response": [
{
"name": "flag",
"type": "string",
"description": "全局调用结果标识,成功时为 success"
},
{
"name": "code",
"type": "number",
"description": "业务状态码,200 表示成功"
},
{
"name": "message",
"type": "string",
"description": "返回信息"
},
{
"name": "data",
"type": "array",
"description": "库位数组(最多 50 条),每项包含以下字段",
"children": [
{
"name": "id",
"type": "number",
"description": "库位 ID"
},
{
"name": "space_code",
"type": "string",
"description": "库位编码"
},
{
"name": "custom_barcode",
"type": "string",
"description": "库位自定义条码"
},
{
"name": "custom_name",
"type": "string",
"description": "库位自定义名称"
}
]
},
{
"name": "total",
"type": "number",
"description": "本次返回的记录条数(等于 data.length,≤50)"
}
],
"errors": []
},
{
"method": "index.listInterfaceTypes",
"description": "查询可用的接口类型列表(如奇门仓储、开放接口等)",
"isNeedAuth": false,
"isNeedLogin": true,
"params": []
},
{
"method": "index.getLocationTypeList",
"description": "查询库位类型基础列表,优先返回当前仓库下启用的库位类型,同时合并系统公共类型;结果带 300 秒缓存",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [
{
"name": "list",
"type": "array",
"description": "库位类型列表",
"children": [
{
"name": "id",
"type": "number",
"description": "库位类型 ID"
},
{
"name": "type_code",
"type": "string",
"description": "库位类型编码"
},
{
"name": "type_name",
"type": "string",
"description": "库位类型名称"
},
{
"name": "temperature_zone",
"type": "string",
"description": "温区"
},
{
"name": "allow_allocation",
"type": "boolean",
"description": "是否允许分配储位"
},
{
"name": "allow_transfer_out",
"type": "boolean",
"description": "是否允许移出"
},
{
"name": "description",
"type": "string",
"description": "描述"
},
{
"name": "warehouse_id",
"type": "number",
"description": "所属仓库 ID,null 表示系统公共类型"
}
]
},
{
"name": "total",
"type": "number",
"description": "返回总数"
}
],
"errors": []
}
]
},
{
"groupName": "订单工作台入口模块",
"module": "order.index",
"list": [
{
"method": "order.list",
"description": "订单工作台总列表入口,查询当前登录用户仓库上下文下的订单总列表,支持 pagination / where / sort。",
"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,兼容 currentPage / page_size / size"
},
{
"name": "where",
"type": "object",
"required": false,
"source": "body",
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会自动标准化;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 <window>docs/order-workbench-list-api.md</window> 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
}
],
"errors": [
{
"code": "400",
"description": "缺少仓库上下文或 where 参数格式错误"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.detail",
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / id / order_id / orderId",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
},
{
"name": "tableType / tablePosition / type / moduleName",
"type": "string",
"required": false,
"source": "body",
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
}
],
"response": [
{
"name": "order",
"type": "object",
"description": "订单头对象(raw 行数据)"
},
{
"name": "detail",
"type": "object",
"description": "等同于 order"
},
{
"name": "orderItems / items",
"type": "array",
"description": "商品明细数组"
},
{
"name": "expresses",
"type": "array",
"description": "运单信息数组"
},
{
"name": "waybill_codes",
"type": "array",
"description": "去重后的运单号字符串数组"
}
],
"errors": [
{
"code": "400",
"description": "订单ID 为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
},
{
"code": "500",
"description": "内部错误"
}
]
},
{
"method": "order.manualOutboundOrder",
"description": "手动触发出库迁移,将当前仓库内已出库订单同步到配送表。请求体直接透传给 orderDeliveryMigration.syncOutboundOrdersToDelivery。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouseId",
"type": "number",
"required": false,
"source": "body",
"description": "单仓库ID,兼容 warehouse_id"
},
{
"name": "warehouseIds",
"type": "array",
"required": false,
"source": "body",
"description": "仓库ID 数组"
},
{
"name": "queryTimeoutMs",
"type": "number",
"required": false,
"source": "body",
"description": "查询超时时间(毫秒)"
},
{
"name": "executionTimeoutMs",
"type": "number",
"required": false,
"source": "body",
"description": "执行超时时间(毫秒)"
}
],
"response": [
{
"name": "warehouseIds",
"type": "array",
"required": true,
"description": "参与迁移的仓库ID列表"
},
{
"name": "batchSize",
"type": "number",
"required": true,
"description": "单批处理上限,当前固定为 1000"
},
{
"name": "outboundStatuses",
"type": "array",
"required": true,
"description": "本次迁移匹配的出库状态"
},
{
"name": "totalSelected",
"type": "number",
"required": true,
"description": "命中的源订单数量"
},
{
"name": "totalCreated",
"type": "number",
"required": true,
"description": "实际创建到配送表的订单数量"
},
{
"name": "totalSkipped",
"type": "number",
"required": true,
"description": "本次跳过的源订单数量"
},
{
"name": "totalTimeout",
"type": "number",
"required": true,
"description": "被标记为出库超时的订单数量"
},
{
"name": "results",
"type": "array",
"required": true,
"description": "按仓库维度返回的批次结果数组,元素包含 selectedCount、createdCount、skippedCount、timeoutCount、retryableFailure 等字段"
}
],
"errors": [
{
"code": "400",
"description": "仓库ID为空或请求参数格式错误"
},
{
"code": "500",
"description": "迁移失败或数据库错误"
}
]
},
{
"method": "order.badgeCount",
"description": "订单工作台各标签页角标计数,基于当前仓库上下文返回。配送、配送异常与归档标签固定返回 99+。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [
{
"name": "reviewOrder",
"type": "number|string",
"required": true,
"description": "待审核角标"
},
{
"name": "pendingOrder",
"type": "number|string",
"required": true,
"description": "待处理角标"
},
{
"name": "outboundOrder",
"type": "number|string",
"required": true,
"description": "待出库角标"
},
{
"name": "expectionOrder",
"type": "number|string",
"required": true,
"description": "待处理异常角标"
},
{
"name": "entrustOrder",
"type": "number|string",
"required": true,
"description": "委托外仓角标"
},
{
"name": "deliveryOrder",
"type": "string",
"required": true,
"description": "配送角标,固定返回 99+"
},
{
"name": "deliveryExpectionOrder",
"type": "string",
"required": true,
"description": "配送异常角标,固定返回 99+"
},
{
"name": "archiveOrder",
"type": "string",
"required": true,
"description": "归档角标,固定返回 99+"
}
],
"errors": [
{
"code": "400",
"description": "缺少当前仓库上下文 store_id"
}
]
},
{
"method": "order.queryOrderLogs",
"description": "查询当前仓库下订单操作日志,底层复用通用日志查询分页结构,按订单ID筛选。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "string",
"required": true,
"source": "body",
"description": "订单ID"
},
{
"name": "page",
"type": "number",
"required": false,
"source": "body",
"description": "页码"
},
{
"name": "pageSize",
"type": "number",
"required": false,
"source": "body",
"description": "每页数量"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "日志列表,字段与 stock.warehouse.queryStockLogs 保持一致"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息,包含 page、pageSize、total、totalPages"
}
],
"errors": [
{
"code": "400",
"description": "订单ID为空或仓库上下文缺失"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.queryOrderLogList",
"description": "按 order_id 查询订单操作日志,返回全量日志(不分页)。接口按当前登录用户的仓库上下文过滤(method 层从 ctx.user.store_id 获取 warehouse_id),以防跨仓越界。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "order_id / id / orderId",
"type": "string|number",
"required": true,
"source": "body",
"description": "订单ID;支持别名 id 与 orderId,接口会兼容解析。"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "日志列表(全量返回,无分页)。每项字段与 stock.warehouse.queryStockLogs 保持一致,典型字段包括 id、action、message、actor、created_at、warehouse_id 等。"
}
],
"errors": [
{
"code": "400",
"description": "order_id 为空或格式不合法"
},
{
"code": "500",
"description": "内部错误"
}
]
}
]
},
{
"groupName": "订单待审核模块",
"module": "order.reviewOrder",
"list": [
{
"method": "order.reviewOrder.list",
"description": "待审核订单列表,默认仅查询 step=0 的订单。",
"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": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 <window>docs/order-workbench-list-api.md</window> 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
],
"errors": [
{
"code": "400",
"description": "参数格式错误或缺少仓库上下文"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.reviewOrder.detail",
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / id / order_id / orderId",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
},
{
"name": "tableType / tablePosition / type / moduleName",
"type": "string",
"required": false,
"source": "body",
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
}
],
"response": [
{
"name": "order",
"type": "object",
"description": "订单头对象(raw 行数据)"
},
{
"name": "detail",
"type": "object",
"description": "等同于 order"
},
{
"name": "orderItems / items",
"type": "array",
"description": "商品明细数组"
},
{
"name": "expresses",
"type": "array",
"description": "运单信息数组"
},
{
"name": "waybill_codes",
"type": "array",
"description": "去重后的运单号字符串数组"
}
],
"errors": [
{
"code": "400",
"description": "订单ID 为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
},
{
"code": "500",
"description": "内部错误"
}
]
},
{
"method": "order.reviewOrder.reviewOrder",
"description": "批量审核通过订单并进入待处理。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"source": "body",
"description": "订单 ID 数组;仅允许 ids 字段,建议传数组,也兼容逗号字符串或单值"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "首条更新记录 ID"
},
{
"name": "inspection_status",
"type": "string",
"required": true,
"description": "新的审核状态"
},
{
"name": "step",
"type": "number",
"required": true,
"description": "新的流程步骤"
},
{
"name": "updated_at",
"type": "string",
"required": true,
"description": "更新时间"
},
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "受影响行数"
},
{
"name": "ids",
"type": "array",
"required": true,
"description": "实际更新的订单 ID 列表"
}
],
"errors": [
{
"code": "400",
"description": "ids 不能为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
}
]
}
]
},
{
"groupName": "待处理订单模块",
"module": "order.pendingOrder",
"list": [
{
"method": "order.pendingOrder.list",
"description": "待处理订单列表,默认筛选 outbound_status != padding 且 step in [1,2]。",
"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": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 <window>docs/order-workbench-list-api.md</window> 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
],
"errors": [
{
"code": "400",
"description": "参数格式错误或缺少仓库上下文"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.pendingOrder.detail",
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / id / order_id / orderId",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
},
{
"name": "tableType / tablePosition / type / moduleName",
"type": "string",
"required": false,
"source": "body",
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
}
],
"response": [
{
"name": "order",
"type": "object",
"description": "订单头对象(raw 行数据)"
},
{
"name": "detail",
"type": "object",
"description": "等同于 order"
},
{
"name": "orderItems / items",
"type": "array",
"description": "商品明细数组"
},
{
"name": "expresses",
"type": "array",
"description": "运单信息数组"
},
{
"name": "waybill_codes",
"type": "array",
"description": "去重后的运单号字符串数组"
}
],
"errors": [
{
"code": "400",
"description": "订单ID 为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
},
{
"code": "500",
"description": "内部错误"
}
]
},
{
"method": "order.pendingOrder.reverseReviewOrder",
"description": "将待处理订单反审回待审核状态。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": false,
"source": "body",
"description": "订单 ID 列表;兼容 ids / id / order_id,建议传 ids"
},
{
"name": "id",
"type": "number",
"required": false,
"source": "body",
"description": "兼容单个订单 ID"
},
{
"name": "order_id",
"type": "number",
"required": false,
"source": "body",
"description": "兼容单个订单 ID"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "首条更新记录 ID"
},
{
"name": "inspection_status",
"type": "string",
"required": true,
"description": "新的审核状态"
},
{
"name": "step",
"type": "number",
"required": true,
"description": "新的流程步骤"
},
{
"name": "updated_at",
"type": "string",
"required": true,
"description": "更新时间"
},
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "受影响行数"
},
{
"name": "ids",
"type": "array",
"required": true,
"description": "实际更新的订单 ID 列表"
}
],
"errors": [
{
"code": "400",
"description": "订单ID 不能为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
}
]
},
{
"method": "order.pendingOrder.markPendingOutboundOrder",
"description": "将待处理订单批量标记为待出库。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"source": "body",
"description": "订单 ID 正整数数组;不支持 id、order_id 或逗号字符串"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "首条更新记录 ID"
},
{
"name": "outbound_status",
"type": "string",
"required": true,
"description": "新的出库状态"
},
{
"name": "updated_at",
"type": "string",
"required": true,
"description": "更新时间"
},
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "受影响行数"
},
{
"name": "ids",
"type": "array",
"required": true,
"description": "实际更新的订单 ID 列表"
}
],
"errors": [
{
"code": "400",
"description": "ids 必须为正整数数组"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
}
]
},
{
"method": "order.pendingOrder.cancelOrder",
"description": "将待处理订单批量取消,仅允许当前状态可取消的订单。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"source": "body",
"description": "订单 ID 正整数数组;不支持 id、order_id 或逗号字符串"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "首条更新记录 ID"
},
{
"name": "status",
"type": "string",
"required": true,
"description": "新的订单状态"
},
{
"name": "step",
"type": "number",
"required": true,
"description": "新的流程步骤"
},
{
"name": "updated_at",
"type": "string",
"required": true,
"description": "更新时间"
},
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "受影响行数"
},
{
"name": "ids",
"type": "array",
"required": true,
"description": "实际更新的订单 ID 列表"
}
],
"errors": [
{
"code": "400",
"description": "ids 必填或当前状态不允许取消"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
}
]
},
{
"method": "order.pendingOrder.allocateExpressCode",
"description": "批量分配待处理订单的快递号,接收订单对象数组,复用 express.createWaybillCodePipeline。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "orders",
"type": "array",
"required": true,
"source": "body",
"description": "订单对象数组;每个对象应为待处理订单列表或详情中获取的原始订单对象。每个订单对象必须包含 order_id 与 business_key;sys_platform_code 与 logistics_code 为订单对象自带字段,前端无需额外拼装或从外部构造,直接原样回传订单对象即可。其余字段会原样透传给运单创建链路。business_key 说明:business_key 是运单创建的序号键数组(例如:新分配 1 个运单号时传 [1];订单拆单时可能传 [2,3]),该字段会在 createWaybillCodePipeline 的返回 data 中原样返回,便于前端关联订单与运单创建结果。"
}
],
"response": [
{
"name": "flag",
"type": "string",
"required": true,
"description": "全局调用结果标识,成功时为 success"
},
{
"name": "code",
"type": "number",
"required": true,
"description": "业务状态码,200 表示成功"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "返回信息"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "createWaybillCodePipeline 返回的运单创建结果,包含 success/failed 列表与 summary 等字段"
}
],
"errors": [
{
"code": "400",
"message": "入参格式错误或必填字段缺失"
},
{
"code": "500",
"message": "运单创建链路或第三方快递接口调用失败"
}
]
},
{
"method": "order.pendingOrder.allocateStorage",
"description": "按订单批量分配储位(迁移自 order.storageAllocation.allocateStorage)。这是一个异步提交接口:调用后接口立即返回受理信息(包含 request_id),后端异步执行实际的储位分配与锁定操作;仓库上下文由当前登录用户提供(ctx.user.store_id)。接口不会在同步响应中返回分配明细(如 requested_order_ids、allocated_order_ids 等),客户端可通过请求 ID 或事件/查询链路获取最终结果。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "allow_storage_location / allowStorageLocation / is_allow_storage / isAllowStorage",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否允许使用存储储位,支持多种字段别名。"
},
{
"name": "order_ids / orderIds / ids / order_id / orderId / id",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单 ID 列表,支持数组、逗号分隔字符串或单个 ID(兼容多种别名)。"
}
],
"response": [
{
"name": "request_id",
"type": "string",
"required": true,
"description": "请求 ID(后端生成的唯一标识),用于查询任务状态或结果"
},
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "生效的仓库 ID(来自当前用户 store_id)"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "受理提示信息,通常为 '请求已受理,后端异步处理中' 或错误说明"
}
],
"errors": [
{
"code": 400,
"message": "缺少仓库上下文(用户登录上下文无 store_id)"
},
{
"code": 400,
"message": "订单ID 不能为空(请求中未包含有效 order_ids)"
},
{
"code": 409,
"message": "存在并发锁定或数据库约束导致的冲突(场景少见,视底层实现抛出)"
},
{
"code": 500,
"message": "内部错误:模型不可用或数据库/锁定操作失败"
}
]
},
{
"method": "order.pendingOrder.allocateStorageProgress",
"description": "按 request_id 查询储位分配异步任务状态/结果(由 allocateStorage 提交)",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "request_id / requestId",
"type": "string",
"required": true,
"source": "body|query",
"description": "任务请求 ID,兼容字段 requestId"
}
],
"response": [
{
"name": "request_id",
"type": "string",
"required": true,
"description": "请求 ID(后端生成的唯一标识)"
},
{
"name": "status",
"type": "string",
"required": true,
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
},
{
"name": "result",
"type": "object",
"required": false,
"description": "成功时返回底层分配结果,结构视实现而定"
},
{
"name": "error",
"type": "string",
"required": false,
"description": "失败时返回的错误信息"
},
{
"name": "warehouse_id",
"type": "number",
"required": false,
"description": "关联仓库 ID(若任务关联仓库时返回)"
},
{
"name": "update_time",
"type": "string",
"required": false,
"description": "最近一次状态更新时间,ISO8601 字符串"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "额外提示信息"
}
],
"errors": [
{
"code": 400,
"message": "request_id 为空或格式不合法"
},
{
"code": 500,
"message": "内部错误"
}
]
},
{
"method": "order.pendingOrder.syncOrderIds",
"description": "同步待处理订单入口,仅接收 order_ids 并转发到服务层,当前不做业务处理。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "order_ids / orderIds / ids / order_id / orderId / id",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单 ID 列表,支持数组、逗号分隔字符串或单个 ID。当前仅透传到服务层,不做额外处理。"
}
],
"response": [
{
"name": "flag",
"type": "string",
"required": true,
"description": "全局调用结果标识,成功为 success"
},
{
"name": "code",
"type": "number",
"required": true,
"description": "业务状态码,200 表示成功"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "返回信息,当前仅做受理提示"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "服务层返回值,当前仅透传 order_ids"
}
],
"errors": [
{
"code": 400,
"message": "order_ids 不能为空或格式错误"
},
{
"code": 500,
"message": "内部错误:服务层同步失败"
}
]
},
{
"method": "order.pendingOrder.cancelAllocateStorage",
"description": "待处理模块的取消分配储位入口,直接对接 system service 的 cancelAllocateStorage。仅接受订单ID(order_ids)作为入参,不接受 allow_storage_location 或 warehouse_id/warehouseId;仓库上下文来自当前登录用户的 store_id。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "order_ids / orderIds / ids / order_id / orderId / id",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单 ID 列表;支持数组、逗号字符串或单个 ID(兼容多种别名)。"
}
],
"response": [
{
"name": "flag",
"type": "string",
"required": true,
"description": "全局调用结果标识,成功为 success"
},
{
"name": "code",
"type": "number",
"required": true,
"description": "业务状态码,200 表示成功"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "返回信息,成功或部分成功时给出摘要"
},
{
"name": "data",
"type": "object",
"required": false,
"description": "取消分配汇总结果,包含下列字段",
"children": [
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "生效的仓库 ID(来自当前用户 store_id)"
},
{
"name": "requested_order_ids",
"type": "array",
"required": true,
"description": "请求中传入的订单 ID 列表(规范化后)"
},
{
"name": "cancellable_order_ids",
"type": "array",
"required": true,
"description": "实际可以取消分配的订单 ID 列表"
},
{
"name": "skipped_orders",
"type": "array",
"required": true,
"description": "被跳过的订单数组,每项至少包含 order_id 与 skipped_reason(如 not_found / not_allocated / no_allocation)"
},
{
"name": "orders",
"type": "array",
"required": true,
"description": "每个订单的取消分配结果数组,包含成功与跳过记录(合并 skipped_orders 与成功结果)"
},
{
"name": "picking_count",
"type": "number",
"required": true,
"description": "本次被取消的 picking 行数"
},
{
"name": "storage_unlock_summary",
"type": "array",
"required": true,
"description": "按 storage_id 汇总的解锁数量数组({storage_id, unlocked_quantity})"
},
{
"name": "stock_unlock_summary",
"type": "array",
"required": true,
"description": "按 stock_id 汇总的解锁数量数组({stock_id, unlocked_quantity})"
}
]
}
],
"errors": [
{
"code": 400,
"message": "缺少仓库上下文"
},
{
"code": 400,
"message": "订单ID不能为空"
},
{
"code": 500,
"message": "内部错误:模型不可用或数据库/回滚失败"
}
]
},
{
"method": "order.pendingOrder.updateOrderPlatform",
"description": "批量修改待处理订单的平台信息。用 code 查找 wms_platform 表,若平台存在则将订单的 sys_platform_code 和 sys_platform_name 更新为该平台的 code/name;若平台不存在则返回错误。只操作当前仓库的当前订单表,不处理其他订单表。",
"isNeedAuth": true,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "order_ids",
"type": "number[]",
"required": true,
"source": "body",
"description": "订单ID 正整数数组,不能为空"
},
{
"name": "code",
"type": "string",
"required": true,
"source": "body",
"description": "平台编码,对应 wms_platform.code"
}
],
"response": [
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "实际更新行数"
},
{
"name": "sys_platform_code",
"type": "string",
"required": true,
"description": "更新后的平台编码"
},
{
"name": "sys_platform_name",
"type": "string",
"required": true,
"description": "更新后的平台名称"
}
],
"errors": [
{
"code": 400,
"message": "order_ids 不能为空"
},
{
"code": 400,
"message": "code 不能为空"
},
{
"code": 404,
"message": "平台不存在:<code>"
},
{
"code": 400,
"message": "缺少仓库上下文"
}
]
},
{
"method": "order.pendingOrder.updateOrderExpress",
"description": "批量修改待处理订单的快递信息。用 express_code 从当前仓库快递列表(带缓存)中查找对应项:若为自定义映射(is_system_setting=true),sys_logistics_code/name 写系统快递编码和名称,logistics_code/name 写自定义编码和名称;若为系统快递(is_system_setting=false),四个字段均写系统快递的 code/name;未找到则报错。只操作当前仓库的当前订单表,不处理其他订单表。",
"isNeedAuth": true,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "order_ids",
"type": "number[]",
"required": true,
"source": "body",
"description": "订单ID 正整数数组,不能为空"
},
{
"name": "express_code",
"type": "string",
"required": true,
"source": "body",
"description": "快递编码,可为系统编码或仓库自定义编码"
}
],
"response": [
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "实际更新行数"
},
{
"name": "sys_logistics_code",
"type": "string",
"required": true,
"description": "写入的系统快递编码"
},
{
"name": "sys_logistics_name",
"type": "string",
"required": true,
"description": "写入的系统快递名称"
},
{
"name": "logistics_code",
"type": "string",
"required": true,
"description": "写入的快递编码(自定义或系统)"
},
{
"name": "logistics_name",
"type": "string",
"required": true,
"description": "写入的快递名称(自定义或系统)"
}
],
"errors": [
{
"code": 400,
"message": "order_ids 不能为空"
},
{
"code": 400,
"message": "order_ids 仅支持正整数数组"
},
{
"code": 400,
"message": "express_code 不能为空"
},
{
"code": 404,
"message": "快递编码 <express_code> 不存在"
}
]
},
{
"method": "order.pendingOrder.cloneOrder",
"description": "克隆待处理订单。完整流程:1. 查找原订单,校验可取消状态(step 0/1/2/3);2. 若原订单已分配储位(storage_status='fin'),先清除已分配库存;3. 取消原订单(step→9, status→cancel),记录克隆日志;4. 以原订单业务数据创建新订单,所有流程状态字段重置为初始落库状态;5. 克隆订单明细(含 stock_id),重置 order_id 为新订单 ID;6. 对新订单记录克隆创建日志。",
"isNeedAuth": true,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "order_id",
"type": "number",
"required": true,
"source": "body",
"description": "原订单ID,正整数"
}
],
"response": [
{
"name": "source_order_id",
"type": "number",
"required": true,
"description": "原订单ID(已取消)"
},
{
"name": "new_order_id",
"type": "number",
"required": true,
"description": "新订单ID(克隆生成)"
}
],
"errors": [
{
"code": 400,
"message": "order_id 不能为空"
},
{
"code": 400,
"message": "order_id 仅支持正整数"
},
{
"code": 404,
"message": "订单不存在"
},
{
"code": 400,
"message": "订单状态不允许克隆(仅支持 step 0/1/2/3)"
}
]
},
{
"method": "order.pendingOrder.createOrder",
"description": "手动创建待处理订单。根据货主策略(need_order_approval)决定初始步骤:need_order_approval=1 进待审核(step=0),need_order_approval=0 直接进待处理(step=1)。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "store_id",
"type": "number",
"required": true,
"source": "body",
"description": "货主ID(正整数)"
},
{
"name": "name",
"type": "string",
"required": true,
"source": "body",
"description": "收件人姓名"
},
{
"name": "mobile",
"type": "string",
"required": false,
"source": "body",
"description": "收件人手机号,mobile 与 tel 至少填一项"
},
{
"name": "tel",
"type": "string",
"required": false,
"source": "body",
"description": "收件人电话,mobile 与 tel 至少填一项"
},
{
"name": "detail_address",
"type": "string",
"required": true,
"source": "body",
"description": "详细地址"
},
{
"name": "province",
"type": "string",
"required": false,
"source": "body",
"description": "省份"
},
{
"name": "city",
"type": "string",
"required": false,
"source": "body",
"description": "城市"
},
{
"name": "area",
"type": "string",
"required": false,
"source": "body",
"description": "区/县"
},
{
"name": "town",
"type": "string",
"required": false,
"source": "body",
"description": "镇/街道"
},
{
"name": "zip_code",
"type": "string",
"required": false,
"source": "body",
"description": "邮编"
},
{
"name": "items",
"type": "array",
"required": true,
"source": "body",
"description": "订单明细数组,每项含 item_code(商品编码)和 plan_qty(计划数量,正整数);item_name、order_line_no、actual_price 为可选"
},
{
"name": "delivery_order_code",
"type": "string",
"required": false,
"source": "body",
"description": "订单号,不填则自动生成(SYS + 时间戳 + 随机4位)"
},
{
"name": "logistics_code",
"type": "string",
"required": false,
"source": "body",
"description": "快递编码,不填则读货主默认快递策略(policy_config.default_express_code)"
},
{
"name": "logistics_name",
"type": "string",
"required": false,
"source": "body",
"description": "快递名称"
},
{
"name": "sys_platform_code",
"type": "string",
"required": false,
"source": "body",
"description": "系统平台编码,不填则读货主默认平台策略(policy_config.default_platform_code)"
},
{
"name": "source_platform_code",
"type": "string",
"required": false,
"source": "body",
"description": "来源平台编码"
},
{
"name": "source_order_codes",
"type": "string",
"required": false,
"source": "body",
"description": "来源订单号"
},
{
"name": "order_type",
"type": "string",
"required": false,
"source": "body",
"description": "订单类型"
},
{
"name": "is_urgency",
"type": "string",
"required": false,
"source": "body",
"description": "是否紧急:Y/N,默认 N"
},
{
"name": "invoice_flag",
"type": "string",
"required": false,
"source": "body",
"description": "是否需要发票:Y/N,默认 N"
}
],
"response": [
{
"name": "order_id",
"type": "number",
"required": true,
"description": "新创建的订单 ID"
},
{
"name": "delivery_order_code",
"type": "string",
"required": true,
"description": "订单号(传入值或自动生成值)"
},
{
"name": "step",
"type": "number",
"required": true,
"description": "初始步骤:0=待审核,1=待处理"
},
{
"name": "step_label",
"type": "string",
"required": true,
"description": "步骤说明:待审核 / 待处理"
},
{
"name": "items_count",
"type": "number",
"required": true,
"description": "商品种类数"
},
{
"name": "items_total",
"type": "number",
"required": true,
"description": "商品总件数"
}
],
"errors": [
{
"code": "400",
"description": "必填字段缺失、items 格式错误或 delivery_order_code 重复"
},
{
"code": "404",
"description": "货主与仓库无有效合约关系(getContractConfig 返回 null 时降级为需审核)"
}
]
},
{
"method": "order.pendingOrder.downloadCreateTemplate",
"description": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为附件下载。表头中标注 * 的列为必填项,多行相同订单号的行组成一个完整订单。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [
{
"name": "base64",
"type": "string",
"required": true,
"description": "base64 编码的 xlsx 文件内容"
},
{
"name": "filename",
"type": "string",
"required": true,
"description": "建议保存的文件名"
},
{
"name": "mime",
"type": "string",
"required": true,
"description": "文件 MIME 类型"
}
],
"errors": []
},
{
"method": "order.pendingOrder.importOrdersFromExcel",
"description": "通过 Excel 文件批量创建订单。接受 base64 编码的 xlsx 内容,按订单号分组,每组创建一个订单(step 由货主策略决定)。每行代表一条商品明细;同一订单号的多行组成一个完整订单,头信息取每组第一行。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "file_base64",
"type": "string",
"required": true,
"source": "body",
"description": "base64 编码的 .xlsx 文件内容"
}
],
"response": [
{
"name": "total",
"type": "number",
"required": true,
"description": "解析到的订单总数"
},
{
"name": "success_count",
"type": "number",
"required": true,
"description": "创建成功的订单数"
},
{
"name": "fail_count",
"type": "number",
"required": true,
"description": "创建失败的订单数"
},
{
"name": "success_orders",
"type": "array",
"required": true,
"description": "成功订单列表,每项含 delivery_order_code、order_id、step、step_label"
},
{
"name": "fail_orders",
"type": "array",
"required": true,
"description": "失败订单列表,每项含 delivery_order_code、error(失败原因)"
}
],
"errors": [
{
"code": "400",
"description": "file_base64 为空、Excel 格式无效或无有效数据行"
}
]
}
]
},
{
"groupName": "订单波次模块",
"module": "order.wave",
"list": [
{
"method": "order.wave.groupOrderFetchList",
"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": "分页参数,支持 page / pageSize"
},
{
"name": "distinguish_express",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否区分快递(影响分组粒度)"
},
{
"name": "store_id",
"type": "number",
"required": false,
"source": "body",
"description": "货主ID(仅作为筛选条件)"
},
{
"name": "same_order_quantity",
"type": "number",
"required": false,
"source": "body",
"description": "最小同组订单数量阈值(>=)。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。"
},
{
"name": "shop_name",
"type": "string",
"required": false,
"source": "body",
"description": "店铺名称(模糊匹配)"
},
{
"name": "include_sku",
"type": "string",
"required": false,
"source": "body",
"description": "仅保留包含该 SKU 的分组(页内过滤)"
},
{
"name": "return_order_ids",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否在结果中返回组内订单ID列表"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "分组列表,items 示例见实现:包含 item_detail_machine/item_snapshot/group_count 等字段"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
}
],
"errors": [
{
"code": "400",
"description": "缺少仓库上下文或参数格式错误"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.wave.singleFetchByIds",
"description": "按订单 ID 列表抓取到一个散单波次。仅处理当前仓库的待处理订单(step in [1,2,3]),排除已在波次中的订单(wave_id>0),不区分快递;成功抓取后批量写入订单操作日志;当无可抓取订单时返回 wave_id=0。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / order_ids / orderIds",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单ID列表,支持数组、逗号分隔字符串或单个ID;优先使用 ids 字段"
}
],
"response": [
{
"name": "ids",
"type": "array",
"required": true,
"description": "请求归一化后的 ids 列表(去重且为正整数)"
},
{
"name": "wave_id",
"type": "number",
"required": true,
"description": "创建的波次 ID;若无可抓取订单返回 0"
},
{
"name": "wave_no",
"type": "string",
"required": true,
"description": "创建的波次号;无可抓取时为空字符串"
},
{
"name": "fetched_order_ids",
"type": "array",
"required": true,
"description": "实际被抓取并分配到波次的订单ID列表"
},
{
"name": "fetched_order_count",
"type": "number",
"required": true,
"description": "实际被抓取的订单数量"
},
{
"name": "excluded_existing_wave_order_ids",
"type": "array",
"required": false,
"description": "原始入参中已在其它波次中的订单ID(被排除)"
},
{
"name": "skipped_order_ids",
"type": "array",
"required": false,
"description": "未被抓取的订单ID(包括已存在波次、状态不符或出库中等)"
},
{
"name": "not_found_order_ids",
"type": "array",
"required": false,
"description": "入参中未在数据库中找到的订单ID"
}
],
"errors": [
{
"code": "400",
"description": "未识别到当前仓库上下文或 ids 参数不能为空或格式错误"
},
{
"code": "500",
"description": "抓取失败或内部错误"
}
]
},
{
"method": "order.wave.singleOrderFetchList",
"description": "按机器结构分组的散单候选列表。仅处理待处理订单(排除待审核),且排除已在波次中的订单。与 order.wave.groupOrderFetchList 不同:groupOrderFetchList 返回满足同组订单数量 >= same_order_quantity(或仓库配置 min_group_order_fetch_quantity)的团购命中分组;singleOrderFetchList 则排除这些团购命中分组,仅返回同组订单数量小于该阈值的散单候选分组(即 < same_order_quantity)。",
"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": "distinguish_express",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否区分快递(影响分组粒度)"
},
{
"name": "store_id",
"type": "number",
"required": false,
"source": "body",
"description": "货主ID(仅作为筛选条件)"
},
{
"name": "same_order_quantity",
"type": "number",
"required": false,
"source": "body",
"description": "最小同组订单数量阈值(用于判定团购命中);本接口返回同组订单数量小于该阈值的分组。若显式传入有效数值则按传入值使用;未传入时使用仓库配置 min_group_order_fetch_quantity(默认 13)。"
},
{
"name": "shop_name",
"type": "string",
"required": false,
"source": "body",
"description": "店铺名称(模糊匹配)"
},
{
"name": "include_sku",
"type": "string",
"required": false,
"source": "body",
"description": "仅保留包含该 SKU 的分组(页内过滤)"
},
{
"name": "return_order_ids",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否在结果中返回组内订单ID列表"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "散单候选分组列表,items 示例见实现:包含 item_detail_machine/item_snapshot/group_count 等字段;返回的 group_count 均小于 same_order_quantity(或仓库配置的 min_group_order_fetch_quantity)。"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
}
],
"errors": [
{
"code": "400",
"description": "缺少仓库上下文或参数格式错误"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.wave.batchList",
"description": "波次列表查询。仅使用当前登录操作者的仓库ID作为查询约束(禁止传入 warehouse_id / warehouseId)。支持通过白名单字段进行过滤(通过 where 对象传入),接口对 wave_status 固定叠加查询状态 0/1,无需客户端传入。列表按订单数量从大到小排序,并附带波次基础信息与分配状态汇总。",
"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": "筛选白名单字段(object,可选)。仅支持下列字段过滤,且禁止传入 warehouse_id / warehouseId:\n- wave_id(等值)\n- wave_no(模糊)\n- wave_type(等值)\n- wave_status(等值,接口固定叠加状态 0/1)\n- creator(模糊)\n- logistics_name(模糊)\n- item_part_type(等值)\n- item_part(模糊)\n- item_snapshot_key(模糊)\n- item_detail_machine(模糊)\n- distinguish_express(等值)\n- total_orders_min / total_orders_max(范围)\n- processed_orders_min / processed_orders_max(范围)\n- storage_assignment_status(等值,string,可选,取值:未分配、部分分配、已分配;默认不传不做限制)。过滤语义:已分配=聚合后全部 fin;部分分配=不含 error,且既不是全 none,也不是全 fin;未分配=全 none 或包含 error(异常并入未分配筛选集合)。说明:返回字段 storage_assignment_status 的展示值保持不变,包含 error 时仍可显示“分配异常”;此处 where 的过滤语义会把异常计入“未分配”,以避免把过滤语义与展示值混淆。"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "波次列表,包含波次基础信息与状态汇总(order_count / storage_assignment_status / express_assignment_status / print_assignment_status)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
}
],
"errors": [
{
"code": "400",
"description": "未识别到当前仓库上下文"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.wave.batchCancel",
"description": "提交批量解除波次异步任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理波次并执行解除操作;可通过 order.wave.batchCancelTaskProgress 查询进度与结果。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "wave_ids / waveIds / ids",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
},
{
"name": "task_id / taskId",
"type": "string",
"required": false,
"source": "body",
"description": "可选外部任务ID,用于幂等提交"
}
],
"response": [
{
"name": "status",
"type": "string",
"required": true,
"description": "提交状态,固定 success"
},
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID(用于查询任务进度)"
},
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "当前仓库ID"
},
{
"name": "accepted_at",
"type": "string",
"required": true,
"description": "任务受理时间(ISO8601)"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "受理提示信息"
}
],
"errors": [
{
"code": "400",
"description": "未识别到当前仓库上下文"
},
{
"code": "400",
"description": "wave_ids 参数不能为空或格式错误"
},
{
"code": "500",
"description": "任务提交失败或内部错误"
}
]
},
{
"method": "order.wave.batchCancelTaskProgress",
"description": "查询批量解除波次任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。响应包含 state、progress_percent、processed_wave_count、total_wave_count;当 state 为 success/failed 时返回额外字段说明。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "task_id / taskId",
"type": "string",
"required": true,
"source": "body|query",
"description": "任务 ID(后端生成或提交时传入)"
}
],
"response": [
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID"
},
{
"name": "state",
"type": "string",
"required": true,
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
},
{
"name": "progress_percent",
"type": "number",
"required": false,
"description": "进度百分比(0-100)"
},
{
"name": "processed_wave_count",
"type": "number",
"required": false,
"description": "已处理的波次数量"
},
{
"name": "total_wave_count",
"type": "number",
"required": false,
"description": "总波次数量"
},
{
"name": "duration_ms",
"type": "number",
"required": false,
"description": "任务耗时(毫秒)"
},
{
"name": "error_message",
"type": "string",
"required": false,
"description": "失败时的错误信息(仅在 state=failed 时返回)"
},
{
"name": "error_code",
"type": "string",
"required": false,
"description": "失败时的错误码(仅在 state=failed 时返回)"
},
{
"name": "result",
"type": "object",
"required": false,
"description": "成功时返回的汇总结果(仅在 state=success 时返回),例如 { \"processed_wave_count\": number, \"canceled_wave_count\": number }"
}
],
"errors": [
{
"code": "400",
"description": "task_id 参数不能为空"
},
{
"code": "500",
"description": "查询失败或内部错误"
}
]
},
{
"method": "order.wave.batchAllocateExpress",
"description": "提交批次分配快递号任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到快递号分配流水线。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "wave_ids / waveIds / ids",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
},
{
"name": "task_id / taskId",
"type": "string",
"required": false,
"source": "body",
"description": "可选外部任务ID,用于幂等提交"
}
],
"response": [
{
"name": "status",
"type": "string",
"required": true,
"description": "提交状态,固定 success"
},
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID(用于查询任务进度)"
},
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "当前仓库ID"
},
{
"name": "accepted_at",
"type": "string",
"required": true,
"description": "任务受理时间(ISO8601)"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "受理提示信息"
}
],
"errors": [
{
"code": "400",
"description": "未识别到当前仓库上下文"
},
{
"code": "400",
"description": "wave_ids 参数不能为空或格式错误"
},
{
"code": "500",
"description": "任务提交失败或内部错误"
}
]
},
{
"method": "order.wave.batchAllocateExpressTaskProgress",
"description": "查询批次分配快递号任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "task_id / taskId",
"type": "string",
"required": true,
"source": "body|query",
"description": "任务 ID(后端生成或提交时传入)"
}
],
"response": [
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID"
},
{
"name": "state",
"type": "string",
"required": true,
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
},
{
"name": "warehouse_id",
"type": "number",
"required": false,
"description": "任务关联仓库ID"
},
{
"name": "total_wave_count",
"type": "number",
"required": false,
"description": "波次数量"
},
{
"name": "total_order_count",
"type": "number",
"required": false,
"description": "参与分配的订单数量"
},
{
"name": "processed_order_count",
"type": "number",
"required": false,
"description": "已处理订单数量"
},
{
"name": "success_order_count",
"type": "number",
"required": false,
"description": "成功提交分配的订单数量"
},
{
"name": "failed_order_count",
"type": "number",
"required": false,
"description": "提交分配失败的订单数量"
},
{
"name": "progress_percent",
"type": "number",
"required": false,
"description": "进度百分比(0-100)"
},
{
"name": "duration_ms",
"type": "number",
"required": false,
"description": "任务耗时(毫秒)"
},
{
"name": "error_message",
"type": "string",
"required": false,
"description": "失败时的错误信息"
},
{
"name": "error_code",
"type": "string",
"required": false,
"description": "失败时的错误码"
}
],
"errors": [
{
"code": "400",
"description": "task_id 参数不能为空"
},
{
"code": "500",
"description": "查询失败或内部错误"
}
]
},
{
"method": "order.wave.batchRemoveExceptionOrders",
"description": "提交批次移除异常订单任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取异常订单并移出波次。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "wave_ids / waveIds / ids",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
},
{
"name": "task_id / taskId",
"type": "string",
"required": false,
"source": "body",
"description": "可选外部任务ID,用于幂等提交"
}
],
"response": [
{
"name": "status",
"type": "string",
"required": true,
"description": "提交状态,固定 success"
},
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID(用于查询任务进度)"
},
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "当前仓库ID"
},
{
"name": "accepted_at",
"type": "string",
"required": true,
"description": "任务受理时间(ISO8601)"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "受理提示信息"
}
],
"errors": [
{
"code": "400",
"description": "未识别到当前仓库上下文"
},
{
"code": "400",
"description": "wave_ids 参数不能为空或格式错误"
},
{
"code": "500",
"description": "任务提交失败或内部错误"
}
]
},
{
"method": "order.wave.batchRemoveExceptionOrdersTaskProgress",
"description": "查询批次移除异常订单任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "task_id / taskId",
"type": "string",
"required": true,
"source": "body|query",
"description": "任务 ID(后端生成或提交时传入)"
}
],
"response": [
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID"
},
{
"name": "state",
"type": "string",
"required": true,
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
},
{
"name": "warehouse_id",
"type": "number",
"required": false,
"description": "任务关联仓库ID"
},
{
"name": "total_wave_count",
"type": "number",
"required": false,
"description": "波次数量"
},
{
"name": "total_order_count",
"type": "number",
"required": false,
"description": "参与处理的订单数量"
},
{
"name": "processed_order_count",
"type": "number",
"required": false,
"description": "已处理订单数量"
},
{
"name": "removed_order_count",
"type": "number",
"required": false,
"description": "已成功移出波次的订单数量"
},
{
"name": "failed_order_count",
"type": "number",
"required": false,
"description": "处理失败的订单数量"
},
{
"name": "progress_percent",
"type": "number",
"required": false,
"description": "进度百分比(0-100)"
},
{
"name": "duration_ms",
"type": "number",
"required": false,
"description": "任务耗时(毫秒)"
},
{
"name": "error_message",
"type": "string",
"required": false,
"description": "失败时的错误信息"
},
{
"name": "error_code",
"type": "string",
"required": false,
"description": "失败时的错误码"
}
],
"errors": [
{
"code": "400",
"description": "task_id 参数不能为空"
},
{
"code": "500",
"description": "查询失败或内部错误"
}
]
},
{
"method": "order.wave.batchAllocateStorage",
"description": "提交批次分配储位任务。该接口为异步任务提交接口,立即返回 task_id,后端异步按当前仓库 + wave_ids 拉取待处理订单并提交到储位分配流水线。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "wave_ids / waveIds / ids",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "波次ID列表;支持数组、逗号分隔字符串或单个ID"
},
{
"name": "task_id / taskId",
"type": "string",
"required": false,
"source": "body",
"description": "可选外部任务ID,用于幂等提交"
}
],
"response": [
{
"name": "status",
"type": "string",
"required": true,
"description": "提交状态,固定 success"
},
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID(用于查询任务进度)"
},
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "当前仓库ID"
},
{
"name": "accepted_at",
"type": "string",
"required": true,
"description": "任务受理时间(ISO8601)"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "受理提示信息"
}
],
"errors": [
{
"code": "400",
"description": "未识别到当前仓库上下文"
},
{
"code": "400",
"description": "wave_ids 参数不能为空或格式错误"
},
{
"code": "500",
"description": "任务提交失败或内部错误"
}
]
},
{
"method": "order.wave.batchAllocateStorageTaskProgress",
"description": "查询批次分配储位任务进度:按 task_id 查询任务状态与统计信息;兼容 taskId 参数名。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "task_id / taskId",
"type": "string",
"required": true,
"source": "body|query",
"description": "任务 ID(后端生成或提交时传入)"
}
],
"response": [
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID"
},
{
"name": "state",
"type": "string",
"required": true,
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
},
{
"name": "warehouse_id",
"type": "number",
"required": false,
"description": "任务关联仓库ID"
},
{
"name": "total_wave_count",
"type": "number",
"required": false,
"description": "波次数量"
},
{
"name": "total_order_count",
"type": "number",
"required": false,
"description": "参与分配的订单数量"
},
{
"name": "processed_order_count",
"type": "number",
"required": false,
"description": "已处理订单数量"
},
{
"name": "success_order_count",
"type": "number",
"required": false,
"description": "成功提交分配的订单数量"
},
{
"name": "failed_order_count",
"type": "number",
"required": false,
"description": "提交分配失败的订单数量"
},
{
"name": "progress_percent",
"type": "number",
"required": false,
"description": "进度百分比(0-100)"
},
{
"name": "duration_ms",
"type": "number",
"required": false,
"description": "任务耗时(毫秒)"
},
{
"name": "error_message",
"type": "string",
"required": false,
"description": "失败时的错误信息"
},
{
"name": "error_code",
"type": "string",
"required": false,
"description": "失败时的错误码"
}
],
"errors": [
{
"code": "400",
"description": "task_id 参数不能为空"
},
{
"code": "500",
"description": "查询失败或内部错误"
}
]
},
{
"method": "order.wave.groupFetch",
"description": "抓取团购接口(异步任务提交)",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "structure_list",
"type": "array",
"required": true,
"source": "body",
"description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)"
}
],
"response": [
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)"
},
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "生效的仓库 ID"
},
{
"name": "structure_count",
"type": "number",
"required": true,
"description": "本次入参的结构数量(structure_list 长度)"
},
{
"name": "default_quantity",
"type": "number",
"required": true,
"description": "仓库默认抓取数量或全局默认值"
},
{
"name": "auto_fetch_disabled_marker",
"type": "string",
"required": true,
"description": "手动抓取标记;值为 'wave_manual_fetch' 表示手动抓取"
},
{
"name": "fetch_mode",
"type": "string",
"required": false,
"description": "抓取模式,值为 'group'(团购)或 'single'(散单)"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明"
}
],
"errors": [
{
"code": 400,
"message": "structure_list 必须是非空数组或结构项参数不合法"
},
{
"code": 500,
"message": "任务提交失败或内部错误"
}
]
},
{
"method": "order.wave.singleFetch",
"description": "抓取散单接口(异步任务提交)",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "structure_list",
"type": "array",
"required": true,
"source": "body",
"description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识)并包含必填字段 max_fetch_quantity(最大抓取上限,订单数,正整数);可选 quantity(未传入时使用仓库默认或全局默认)"
}
],
"response": [
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)"
},
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "生效的仓库 ID"
},
{
"name": "structure_count",
"type": "number",
"required": true,
"description": "本次入参的结构数量(structure_list 长度)"
},
{
"name": "default_quantity",
"type": "number",
"required": true,
"description": "仓库默认抓取数量或全局默认值"
},
{
"name": "auto_fetch_disabled_marker",
"type": "string",
"required": true,
"description": "手动抓取标记;值为 'wave_manual_fetch' 表示手动抓取"
},
{
"name": "fetch_mode",
"type": "string",
"required": false,
"description": "抓取模式,值为 'group'(团购)或 'single'(散单)"
},
{
"name": "max_fetch_quantity",
"type": "number",
"required": false,
"description": "提交时生效的最大抓取上限(订单数,正整数)"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明"
}
],
"errors": [
{
"code": 400,
"message": "structure_list 必须是非空数组或结构项参数不合法;max_fetch_quantity 必填且为正整数"
},
{
"code": 500,
"message": "任务提交失败或内部错误"
}
]
},
{
"method": "order.wave.fetch",
"description": "兼容别名(等同 groupFetch)",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "structure_list",
"type": "array",
"required": true,
"source": "body",
"description": "结构请求数组;每项必须包含 item_detail_machine(由 buildMachineStructureToken 生成的结构标识),可选 quantity(未传入时使用仓库默认或全局默认)"
}
],
"response": [
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID(后端生成的唯一标识,用于查询任务状态或结果)"
},
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "生效的仓库 ID"
},
{
"name": "structure_count",
"type": "number",
"required": true,
"description": "本次入参的结构数量(structure_list 长度)"
},
{
"name": "default_quantity",
"type": "number",
"required": true,
"description": "仓库默认抓取数量或全局默认值"
},
{
"name": "auto_fetch_disabled_marker",
"type": "string",
"required": true,
"description": "手动抓取标记;值为 'wave_manual_fetch' 表示手动抓取"
},
{
"name": "fetch_mode",
"type": "string",
"required": false,
"description": "抓取模式,值为 'group'(团购)或 'single'(散单)"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "受理信息提示,通常为 '任务已提交,后端异步处理中' 或失败/错误说明"
}
],
"errors": [
{
"code": 400,
"message": "structure_list 必须是非空数组或结构项参数不合法"
},
{
"code": 500,
"message": "任务提交失败或内部错误"
}
]
},
{
"method": "order.wave.fetchTaskProgress",
"description": "查询波次抓取任务进度:按 task_id 查询任务状态与进度;兼容 taskId 参数名。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "task_id / taskId",
"type": "string",
"required": true,
"source": "body|query",
"description": "任务 ID(后端生成的唯一标识),兼容旧参数名 taskId,可从 order.wave.fetch 的返回值中获取"
}
],
"response": [
{
"name": "task_id",
"type": "string",
"required": true,
"description": "任务 ID"
},
{
"name": "status",
"type": "string",
"required": true,
"description": "任务状态枚举:submitted(已受理)/ running(进行中)/ success(成功)/ failed(失败)/ not_found(未找到)"
},
{
"name": "warehouse_id",
"type": "number",
"required": false,
"description": "生效的仓库 ID(若任务关联仓库时返回)"
},
{
"name": "structure_count",
"type": "number",
"required": false,
"description": "本次任务的结构数量(structure_list 长度)"
},
{
"name": "finished_structure_count",
"type": "number",
"required": false,
"description": "已完成抓取的结构数量"
},
{
"name": "progress_percent",
"type": "number",
"required": false,
"description": "进度百分比(0-100,可能为小数)"
},
{
"name": "total_fetched_quantity",
"type": "number",
"required": false,
"description": "已抓取的总件数"
},
{
"name": "duration_ms",
"type": "number",
"required": false,
"description": "任务已运行时长,毫秒级"
},
{
"name": "error",
"type": "string",
"required": false,
"description": "错误信息,仅当 status=failed 时返回"
},
{
"name": "fetch_mode",
"type": "string",
"required": false,
"description": "抓取模式,值为 'group'(团购)或 'single'(散单);single 模式时可能返回下列额外字段"
},
{
"name": "max_fetch_quantity",
"type": "number",
"required": false,
"description": "当 fetch_mode=single 时返回的最大抓取上限(订单数,正整数)"
},
{
"name": "limit_reached",
"type": "boolean",
"required": false,
"description": "当 fetch_mode=single 时指示是否已达到 max_fetch_quantity 限制"
},
{
"name": "stop_reason",
"type": "string",
"required": false,
"description": "任务停止原因(如达到上限、人工停止或其他失败原因)"
},
{
"name": "update_time",
"type": "string",
"required": false,
"description": "最近一次状态更新时间,ISO8601 字符串"
},
{
"name": "message",
"type": "string",
"required": false,
"description": "额外提示信息"
}
],
"errors": [
{
"code": 400,
"message": "task_id 为空或格式不合法"
},
{
"code": 500,
"message": "内部错误"
}
]
},
{
"method": "order.wave.batchAutoGrouping",
"description": "批量将波次状态修改为 0(自动加团中),仅作用当前登录仓库命中的波次。限制条件:\n- 跳过已打印及之后状态的波次(wave_status >= 2);\n- 跳过 total_orders >= 仓库配置 max_wave_quantity 的波次。被跳过的波次不会被修改为自动加团中。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID"
}
],
"response": [
{
"name": "ids",
"type": "array",
"description": "归一化后的请求ID"
},
{
"name": "affected_wave_ids",
"type": "array",
"description": "实际命中的波次ID"
},
{
"name": "updated_wave_count",
"type": "number",
"description": "实际更新数量"
},
{
"name": "skipped_wave_ids",
"type": "array",
"description": "被跳过的波次ID数组(不修改状态)"
},
{
"name": "skipped_wave_count",
"type": "number",
"description": "被跳过的波次数量"
},
{
"name": "skipped_details",
"type": "array",
"description": "被跳过的波次明细數組,元素包含 wave_id 与 reason,reason 枚举 printed_or_after_printed / reach_max_wave_quantity",
"children": [
{
"name": "wave_id",
"type": "number",
"description": "波次 ID"
},
{
"name": "reason",
"type": "string",
"description": "跳过原因,枚举: printed_or_after_printed / reach_max_wave_quantity"
}
]
}
],
"errors": [
{
"code": "400",
"description": "未识别到当前仓库上下文"
},
{
"code": "400",
"description": "ids 参数不能为空或格式错误"
},
{
"code": "500",
"description": "批量修改波次状态失败或内部错误"
}
]
},
{
"method": "order.wave.batchFinishAutoGrouping",
"description": "批量结束自动加团,将当前仓库命中且 wave_status=0 的波次改为 1(已就绪)。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "波次ID 列表;支持数组、逗号分隔字符串或单个ID"
}
],
"response": [
{
"name": "ids",
"type": "array",
"description": "归一化后的请求ID"
},
{
"name": "affected_wave_ids",
"type": "array",
"description": "实际命中的波次ID"
},
{
"name": "updated_wave_ids",
"type": "array",
"description": "实际更新为已就绪的波次ID"
},
{
"name": "updated_wave_count",
"type": "number",
"description": "实际更新数量"
}
],
"errors": [
{
"code": "400",
"description": "未识别到当前仓库上下文"
},
{
"code": "400",
"description": "ids 参数不能为空或格式错误"
},
{
"code": "500",
"description": "批量结束自动加团失败或内部错误"
}
]
},
{
"method": "order.wave.batchRemoveOrders",
"description": "按订单ID批量移出波次;仅处理当前仓库的待处理订单表中非待审核订单(step in [1,2,3])。操作会清空订单的 wave_id/wave_no,并在同一事务内回写 wms_wave_batch 表:重算 total_orders,若波次被清空则将 wave_status 置为 -1。仓库上下文来自当前登录用户(ctx.user.store_id)。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / order_ids / orderIds / order_id / orderId / id",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单 ID 列表;支持数组、逗号分隔字符串或单个 ID,以上别名均可用(ids、order_ids、orderIds、order_id、orderId、id)"
}
],
"response": [
{
"name": "ids",
"type": "array",
"required": true,
"description": "归一化后的请求 ID 列表"
},
{
"name": "removed_order_ids",
"type": "array",
"required": true,
"description": "实际被移出波次的订单 ID 列表"
},
{
"name": "removed_order_count",
"type": "number",
"required": true,
"description": "被移出波次的订单数量"
},
{
"name": "affected_wave_ids",
"type": "array",
"required": true,
"description": "本次操作涉及的波次 ID 列表"
},
{
"name": "updated_wave_ids",
"type": "array",
"required": true,
"description": "实际更新了 total_orders 的波次 ID 列表"
},
{
"name": "emptied_wave_ids",
"type": "array",
"required": true,
"description": "被清空且已置为 wave_status=-1 的波次 ID 列表"
}
],
"errors": [
{
"code": "400",
"message": "缺少仓库上下文(用户登录信息无 store_id)或 ids 参数为空/格式错误"
},
{
"code": "500",
"message": "内部错误"
}
]
}
]
},
{
"groupName": "订单待出库模块",
"module": "order.outboundOrder",
"list": [
{
"method": "order.outboundOrder.list",
"description": "待出库订单列表,默认筛选 outbound_status in [none,padding] 且 step in [1,2]。",
"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": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 <window>docs/order-workbench-list-api.md</window> 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
],
"errors": [
{
"code": "400",
"description": "参数格式错误或缺少仓库上下文"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.outboundOrder.detail",
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / id / order_id / orderId",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
},
{
"name": "tableType / tablePosition / type / moduleName",
"type": "string",
"required": false,
"source": "body",
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
}
],
"response": [
{
"name": "order",
"type": "object",
"description": "订单头对象(raw 行数据)"
},
{
"name": "detail",
"type": "object",
"description": "等同于 order"
},
{
"name": "orderItems / items",
"type": "array",
"description": "商品明细数组"
},
{
"name": "expresses",
"type": "array",
"description": "运单信息数组"
},
{
"name": "waybill_codes",
"type": "array",
"description": "去重后的运单号字符串数组"
}
],
"errors": [
{
"code": "400",
"description": "订单ID 为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
},
{
"code": "500",
"description": "内部错误"
}
]
},
{
"method": "order.outboundOrder.manualOutboundOrder",
"description": "待出库模块的手动出库入口,行为与 order.manualOutboundOrder 一致。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouseId",
"type": "number",
"required": false,
"source": "body",
"description": "单仓库ID,兼容 warehouse_id"
},
{
"name": "warehouseIds",
"type": "array",
"required": false,
"source": "body",
"description": "仓库ID 数组"
},
{
"name": "queryTimeoutMs",
"type": "number",
"required": false,
"source": "body",
"description": "查询超时时间(毫秒)"
},
{
"name": "executionTimeoutMs",
"type": "number",
"required": false,
"source": "body",
"description": "执行超时时间(毫秒)"
}
],
"response": [
{
"name": "warehouseIds",
"type": "array",
"required": true,
"description": "参与迁移的仓库ID列表"
},
{
"name": "batchSize",
"type": "number",
"required": true,
"description": "单批处理上限,当前固定为 1000"
},
{
"name": "outboundStatuses",
"type": "array",
"required": true,
"description": "本次迁移匹配的出库状态"
},
{
"name": "totalSelected",
"type": "number",
"required": true,
"description": "命中的源订单数量"
},
{
"name": "totalCreated",
"type": "number",
"required": true,
"description": "实际创建到配送表的订单数量"
},
{
"name": "totalSkipped",
"type": "number",
"required": true,
"description": "本次跳过的源订单数量"
},
{
"name": "totalTimeout",
"type": "number",
"required": true,
"description": "被标记为出库超时的订单数量"
},
{
"name": "results",
"type": "array",
"required": true,
"description": "按仓库维度返回的批次结果数组,元素包含 selectedCount、createdCount、skippedCount、timeoutCount、retryableFailure 等字段"
}
],
"errors": [
{
"code": "400",
"description": "仓库ID为空或请求参数格式错误"
},
{
"code": "500",
"description": "迁移失败或数据库错误"
}
]
}
]
},
{
"groupName": "订单异常模块",
"module": "order.expectionOrder",
"list": [
{
"method": "order.expectionOrder.list",
"description": "待处理异常订单列表,默认仅查询 step=3 的订单。",
"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": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 <window>docs/order-workbench-list-api.md</window> 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
],
"errors": [
{
"code": "400",
"description": "参数格式错误或缺少仓库上下文"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.expectionOrder.detail",
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / id / order_id / orderId",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
},
{
"name": "tableType / tablePosition / type / moduleName",
"type": "string",
"required": false,
"source": "body",
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
}
],
"response": [
{
"name": "order",
"type": "object",
"description": "订单头对象(raw 行数据)"
},
{
"name": "detail",
"type": "object",
"description": "等同于 order"
},
{
"name": "orderItems / items",
"type": "array",
"description": "商品明细数组"
},
{
"name": "expresses",
"type": "array",
"description": "运单信息数组"
},
{
"name": "waybill_codes",
"type": "array",
"description": "去重后的运单号字符串数组"
}
],
"errors": [
{
"code": "400",
"description": "订单ID 为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
},
{
"code": "500",
"description": "内部错误"
}
]
},
{
"method": "order.expectionOrder.resolveException",
"description": "将待处理异常订单转回正常待处理状态(step 3 → 2)。只操作当前仓库的当前订单表,且仅对 step=3 的订单生效。",
"isNeedAuth": true,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "number[]",
"required": true,
"source": "body",
"description": "订单ID 正整数数组,不能为空"
}
],
"response": [
{
"name": "updated_count",
"type": "number",
"required": true,
"description": "实际更新行数"
},
{
"name": "ids",
"type": "number[]",
"required": true,
"description": "本次操作的订单ID 列表"
}
],
"errors": [
{
"code": "400",
"message": "ids 为空或格式非法"
},
{
"code": "500",
"message": "更新失败"
}
]
}
]
},
{
"groupName": "订单委托外仓模块",
"module": "order.entrustOrder",
"list": [
{
"method": "order.entrustOrder.list",
"description": "委托外仓订单列表,使用 outsourced 模型。",
"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": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 <window>docs/order-workbench-list-api.md</window> 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
],
"errors": [
{
"code": "400",
"description": "参数格式错误或缺少仓库上下文"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.entrustOrder.detail",
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / id / order_id / orderId",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
},
{
"name": "tableType / tablePosition / type / moduleName",
"type": "string",
"required": false,
"source": "body",
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
}
],
"response": [
{
"name": "order",
"type": "object",
"description": "订单头对象(raw 行数据)"
},
{
"name": "detail",
"type": "object",
"description": "等同于 order"
},
{
"name": "orderItems / items",
"type": "array",
"description": "商品明细数组"
},
{
"name": "expresses",
"type": "array",
"description": "运单信息数组"
},
{
"name": "waybill_codes",
"type": "array",
"description": "去重后的运单号字符串数组"
}
],
"errors": [
{
"code": "400",
"description": "订单ID 为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
},
{
"code": "500",
"description": "内部错误"
}
]
}
]
},
{
"groupName": "订单配送模块",
"module": "order.deliveryOrder",
"list": [
{
"method": "order.deliveryOrder.list",
"description": "配送订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m4。",
"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": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 <window>docs/order-workbench-list-api.md</window> 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
],
"errors": [
{
"code": "400",
"description": "参数格式错误或缺少仓库上下文"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.deliveryOrder.detail",
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / id / order_id / orderId",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
},
{
"name": "tableType / tablePosition / type / moduleName",
"type": "string",
"required": false,
"source": "body",
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
}
],
"response": [
{
"name": "order",
"type": "object",
"description": "订单头对象(raw 行数据)"
},
{
"name": "detail",
"type": "object",
"description": "等同于 order"
},
{
"name": "orderItems / items",
"type": "array",
"description": "商品明细数组"
},
{
"name": "expresses",
"type": "array",
"description": "运单信息数组"
},
{
"name": "waybill_codes",
"type": "array",
"description": "去重后的运单号字符串数组"
}
],
"errors": [
{
"code": "400",
"description": "订单ID 为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
},
{
"code": "500",
"description": "内部错误"
}
]
}
]
},
{
"groupName": "订单配送异常模块",
"module": "order.deliveryExpectionOrder",
"list": [
{
"method": "order.deliveryExpectionOrder.list",
"description": "配送异常订单列表,使用 dispatch 模型,默认筛选 dispatch_lane=m5。",
"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": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据,字段字典见 <window>docs/order-workbench-list-api.md</window> 中的“订单列表 raw 字段字典”章节)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
],
"errors": [
{
"code": "400",
"description": "参数格式错误或缺少仓库上下文"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.deliveryExpectionOrder.detail",
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / id / order_id / orderId",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
},
{
"name": "tableType / tablePosition / type / moduleName",
"type": "string",
"required": false,
"source": "body",
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
}
],
"response": [
{
"name": "order",
"type": "object",
"description": "订单头对象(raw 行数据)"
},
{
"name": "detail",
"type": "object",
"description": "等同于 order"
},
{
"name": "orderItems / items",
"type": "array",
"description": "商品明细数组"
},
{
"name": "expresses",
"type": "array",
"description": "运单信息数组"
},
{
"name": "waybill_codes",
"type": "array",
"description": "去重后的运单号字符串数组"
}
],
"errors": [
{
"code": "400",
"description": "订单ID 为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
},
{
"code": "500",
"description": "内部错误"
}
]
}
]
},
{
"groupName": "订单归档模块",
"module": "order.archiveOrder",
"list": [
{
"method": "order.archiveOrder.list",
"description": "归档订单列表,使用 history 模型。",
"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": "统一 where 条件对象;禁止传入 warehouse_id / warehouseId。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField / sortOrder"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "订单列表(raw 行数据)"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息"
}
],
"errors": [
{
"code": "400",
"description": "参数格式错误或缺少仓库上下文"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "order.archiveOrder.detail",
"description": "查询单个订单详情,返回订单头、商品明细和运单信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids / id / order_id / orderId",
"type": "array|string|number",
"required": true,
"source": "body",
"description": "订单ID;支持 ids 数组、逗号分隔字符串或单个 id/order_id,至少提供一项"
},
{
"name": "tableType / tablePosition / type / moduleName",
"type": "string",
"required": false,
"source": "body",
"description": "可选,指定订单表类型,支持 current/history/dispatch/outsourced/order/revieworder/pendingorder 等"
}
],
"response": [
{
"name": "order",
"type": "object",
"description": "订单头对象(raw 行数据)"
},
{
"name": "detail",
"type": "object",
"description": "等同于 order"
},
{
"name": "orderItems / items",
"type": "array",
"description": "商品明细数组"
},
{
"name": "expresses",
"type": "array",
"description": "运单信息数组"
},
{
"name": "waybill_codes",
"type": "array",
"description": "去重后的运单号字符串数组"
}
],
"errors": [
{
"code": "400",
"description": "订单ID 为空或格式错误"
},
{
"code": "404",
"description": "订单不存在或不属于当前仓库"
},
{
"code": "500",
"description": "内部错误"
}
]
}
]
},
{
"groupName": "订单打印模块",
"module": "order.print",
"list": [
{
"method": "order.print.getWavePrintData",
"description": "按波次 IDs 获取订单打印数据,自动过滤快递未完全分配的波次,返回通过过滤的波次订单明细,按波次号分组",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouse_id",
"type": "number",
"required": true,
"source": "body",
"description": "仓库ID"
},
{
"name": "wave_ids",
"type": "array",
"required": true,
"source": "body",
"description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)"
}
],
"response": [
{
"name": "summary",
"type": "object",
"description": "汇总信息",
"children": [
{
"name": "total_waves",
"type": "number",
"description": "通过过滤的波次总数"
},
{
"name": "total_orders",
"type": "number",
"description": "通过过滤的波次下订单总数"
}
]
},
{
"name": "wave_list",
"type": "array",
"description": "波次列表(按 wave_no 排序)",
"children": [
{
"name": "wave_id",
"type": "number",
"description": "波次ID"
},
{
"name": "wave_no",
"type": "string",
"description": "波次号"
},
{
"name": "order_count",
"type": "number",
"description": "该波次订单数"
},
{
"name": "orders",
"type": "array",
"description": "订单明细列表(含 order_id、order_no、收件信息等字段)",
"children": [
{
"name": "order_id",
"type": "number",
"description": "订单ID"
},
{
"name": "order_no",
"type": "string",
"description": "订单号(delivery_order_code 或 source_order_codes)"
},
{
"name": "receiver",
"type": "object",
"description": "收件信息",
"children": [
{
"name": "name",
"type": "string",
"description": "收件人姓名"
},
{
"name": "mobile",
"type": "string",
"description": "手机号"
},
{
"name": "tel",
"type": "string",
"description": "电话"
},
{
"name": "province",
"type": "string",
"description": "省"
},
{
"name": "city",
"type": "string",
"description": "市"
},
{
"name": "area",
"type": "string",
"description": "区/县"
},
{
"name": "town",
"type": "string",
"description": "镇/街道"
},
{
"name": "detail_address",
"type": "string",
"description": "详细地址"
}
]
},
{
"name": "channel",
"type": "object",
"description": "渠道信息",
"children": [
{
"name": "sys_platform_code",
"type": "string",
"description": "平台编码"
},
{
"name": "sys_platform_name",
"type": "string",
"description": "平台名称"
},
{
"name": "logistics_name",
"type": "string",
"description": "快递名称"
}
]
},
{
"name": "status",
"type": "object",
"description": "订单状态简要",
"children": [
{
"name": "order_status",
"type": "string",
"description": "订单状态"
},
{
"name": "outbound_status",
"type": "string",
"description": "出库状态"
},
{
"name": "print_status",
"type": "string",
"description": "打印状态"
}
]
},
{
"name": "metrics",
"type": "object",
"description": "数量度量",
"children": [
{
"name": "items_count",
"type": "number",
"description": "商品种类数"
},
{
"name": "items_total",
"type": "number",
"description": "商品总件数"
},
{
"name": "items_weight",
"type": "number",
"description": "重量"
}
]
},
{
"name": "times",
"type": "object",
"description": "时间字段",
"children": [
{
"name": "create_at",
"type": "string",
"description": "创建时间"
},
{
"name": "pay_time",
"type": "string",
"description": "支付时间"
}
]
}
]
}
]
},
{
"name": "ext",
"type": "object",
"description": "扩展字段",
"children": [
{
"name": "missing_wave_ids",
"type": "array",
"description": "传入但不存在的 wave_id 列表"
},
{
"name": "filtered_wave_ids",
"type": "array",
"description": "被过滤掉的波次(快递未完全分配),每项含 wave_id、wave_no、reason"
}
]
}
],
"errors": [
{
"code": "400",
"description": "warehouse_id 或 wave_ids 缺失或格式错误"
},
{
"code": "500",
"description": "查询失败"
}
]
}
]
},
{
"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 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;当前支持 id、name、computer_id、custom_barcode。示例:where.name={operator:like,value:热敏}; where.computer_id={operator:eq,value:PC-01}。"
}
],
"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": "setting.warehouse",
"list": [
{
"method": "setting.warehouse.getSettings",
"description": "获取当前登录仓库的 subject_config",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [
{
"name": "warehouse_id",
"type": "number",
"description": "仓库 ID"
},
{
"name": "subject_config",
"type": "object",
"description": "仓库的 subject_config 配置对象"
}
],
"errors": [
{
"code": "400",
"description": "未识别到当前仓库"
},
{
"code": "404",
"description": "仓库不存在"
},
{
"code": "500",
"description": "获取失败"
}
]
},
{
"method": "setting.warehouse.getFieldMeta",
"description": "获取仓库设置字段元信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [
{
"name": "list",
"type": "array",
"description": "字段元信息数组",
"children": [
{
"name": "key",
"type": "string",
"description": "字段 key"
},
{
"name": "name",
"type": "string",
"description": "字段名称"
},
{
"name": "type",
"type": "string",
"description": "字段类型"
},
{
"name": "default",
"type": "any",
"description": "默认值(按字段类型返回)"
},
{
"name": "required",
"type": "boolean",
"description": "是否必填"
},
{
"name": "description",
"type": "string",
"description": "字段描述"
},
{
"name": "options",
"type": "array",
"description": "可选项(仅当 type 为 select/enum 时返回)"
},
{
"name": "min",
"type": "number",
"description": "数值型最小值(可选)"
},
{
"name": "max",
"type": "number",
"description": "数值型最大值(可选)"
},
{
"name": "maxLength",
"type": "number",
"description": "字符串最大长度(可选)"
}
]
}
],
"errors": [
{
"code": "500",
"description": "获取失败"
}
]
},
{
"method": "setting.warehouse.saveSettings",
"description": "修改仓库设置并清理指定仓库缓存",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "subject_config",
"type": "object",
"required": true,
"source": "body",
"description": "仓库的 subject_config 对象"
},
{
"name": "cache_warehouse_id",
"type": "number",
"required": false,
"source": "body",
"description": "需清理缓存的仓库 ID(下划线命名兼容)"
},
{
"name": "cacheWarehouseId",
"type": "number",
"required": false,
"source": "body",
"description": "需清理缓存的仓库 ID(驼峰命名兼容)"
}
],
"response": [
{
"name": "warehouse_id",
"type": "number",
"description": "生效的仓库 ID"
},
{
"name": "subject_config",
"type": "object",
"description": "保存后的 subject_config"
},
{
"name": "cache_cleared_warehouse_id",
"type": "number",
"description": "被清理缓存的仓库 ID(若未清理则为 null)"
}
],
"errors": [
{
"code": "400",
"description": "未识别到当前仓库/参数不合法"
},
{
"code": "404",
"description": "仓库不存在"
},
{
"code": "500",
"description": "保存失败"
}
]
}
]
},
{
"groupName": "平台编码管理模块",
"module": "setting.platform",
"list": [
{
"method": "index.getPlatformList",
"description": "合并后的平台列表",
"isNeedAuth": false,
"isNeedLogin": true,
"params": [],
"response": [],
"errors": []
},
{
"method": "setting.platform.list",
"description": "查询当前仓库范围的平台设置列表",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [],
"errors": []
},
{
"method": "setting.platform.create",
"description": "创建当前仓库范围的平台设置",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [],
"errors": []
},
{
"method": "setting.platform.update",
"description": "更新当前仓库范围的平台设置",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [],
"errors": []
},
{
"method": "setting.platform.delete",
"description": "删除当前仓库范围的平台设置",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [],
"errors": []
}
]
},
{
"groupName": "快递编码管理模块",
"module": "setting.express",
"list": [
{
"method": "index.getExpressList",
"description": "合并后的快递列表",
"isNeedAuth": false,
"isNeedLogin": true,
"params": [],
"response": [],
"errors": []
},
{
"method": "setting.express.list",
"description": "查询当前仓库范围的快递映射列表,支持 where + pagination",
"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,兼容 currentPage / page_size / size"
},
{
"name": "where",
"type": "object",
"required": false,
"source": "body",
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构"
}
],
"response": [],
"errors": []
},
{
"method": "setting.express.listBase",
"description": "返回系统快递基础列表(系统级别基础快递,不含仓库自定义)",
"isNeedAuth": false,
"isNeedLogin": true,
"params": [],
"response": [],
"errors": []
},
{
"method": "setting.express.create",
"description": "创建快递映射,仅写入已实现字段(code、name、platform 等)",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "code",
"type": "string",
"required": true,
"source": "body",
"description": "快递编码"
},
{
"name": "name",
"type": "string",
"required": true,
"source": "body",
"description": "快递名称"
},
{
"name": "platform",
"type": "string",
"required": false,
"source": "body",
"description": "平台标识(可选)"
}
],
"response": [],
"errors": []
},
{
"method": "setting.express.checkCodeUnique",
"description": "校验快递编码在当前仓库/主体维度唯一性,仅支持 code 与可选 id 排除自身",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "code",
"type": "string",
"required": true,
"source": "body",
"description": "待校验的快递编码"
},
{
"name": "id",
"type": "number",
"required": false,
"source": "body",
"description": "排除自身 id(更新时使用)"
}
],
"response": [],
"errors": []
},
{
"method": "setting.express.update",
"description": "更新快递映射,仅更新已实现字段(例如 name、platform)",
"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": "name",
"type": "string",
"required": false,
"source": "body",
"description": "快递名称"
},
{
"name": "platform",
"type": "string",
"required": false,
"source": "body",
"description": "平台标识(可选)"
}
],
"response": [],
"errors": []
},
{
"method": "setting.express.delete",
"description": "批量软删除快递映射;接受 ids 参数,已删除记录会在结果中标记。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"source": "body",
"description": "待删除的映射ID数组;支持数组、逗号字符串或单个ID。"
}
],
"response": [
{
"name": "ids",
"type": "array",
"required": true,
"description": "请求中的所有 id 列表(原样返回)"
},
{
"name": "deleted_ids",
"type": "array",
"required": true,
"description": "本次实际被软删除的 ID 列表(即原本未被删除的 ID)"
},
{
"name": "already_deleted_ids",
"type": "array",
"required": true,
"description": "请求中已处于已删除状态的 ID 列表"
},
{
"name": "status",
"type": "string",
"required": true,
"description": "固定返回 'deleted'"
}
],
"errors": [
{
"code": "400",
"message": "ids 参数不能为空或格式错误"
},
{
"code": "404",
"message": "快递映射不存在或无权限操作"
},
{
"code": "409",
"message": "存在快递接口引用的快递编码,无法删除"
}
]
}
]
},
{
"groupName": "快递接口管理模块",
"module": "setting.expressInterface",
"list": [
{
"method": "setting.expressInterface.list",
"description": "查询当前仓库范围的快递接口列表,支持 where + pagination;返回 data:{ list, total, page, page_size }。每条记录字段见 children。",
"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,兼容 currentPage / page_size / size"
},
{
"name": "where",
"type": "object",
"required": false,
"source": "body",
"description": "统一 where 条件对象;支持字段:id、name、express_code、platform_code、express_platform_id、sender_name、sender_tel、viewer、client_id、share_id、site_code、product_type、shop_name。支持 quickWhere 快速关键词。"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "快递接口记录数组(每项字段如下)",
"children": [
{
"name": "id",
"type": "number",
"description": "记录ID"
},
{
"name": "name",
"type": "string",
"description": "接口名称"
},
{
"name": "express_code",
"type": "string",
"description": "快递编码"
},
{
"name": "warehouse_id",
"type": "number",
"description": "所属仓库ID(文档中的仓库范围由系统强制校验)"
},
{
"name": "platform_code",
"type": "string",
"description": "平台代码"
},
{
"name": "express_platform_id",
"type": "number",
"description": "平台接口ID"
},
{
"name": "sender_name",
"type": "string",
"description": "发件人姓名"
},
{
"name": "sender_tel",
"type": "string",
"description": "发件人电话"
},
{
"name": "weight",
"type": "number",
"description": "默认重量"
},
{
"name": "token",
"type": "string",
"description": "接口密钥或 token(部分记录可能为空)"
},
{
"name": "viewer",
"type": "string",
"description": "查看者标识"
},
{
"name": "client_id",
"type": "string",
"description": "客户端 ID"
},
{
"name": "is_share",
"type": "number",
"description": "是否共享(0/1)"
},
{
"name": "share_id",
"type": "number",
"description": "共享记录ID"
},
{
"name": "can_use_count",
"type": "number",
"description": "可用次数或配额"
},
{
"name": "province_name",
"type": "string",
"description": "省"
},
{
"name": "city_name",
"type": "string",
"description": "市"
},
{
"name": "district_name",
"type": "string",
"description": "区/县"
},
{
"name": "site_code",
"type": "string",
"description": "站点编码"
},
{
"name": "product_type",
"type": "string",
"description": "快递产品类型"
},
{
"name": "shop_name",
"type": "string",
"description": "店铺名称/分组标识"
}
]
},
{
"name": "total",
"type": "number",
"description": "匹配的总记录数"
},
{
"name": "page",
"type": "number",
"description": "当前页"
},
{
"name": "page_size",
"type": "number",
"description": "每页数量"
}
],
"errors": [
{
"code": "400",
"description": "缺少仓库上下文或 where 参数解析失败"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "setting.expressInterface.listByWarehousePlatformCode",
"description": "按 warehouse_id + platform_code 查询快递接口全字段数组,支持缓存;返回结果按 weight 升序、必要时按 id 升序排序,每条记录显式包含 express_code 以及关联的 express 对象(如 express.id/express.code/express.name/express.platform)。该接口不分页,按 warehouse_id + platform_code 全量返回匹配记录。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouse_id / warehouseId",
"type": "number",
"required": false,
"source": "body",
"description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id),也支持显式传入以查询指定仓库,文档兼容 warehouse_id 与 warehouseId 两种写法。"
},
{
"name": "platform_code / platformCode",
"type": "string",
"required": true,
"source": "body",
"description": "平台代码;作为缓存键的一部分,建议使用大写形式(服务端会标准化处理)。"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "快递接口记录数组(按 warehouse_id + platform_code 全量返回,不分页),每项包含以下字段:",
"children": [
{
"name": "id",
"type": "number",
"description": "记录ID"
},
{
"name": "name",
"type": "string",
"description": "接口名称"
},
{
"name": "express_code",
"type": "string",
"description": "快递编码"
},
{
"name": "warehouse_id",
"type": "number",
"description": "所属仓库ID(文档中的仓库范围由系统强制校验)"
},
{
"name": "platform_code",
"type": "string",
"description": "平台代码"
},
{
"name": "express_platform_id",
"type": "number",
"description": "平台接口ID"
},
{
"name": "sender_name",
"type": "string",
"description": "发件人姓名"
},
{
"name": "sender_tel",
"type": "string",
"description": "发件人电话"
},
{
"name": "weight",
"type": "number",
"description": "默认重量"
},
{
"name": "token",
"type": "string",
"description": "接口密钥或 token(部分记录可能为空)"
},
{
"name": "viewer",
"type": "string",
"description": "查看者标识"
},
{
"name": "client_id",
"type": "string",
"description": "客户端 ID"
},
{
"name": "is_share",
"type": "number",
"description": "是否共享(0/1)"
},
{
"name": "share_id",
"type": "number",
"description": "共享记录ID"
},
{
"name": "can_use_count",
"type": "number",
"description": "可用次数或配额"
},
{
"name": "province_name",
"type": "string",
"description": "省"
},
{
"name": "city_name",
"type": "string",
"description": "市"
},
{
"name": "district_name",
"type": "string",
"description": "区/县"
},
{
"name": "site_code",
"type": "string",
"description": "站点编码"
},
{
"name": "product_type",
"type": "string",
"description": "快递产品类型"
},
{
"name": "shop_name",
"type": "string",
"description": "店铺名称/分组标识"
},
{
"name": "express",
"type": "object",
"description": "关联的快递对象(若存在),包含基础快递信息,便于前端展示与回源校验",
"children": [
{
"name": "id",
"type": "number",
"description": "快递主表 ID"
},
{
"name": "code",
"type": "string",
"description": "快递编码"
},
{
"name": "name",
"type": "string",
"description": "快递名称"
},
{
"name": "platform",
"type": "string",
"description": "所属平台标识"
}
]
}
]
}
],
"errors": [
{
"code": "400",
"description": "缺少 platform_code 或仓库上下文错误"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "setting.expressInterface.create",
"description": "在当前仓库范围内创建快递接口,仅写入已实现字段(见 params),仓库由系统自动填充,禁止传入 warehouse_id/warehouseId。",
"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": "express_code",
"type": "string",
"required": true,
"source": "body",
"description": "快递编码(不区分大小写,会在服务端转为大写)"
},
{
"name": "platform_code",
"type": "string",
"required": true,
"source": "body",
"description": "平台代码(不区分大小写,会在服务端转为大写)"
},
{
"name": "express_platform_id",
"type": "number",
"required": true,
"source": "body",
"description": "平台接口 ID"
},
{
"name": "sender_name",
"type": "string",
"required": false,
"source": "body",
"description": "发件人姓名"
},
{
"name": "sender_tel",
"type": "string",
"required": false,
"source": "body",
"description": "发件人电话"
},
{
"name": "weight",
"type": "number",
"required": false,
"source": "body",
"description": "默认重量(可选)"
},
{
"name": "token",
"type": "string",
"required": false,
"source": "body",
"description": "接口密钥或 token"
},
{
"name": "viewer",
"type": "string",
"required": false,
"source": "body",
"description": "查看者标识"
},
{
"name": "client_id",
"type": "string",
"required": false,
"source": "body",
"description": "客户端 ID"
},
{
"name": "is_share",
"type": "number",
"required": false,
"source": "body",
"description": "是否共享(0/1)"
},
{
"name": "share_id",
"type": "number",
"required": false,
"source": "body",
"description": "共享记录 ID"
},
{
"name": "can_use_count",
"type": "number",
"required": false,
"source": "body",
"description": "可用次数/配额"
},
{
"name": "province_name",
"type": "string",
"required": false,
"source": "body",
"description": "省"
},
{
"name": "city_name",
"type": "string",
"required": false,
"source": "body",
"description": "市"
},
{
"name": "district_name",
"type": "string",
"required": false,
"source": "body",
"description": "区/县"
},
{
"name": "site_code",
"type": "string",
"required": false,
"source": "body",
"description": "站点编码"
},
{
"name": "product_type",
"type": "string",
"required": false,
"source": "body",
"description": "快递产品类型"
},
{
"name": "shop_name",
"type": "string",
"required": false,
"source": "body",
"description": "店铺名称/分组标识"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "新建记录 ID"
}
],
"errors": [
{
"code": "400",
"description": "必填参数缺失或参数格式错误"
},
{
"code": "409",
"description": "快递编码或平台接口组合已存在(冲突)"
}
]
},
{
"method": "setting.expressInterface.update",
"description": "更新快递接口,支持局部字段更新;支持 id 别名 interface_id / interfaceId;禁止通过接口修改 warehouse_id。",
"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;兼容 interface_id / interfaceId"
},
{
"name": "name",
"type": "string",
"required": false,
"source": "body",
"description": "接口名称"
},
{
"name": "express_code",
"type": "string",
"required": false,
"source": "body",
"description": "快递编码(更新时会被转为大写)"
},
{
"name": "platform_code",
"type": "string",
"required": false,
"source": "body",
"description": "平台代码(更新时会被转为大写)"
},
{
"name": "express_platform_id",
"type": "number",
"required": false,
"source": "body",
"description": "平台接口 ID"
},
{
"name": "sender_name",
"type": "string",
"required": false,
"source": "body",
"description": "发件人姓名"
},
{
"name": "sender_tel",
"type": "string",
"required": false,
"source": "body",
"description": "发件人电话"
},
{
"name": "weight",
"type": "number",
"required": false,
"source": "body",
"description": "默认重量"
},
{
"name": "token",
"type": "string",
"required": false,
"source": "body",
"description": "接口密钥或 token"
},
{
"name": "viewer",
"type": "string",
"required": false,
"source": "body",
"description": "查看者标识"
},
{
"name": "client_id",
"type": "string",
"required": false,
"source": "body",
"description": "客户端 ID"
},
{
"name": "is_share",
"type": "number",
"required": false,
"source": "body",
"description": "是否共享(0/1)"
},
{
"name": "share_id",
"type": "number",
"required": false,
"source": "body",
"description": "共享记录 ID"
},
{
"name": "can_use_count",
"type": "number",
"required": false,
"source": "body",
"description": "可用次数/配额"
},
{
"name": "province_name",
"type": "string",
"required": false,
"source": "body",
"description": "省"
},
{
"name": "city_name",
"type": "string",
"required": false,
"source": "body",
"description": "市"
},
{
"name": "district_name",
"type": "string",
"required": false,
"source": "body",
"description": "区/县"
},
{
"name": "site_code",
"type": "string",
"required": false,
"source": "body",
"description": "站点编码"
},
{
"name": "product_type",
"type": "string",
"required": false,
"source": "body",
"description": "快递产品类型"
},
{
"name": "shop_name",
"type": "string",
"required": false,
"source": "body",
"description": "店铺名称/分组标识"
}
],
"response": [
{
"name": "id",
"type": "number",
"description": "首条更新记录 ID"
},
{
"name": "name",
"type": "string",
"description": "更新后的接口名称"
}
],
"errors": [
{
"code": "400",
"description": "id 为空或无可更新字段"
},
{
"code": "404",
"description": "快递接口不存在或无权限操作"
},
{
"code": "409",
"description": "快递编码或平台接口组合冲突"
}
]
},
{
"method": "setting.expressInterface.delete",
"description": "删除快递接口,支持 id 别名 interface_id / interfaceId;返回被删除记录 id 与所属 warehouse_id。",
"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;兼容 interface_id / interfaceId"
}
],
"response": [
{
"name": "id",
"type": "number",
"description": "已删除记录 ID"
},
{
"name": "warehouse_id",
"type": "number",
"description": "记录所属仓库 ID"
},
{
"name": "deleted",
"type": "boolean",
"description": "是否已删除,成功时为 true"
}
],
"errors": [
{
"code": "400",
"description": "id 为空或格式错误"
},
{
"code": "404",
"description": "快递接口不存在或无权限操作"
}
]
}
]
},
{
"groupName": "账号管理模块",
"module": "setting.account",
"list": [
{
"method": "setting.account.list",
"description": "查询当前主体下的工号基础信息列表",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "status",
"type": "number",
"required": false,
"source": "body",
"description": "状态筛选,默认 1,仅查有效工号"
},
{
"name": "includeDisabled",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否包含已删除工号"
}
],
"response": [
{
"name": "data[]",
"type": "object",
"required": true,
"description": "工号列表项"
},
{
"name": "data[].employee_id",
"type": "number",
"required": true,
"description": "工号ID"
},
{
"name": "data[].account_id",
"type": "number",
"required": true,
"description": "账号ID"
},
{
"name": "data[].store_id",
"type": "number",
"required": true,
"description": "主体ID"
},
{
"name": "data[].real_name",
"type": "string",
"required": true,
"description": "工号姓名"
},
{
"name": "data[].status",
"type": "number",
"required": true,
"description": "工号状态:1=启用,0=停用"
},
{
"name": "data[].username",
"type": "string",
"required": true,
"description": "账号用户名"
},
{
"name": "data[].phone",
"type": "string",
"required": true,
"description": "账号手机号"
},
{
"name": "data[].email",
"type": "string",
"required": true,
"description": "账号邮箱"
},
{
"name": "data[].avatar_file_id",
"type": "number",
"required": false,
"description": "头像文件ID,为空表示未设置"
},
{
"name": "data[].avatar_url",
"type": "string",
"required": true,
"description": "头像访问地址"
}
],
"errors": [
{
"code": "400",
"description": "当前登录态缺少主体上下文(store_id)"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "setting.account.add",
"description": "新增工号,按手机号复用或创建账号后绑定到当前主体",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "phone",
"type": "string",
"required": true,
"source": "body",
"description": "手机号,作为账号复用/创建依据"
},
{
"name": "real_name",
"type": "string",
"required": true,
"source": "body",
"description": "工号姓名,新增时禁止直接使用保留名称"
},
{
"name": "username",
"type": "string",
"required": false,
"source": "body",
"description": "新账号用户名,不传时系统自动生成"
},
{
"name": "password",
"type": "string",
"required": false,
"source": "body",
"description": "新账号密码,不传默认 111111"
},
{
"name": "role_id",
"type": "number",
"required": false,
"source": "body",
"description": "工号角色,不传时继承当前操作人工号角色"
},
{
"name": "email",
"type": "string",
"required": false,
"source": "body",
"description": "新账号邮箱,不传时按 username 自动生成"
}
],
"response": [
{
"name": "employee_id",
"type": "number",
"required": true,
"description": "新增或复用后的工号ID"
},
{
"name": "account_id",
"type": "number",
"required": true,
"description": "绑定账号ID"
},
{
"name": "role_id",
"type": "number",
"required": true,
"description": "绑定后的角色ID"
},
{
"name": "is_new_account",
"type": "boolean",
"required": true,
"description": "是否为本次新建账号"
},
{
"name": "phone",
"type": "string",
"required": true,
"description": "绑定账号手机号"
},
{
"name": "username",
"type": "string",
"required": true,
"description": "绑定账号用户名"
}
],
"errors": [
{
"code": "400",
"description": "参数错误、手机号格式错误、或直接使用保留名称"
},
{
"code": "409",
"description": "手机号对应账号已禁用、手机号已绑定当前主体工号、或用户名重复"
},
{
"code": "500",
"description": "新增失败"
}
]
},
{
"method": "setting.account.delete",
"description": "删除工号绑定关系,仅停用工号,不删除账号",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "employee_id",
"type": "number",
"required": true,
"source": "body",
"description": "要删除的工号ID"
}
],
"response": [
{
"name": "employee_id",
"type": "number",
"required": true,
"description": "被停用的工号ID"
},
{
"name": "account_id",
"type": "number",
"required": true,
"description": "关联账号ID"
},
{
"name": "status",
"type": "string",
"required": true,
"description": "固定返回 deleted"
},
{
"name": "already_deleted",
"type": "boolean",
"required": false,
"description": "可选,true 表示该工号原本已停用"
}
],
"errors": [
{
"code": "400",
"description": "参数错误或尝试删除当前登录工号"
},
{
"code": "404",
"description": "工号不存在或无权限删除"
},
{
"code": "500",
"description": "删除失败"
}
]
},
{
"method": "setting.account.update",
"description": "更新工号姓名和头像引用",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "employee_id",
"type": "number",
"required": true,
"source": "body",
"description": "要更新的工号ID"
},
{
"name": "real_name",
"type": "string",
"required": false,
"source": "body",
"description": "更新后的工号姓名"
},
{
"name": "file_id",
"type": "number",
"required": false,
"source": "body",
"description": "已有文件ID,作为头像引用"
}
],
"response": [
{
"name": "employee_id",
"type": "number",
"required": true,
"description": "更新后的工号ID"
},
{
"name": "real_name",
"type": "string",
"required": true,
"description": "更新后的工号姓名"
},
{
"name": "avatar_file_id",
"type": "number",
"required": false,
"description": "更新后的头像文件ID"
},
{
"name": "avatar_url",
"type": "string",
"required": true,
"description": "更新后的头像地址"
}
],
"errors": [
{
"code": "400",
"description": "参数错误,未提供更新项"
},
{
"code": "404",
"description": "工号或头像文件不存在"
},
{
"code": "500",
"description": "更新失败"
}
]
},
{
"method": "setting.account.getBindWechatCode",
"description": "为指定工号账号获取微信绑定码",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "account_id",
"type": "number",
"required": true,
"source": "body",
"description": "目标账号ID,兼容 user_id / id"
},
{
"name": "longPoll",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否开启长轮询等待状态变化,最长60秒"
},
{
"name": "waitTimeoutMs",
"type": "number",
"required": false,
"source": "body",
"description": "等待超时毫秒数,后端自动封顶60000"
}
],
"response": [],
"errors": []
},
{
"method": "setting.account.unbindWechat",
"description": "为指定工号账号解绑微信",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "account_id",
"type": "number",
"required": true,
"source": "body",
"description": "目标账号ID,兼容 user_id / id"
}
],
"response": [],
"errors": []
}
]
},
{
"groupName": "权限管理模块",
"module": "setting.permission",
"list": [
{
"method": "setting.permission.list",
"description": "查询权限树/权限列表,可附带指定角色的选中状态",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "role_id",
"type": "number",
"required": false,
"source": "body",
"description": "角色ID;传入后返回 selected 标记"
},
{
"name": "type",
"type": "string",
"required": false,
"source": "body",
"description": "权限类型筛选:web_pages/pda_pages/btns/api/miniprogram_pages/block"
},
{
"name": "keyword",
"type": "string",
"required": false,
"source": "body",
"description": "关键字模糊搜索 path/name/meta_title"
},
{
"name": "includeDisabled",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否包含已停用权限"
}
],
"response": [],
"errors": []
},
{
"method": "setting.permission.add",
"description": "新增权限节点",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "path",
"type": "string",
"required": true,
"source": "body",
"description": "权限路径"
},
{
"name": "type",
"type": "string",
"required": true,
"source": "body",
"description": "权限类型"
},
{
"name": "name",
"type": "string",
"required": false,
"source": "body",
"description": "权限名称"
},
{
"name": "parent_id",
"type": "number",
"required": false,
"source": "body",
"description": "父级权限ID"
}
],
"response": [],
"errors": []
},
{
"method": "setting.permission.update",
"description": "更新权限节点信息",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "permission_id",
"type": "number",
"required": true,
"source": "body",
"description": "权限ID"
}
],
"response": [],
"errors": []
},
{
"method": "setting.permission.delete",
"description": "批量停用权限节点",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"source": "body",
"description": "待停用的权限ID数组"
}
],
"response": [],
"errors": []
}
]
},
{
"groupName": "角色管理模块",
"module": "setting.role",
"list": [
{
"method": "setting.role.list",
"description": "获取当前主体可管理的角色树",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "includeDisabled",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否包含已停用角色"
},
{
"name": "includeSystem",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否包含系统角色域"
}
],
"response": [],
"errors": []
},
{
"method": "setting.role.permission",
"description": "获取角色权限树(兼容旧入口,等同于 setting.permission.list)",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "role_id",
"type": "number",
"required": false,
"source": "body",
"description": "角色ID"
}
],
"response": [],
"errors": []
},
{
"method": "setting.role.add",
"description": "新增角色并绑定权限集合",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "role_code",
"type": "string",
"required": true,
"source": "body",
"description": "角色编码"
},
{
"name": "role_name",
"type": "string",
"required": true,
"source": "body",
"description": "角色名称"
},
{
"name": "permission_ids",
"type": "array",
"required": true,
"source": "body",
"description": "权限ID数组,支持 [\"*\"]"
},
{
"name": "pid",
"type": "number",
"required": false,
"source": "body",
"description": "父角色ID"
}
],
"response": [],
"errors": []
},
{
"method": "setting.role.update",
"description": "更新角色信息并重设权限集合",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "role_id",
"type": "number",
"required": true,
"source": "body",
"description": "角色ID"
},
{
"name": "permission_ids",
"type": "array",
"required": true,
"source": "body",
"description": "权限ID数组,角色权限需一次性提交"
}
],
"response": [],
"errors": []
},
{
"method": "setting.role.delete",
"description": "批量停用角色",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array",
"required": true,
"source": "body",
"description": "待停用的角色ID数组"
}
],
"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 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、barcode、prohibited_type 等商品筛选字段。示例:where.barcode={operator:like,value:69}; where.prohibited_type={operator:eq,value:liquid}。"
}
],
"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.getStockDetail",
"description": "按库位/批次维度查询商品库存分布",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "stock_id",
"type": "number",
"required": true,
"source": "body",
"description": "商品库存ID(stock_warehouse.id)"
},
{
"name": "pagination",
"type": "object",
"required": false,
"source": "body",
"description": "分页参数,包含 page/pageSize"
},
{
"name": "group_by_batch",
"type": "boolean",
"required": false,
"source": "body",
"default": false,
"description": "是否按批次返回明细;true 返回每条明细,false 按库位合并"
}
],
"response": [
{
"name": "stockItem",
"type": "object",
"description": "商品概要,包含 id、item_code、item_name、sku_property、stock_unit、quantity、locked_quantity 等"
},
{
"name": "storageList",
"type": "array",
"description": "库存明细数组;group_by_batch=true 返回 wms_storage 明细(含 batch_no、production_date、expiry_date、inbound_time、inbound_order_no、supplier_batch_no 等),group_by_batch=false 时按库位合并,批次相关字段为 null"
},
{
"name": "pagination",
"type": "object",
"description": "分页信息,包含 page、pageSize、total"
}
],
"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": "warehouse_id",
"type": "number",
"required": true,
"source": "body",
"description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id)"
},
{
"name": "item_code",
"type": "string",
"required": true,
"source": "body",
"description": "要检测的商品编码"
},
{
"name": "item_id",
"type": "number",
"required": false,
"source": "body",
"description": "当前商品ID(编辑场景用,排除自身);兼容字段名 id"
},
{
"name": "id",
"type": "number",
"required": false,
"source": "body",
"description": "兼容字段 id"
},
{
"name": "owner_id",
"type": "number",
"required": true,
"source": "body",
"description": "货主ID(对应表字段 store_id);兼容字段名 store_id"
},
{
"name": "store_id",
"type": "number",
"required": true,
"source": "body",
"description": "兼容字段 store_id"
}
],
"response": [
{
"name": "unique",
"type": "boolean",
"description": "true 表示编码唯一,false 表示已存在重复"
},
{
"name": "isUnique",
"type": "boolean",
"description": "同 unique(兼容旧字段名)"
},
{
"name": "message",
"type": "string",
"description": "重复时返回 '商品编码已存在',唯一时不返回该字段",
"required": false
}
],
"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": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "keyword",
"type": "string",
"required": false,
"source": "body",
"description": "搜索关键字,模糊匹配 item_code、item_name、goods_code 以及关联的 barcode;为空时返回全部(仍受 limit 50 限制)"
},
{
"name": "store_id",
"type": "number",
"required": false,
"source": "body",
"description": "货主ID,传入时仅返回指定货主的商品"
},
{
"name": "with_stock",
"type": "boolean",
"required": false,
"source": "body",
"default": false,
"description": "是否返回关联库存数据(wms_storage),为 true 时每条商品新增 storage[] 字段"
},
{
"name": "is_batch",
"type": "boolean",
"required": false,
"source": "body",
"default": false,
"description": "是否按批次明细返回库存,仅 with_stock=true 时生效。false(默认)按库位分组汇总;true 逐条返回批次明细"
}
],
"response": [
{
"name": "code",
"type": "number",
"description": "业务状态码,200 表示成功"
},
{
"name": "data",
"type": "array",
"description": "商品列表,每项包含以下字段",
"children": [
{
"name": "id",
"type": "number",
"description": "商品库存ID(stock_warehouse.id)"
},
{
"name": "item_code",
"type": "string",
"description": "商品编码"
},
{
"name": "goods_code",
"type": "string",
"description": "货物编码"
},
{
"name": "item_name",
"type": "string",
"description": "商品名称"
},
{
"name": "sku_property",
"type": "string",
"description": "SKU 规格"
},
{
"name": "stock_unit",
"type": "string",
"description": "库存单位"
},
{
"name": "quantity",
"type": "number",
"description": "库存数量"
},
{
"name": "locked_quantity",
"type": "number",
"description": "锁定数量"
},
{
"name": "brand_name",
"type": "string",
"description": "品牌名称"
},
{
"name": "item_type",
"type": "string",
"description": "商品类型"
},
{
"name": "barcodes",
"type": "array",
"description": "商品条形码列表(string[])"
},
{
"name": "store_stock",
"type": "object",
"description": "关联的货主签约信息(LEFT JOIN),含 store_id、store_remask;无签约时为 null"
},
{
"name": "is_shelf_life_mgmt",
"type": "boolean",
"description": "是否启用效期管理(true=启用)"
},
{
"name": "shelf_life_days",
"type": "number",
"description": "商品标准效期/保质期(单位:天)"
},
{
"name": "inbound_min_days",
"type": "number",
"description": "入库后最小可出库天数(单位:天)"
},
{
"name": "outbound_min_days",
"type": "number",
"description": "出库前需保留的最小天数(单位:天)"
},
{
"name": "remaining_threshold_days",
"type": "number",
"description": "剩余天数阈值,低于该值视为即将过期(单位:天)"
},
{
"name": "storage",
"type": "array",
"description": "关联库存明细,仅 with_stock=true 时返回。is_batch=false 时按库位分组汇总,is_batch=true 时逐条返回批次明细",
"children_grouped": {
"description": "is_batch=false(默认):按库位分组汇总,每条包含以下字段",
"fields": [
{
"name": "space_id",
"type": "number",
"description": "库位ID"
},
{
"name": "inventory_type",
"type": "string",
"description": "库存类型"
},
{
"name": "quantity",
"type": "number",
"description": "该库位总库存数量(合并同库位)"
},
{
"name": "locked_quantity",
"type": "number",
"description": "该库位总锁定数量"
},
{
"name": "available_quantity",
"type": "number",
"description": "可用数量(quantity - locked_quantity)"
},
{
"name": "space",
"type": "object",
"description": "库位信息子对象,含 id、space_code、custom_name"
}
]
},
"children_batch": {
"description": "is_batch=true:逐条批次明细,每条包含以下字段",
"fields": [
{
"name": "id",
"type": "number",
"description": "storage 记录ID"
},
{
"name": "stock_id",
"type": "number",
"description": "关联的商品库存ID"
},
{
"name": "space_id",
"type": "number",
"description": "库位ID"
},
{
"name": "batch_no",
"type": "string",
"description": "批次号"
},
{
"name": "inventory_type",
"type": "string",
"description": "库存类型"
},
{
"name": "quantity",
"type": "number",
"description": "库存数量"
},
{
"name": "locked_quantity",
"type": "number",
"description": "锁定数量"
},
{
"name": "available_quantity",
"type": "number",
"description": "可用数量"
},
{
"name": "production_date",
"type": "string",
"description": "生产日期"
},
{
"name": "expiry_date",
"type": "string",
"description": "过期日期"
},
{
"name": "inbound_time",
"type": "string",
"description": "入库时间"
},
{
"name": "inbound_order_no",
"type": "string",
"description": "入库单号"
},
{
"name": "supplier_batch_no",
"type": "string",
"description": "供应商批次号"
},
{
"name": "created_at",
"type": "string",
"description": "记录创建时间"
},
{
"name": "space",
"type": "object",
"description": "库位信息子对象,含 id、space_code、custom_name"
}
]
}
}
]
},
{
"name": "total",
"type": "number",
"description": "本次返回的记录条数(≤50)"
}
],
"errors": []
}
]
},
{
"groupName": "拣货模块",
"module": "pick",
"list": [
{
"method": "pick.query",
"description": "按订单查询波次拣货信息,支持 full/full_display/is_full 控制是否完整显示;接口按当前登录用户仓库上下文过滤,防止跨仓越界。",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "waybill_code",
"type": "string",
"required": true,
"source": "body",
"description": "快递号/运单号,必填。"
},
{
"name": "full_display",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否完整显示拣货明细;默认 false。true 返回全部拣货明细,false 仅返回未完成的(inspection_status != 'fin')。"
}
],
"response": [
{
"name": "order_id",
"type": "string|number",
"description": "订单 ID"
},
{
"name": "wave_id",
"type": "number",
"description": "波次 ID(若订单未关联波次则为空)"
},
{
"name": "wave_no",
"type": "string",
"description": "波次编号(若订单未关联波次则为空)"
},
{
"name": "full_display",
"type": "boolean",
"description": "是否以完整明细展示(等同于请求中的 full/full_display/is_full)"
},
{
"name": "summary",
"type": "object",
"description": "汇总信息",
"children": [
{
"name": "total_count",
"type": "number",
"description": "明细总行数"
},
{
"name": "pending_review_count",
"type": "number",
"description": "待复核行数"
},
{
"name": "reviewed_count",
"type": "number",
"description": "已复核行数"
},
{
"name": "quantity_total",
"type": "number",
"description": "明细总件数"
},
{
"name": "display_count",
"type": "number",
"description": "展示行数(受 full 参数影响)"
},
{
"name": "display_quantity_total",
"type": "number",
"description": "展示的总件数(受 full 参数影响)"
}
]
},
{
"name": "list",
"type": "array",
"description": "拣货明细列表(根据 full 参数返回全量或仅未复核明细),每项为明细对象,字段视实现而定。"
}
],
"errors": [
{
"code": "400",
"description": "order_id 为空或订单无波次号"
},
{
"code": "404",
"description": "订单不存在"
},
{
"code": "500",
"description": "内部错误"
}
]
}
]
},
{
"groupName": "收货单模块",
"module": "storage_receiving",
"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": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、status、store_id、日期区间等字段。示例:where.status={operator:eq,value:finished}; where.store_id={operator:eq,value:1001}; where.create_time_start={value:2026-03-01}。"
}
],
"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)"
},
{
"name": "receiving.details",
"type": "array",
"required": false,
"description": "收货单明细列表,单条记录包含明细字段(见下文)"
},
{
"name": "receiving.details.*.box_remainder",
"type": "number",
"required": false,
"description": "箱内剩余数量/零散数量(不满箱时的件数)"
},
{
"name": "receiving.details.*.box_weight",
"type": "number",
"required": false,
"description": "实测箱重(单位与系统重量一致,如 kg)"
}
],
"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.rejectReceiving",
"description": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.",
"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数组,所有收货单必须属于当前仓库且状态为 completed,否则整批拒绝"
},
{
"name": "remark",
"type": "string",
"required": false,
"source": "body",
"description": "驳回理由,覆盖收货单原备注字段;不传则保留原备注"
}
],
"response": [
{
"name": "count",
"type": "number",
"description": "成功驳回的收货单数量"
}
],
"errors": [
{
"code": "0",
"description": "ids 为空、部分单据不存在/无权访问,或存在非 completed 状态的收货单"
},
{
"code": "500",
"description": "服务器错误"
}
]
},
{
"method": "storage.receiving.reviewReceiving",
"description": "批量审核收货单:校验所有单据满足条件(收货完成、全部匹配、未入库、已绑定货主、未审核)后统一审核,任意一张不符合则整批失败回滚。审核人信息自动取当前登录用户上下文,无需传入.",
"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数组,所有单据必须满足:status=completed、detail_status=all_matched、storage_status=none、store_id 已绑定、is_review=0,否则整批拒绝"
}
],
"response": [
{
"name": "count",
"type": "number",
"description": "成功审核的收货单数量"
}
],
"errors": [
{
"code": "0",
"description": "ids 为空、单据不存在/无权访问,或不满足审核条件(含并发冲突)"
},
{
"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.bindStore",
"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"
},
{
"name": "store_id",
"type": "number",
"required": true,
"source": "body",
"description": "货主ID(必须与当前仓库存在有效签约关系)"
}
],
"response": [
{
"name": "data.id",
"type": "number",
"required": true,
"description": "收货单ID"
},
{
"name": "data.store_id",
"type": "number",
"required": true,
"description": "已绑定的货主ID"
},
{
"name": "data.store_name",
"type": "string",
"required": false,
"description": "货主名称/签约备注名"
},
{
"name": "data.status",
"type": "string",
"required": true,
"description": "当前收货单状态"
}
],
"errors": [
{
"code": "400",
"description": "用户未绑定仓库、收货单ID/货主ID为空、已取消或已绑定货主"
},
{
"code": "404",
"description": "收货单不存在/无权访问,或货主与当前仓库未建立有效签约关系"
},
{
"code": "500",
"description": "绑定货主失败"
}
]
},
{
"method": "storage.receiving.bindDetailProduct",
"description": "收货单明细绑定或改绑系统商品",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "detail_id",
"type": "number",
"required": true,
"source": "body",
"description": "收货单明细ID(兼容字段 `id`)"
},
{
"name": "system_product_id",
"type": "number",
"required": true,
"source": "body",
"description": "系统商品ID(`StockWarehouse.id`,且必须属于当前仓库)"
}
],
"response": [
{
"name": "data.detail_id",
"type": "number",
"required": true,
"description": "收货单明细ID"
},
{
"name": "data.receiving_id",
"type": "number",
"required": true,
"description": "收货单ID"
},
{
"name": "data.system_product_id",
"type": "number",
"required": true,
"description": "已绑定的系统商品ID"
},
{
"name": "data.product_name",
"type": "string",
"required": true,
"description": "自动回填的商品名称"
}
],
"errors": [
{
"code": "400",
"description": "用户未绑定仓库、明细ID/商品ID为空,收货单状态不允许绑定/改绑,或收货单已审核禁止绑定/改绑"
},
{
"code": "404",
"description": "收货单明细不存在,或商品不存在/不属于当前仓库"
},
{
"code": "500",
"description": "绑定商品失败"
}
]
},
{
"method": "storage.receiving.queryReceivingLogs",
"description": "按收货单ID查询操作日志列表(分页),仅返回当前仓库上下文数据",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number|string",
"required": false,
"source": "body",
"description": "收货单ID(与 receiving_id 二选一)"
},
{
"name": "receiving_id",
"type": "number|string",
"required": false,
"source": "body",
"description": "收货单ID(兼容字段,与 id 二选一)"
},
{
"name": "page",
"type": "number",
"required": false,
"source": "body",
"description": "页码(兼容顶层分页入参)"
},
{
"name": "pageSize",
"type": "number",
"required": false,
"source": "body",
"description": "每页数量(兼容顶层分页入参)"
},
{
"name": "pagination",
"type": "object",
"required": false,
"source": "body",
"description": "分页参数,支持 page / pageSize"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "日志列表"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息,包含 page、pageSize、total、totalPages"
}
],
"errors": [
{
"code": "400",
"description": "收货单ID为空或仓库上下文缺失"
},
{
"code": "500",
"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.save",
"description": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。",
"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,按该ID修改当前仓库下的收货单"
},
{
"name": "delivery_method",
"type": "string",
"required": false,
"source": "body",
"description": "到货方式:truck/express/air_freight/sea_freight/other;不传则保持原值"
},
{
"name": "loading_method",
"type": "string",
"required": false,
"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": "物流单号;当 delivery_method 为 express/air_freight/sea_freight 时可更新,truck/other 场景会被清空或忽略"
},
{
"name": "store_id",
"type": "number",
"required": false,
"source": "body",
"description": "货主ID;若传入,会校验当前仓库下签约关系并同步更新货主名称;传 0/null 可清空货主"
},
{
"name": "total_boxes",
"type": "number",
"required": false,
"source": "body",
"description": "总箱数,默认 0"
},
{
"name": "total_pallets",
"type": "number",
"required": false,
"source": "body",
"description": "总托盘数,默认 0"
},
{
"name": "remark",
"type": "string",
"required": false,
"source": "body",
"description": "备注信息"
},
{
"name": "status",
"type": "string",
"required": false,
"source": "body",
"description": "收货单状态;不传则保持原值"
},
{
"name": "video_device_id",
"type": "string",
"required": false,
"source": "body",
"description": "录像设备ID"
}
],
"response": [
{
"name": "code",
"type": "number",
"required": true,
"description": "业务状态码;200 表示修改成功"
},
{
"name": "id",
"type": "number",
"required": true,
"description": "修改的收货单ID"
},
{
"name": "receiving_number",
"type": "string",
"required": true,
"description": "收货单号"
},
{
"name": "message",
"type": "string",
"required": true,
"description": "结果描述;成功时通常为收货单修改成功"
}
],
"errors": [
{
"code": "400",
"description": "收货单ID不能为空、已取消的收货单不允许修改或用户未绑定仓库"
},
{
"code": "404",
"description": "收货单不存在/无权访问,或指定货主不存在/未与当前仓库建立有效签约关系"
},
{
"code": "0",
"description": "修改失败,如字段枚举不合法或数据库写入异常"
}
]
},
{
"method": "storage.receiving.get",
"description": "storage.receiving.get 接口",
"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": "code",
"type": "number",
"description": "业务状态码,200 表示成功"
},
{
"name": "message",
"type": "string",
"description": "返回信息"
},
{
"name": "data",
"type": "object",
"description": "收货单详情对象,包含 details(明细数组)、images 及主表字段"
},
{
"name": "data.details",
"type": "array",
"description": "收货单明细数组(每项为明细对象)"
},
{
"name": "data.details.*.box_remainder",
"type": "number",
"required": false,
"description": "箱内剩余数量/零散数量(不满箱时的件数),默认 0"
},
{
"name": "data.details.*.box_weight",
"type": "number",
"required": false,
"description": "实测箱重(单位与系统重量一致,如 kg),默认 0"
}
],
"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": "修改收货单明细(数量/箱规/批次/商品信息回写等)",
"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": "receiving_id",
"type": "number",
"required": true,
"source": "body",
"description": "收货单ID"
},
{
"name": "actual_quantity",
"type": "number",
"required": false,
"source": "body",
"description": "实际收货数量"
},
{
"name": "batch_number",
"type": "string",
"required": false,
"source": "body",
"description": "批次号"
},
{
"name": "production_date",
"type": "string",
"required": false,
"source": "body",
"description": "生产日期(可解析的日期字符串)"
},
{
"name": "expiry_date",
"type": "string",
"required": false,
"source": "body",
"description": "到期日期(可解析的日期字符串)。若早于当前日期,接口会返回 400 并拒绝录入。"
},
{
"name": "box_quantity",
"type": "number",
"required": false,
"source": "body",
"description": "箱数"
},
{
"name": "boxes_per_pallet",
"type": "number",
"required": false,
"source": "body",
"description": "每托盘箱数"
},
{
"name": "pallet_quantity",
"type": "number",
"required": false,
"source": "body",
"description": "托盘数"
},
{
"name": "space_id",
"type": "number",
"required": false,
"source": "body",
"description": "库位 ID(可回写)"
},
{
"name": "remark",
"type": "string",
"required": false,
"source": "body",
"description": "备注"
},
{
"name": "system_product_id",
"type": "number",
"required": false,
"source": "body",
"description": "系统商品 ID(StockWarehouse.id)。若提供,服务端会尝试回填 barcode/weight/箱规/product_name/product_snapshot 等。"
},
{
"name": "barcode",
"type": "string",
"required": false,
"source": "body",
"description": "条码(未传 system_product_id 时可单独更新)"
},
{
"name": "product_name",
"type": "string",
"required": false,
"source": "body",
"description": "商品名称(未传 system_product_id 时可单独更新)"
},
{
"name": "box_width",
"type": "number",
"required": false,
"source": "body",
"description": "箱宽"
},
{
"name": "box_height",
"type": "number",
"required": false,
"source": "body",
"description": "箱高"
},
{
"name": "box_length",
"type": "number",
"required": false,
"source": "body",
"description": "箱长"
},
{
"name": "box_remainder",
"type": "number",
"required": false,
"source": "body",
"description": "箱内剩余数量/零散数量(不满箱时的件数)"
},
{
"name": "box_weight",
"type": "number",
"required": false,
"source": "body",
"description": "实测箱重(单位与系统重量一致,如 kg)"
},
{
"name": "weight",
"type": "number",
"required": false,
"source": "body",
"description": "毛重/重量"
}
],
"response": [
{
"name": "data.id",
"type": "number",
"required": true,
"description": "收货明细 ID"
},
{
"name": "data.receiving_id",
"type": "number",
"required": true,
"description": "收货单 ID"
},
{
"name": "data.actual_quantity",
"type": "number",
"required": false,
"description": "实际收货数量"
},
{
"name": "data.product_name",
"type": "string",
"required": false,
"description": "商品名称"
},
{
"name": "data.barcode",
"type": "string",
"required": false,
"description": "条码"
},
{
"name": "data.system_product_id",
"type": "number",
"required": false,
"description": "系统商品 ID"
},
{
"name": "data.box_remainder",
"type": "number",
"required": false,
"description": "箱内剩余数量/零散数量(不满箱时的件数)"
},
{
"name": "data.box_weight",
"type": "number",
"required": false,
"description": "实测箱重(单位与系统重量一致,如 kg)"
},
{
"name": "data.updated_at",
"type": "string",
"required": false,
"description": "记录更新时间(ISO)"
}
],
"errors": [
{
"code": "400",
"description": "收货明细ID不能为空 / 收货单ID不能为空 / 到期日期已过期,不能录入收货 / 箱数/托盘数不能为负数等参数校验失败"
},
{
"code": "404",
"description": "收货明细不存在或无权访问"
},
{
"code": "500",
"description": "服务器错误或修改失败"
}
]
},
{
"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": [],
"notes": [
"完成收货时会发送通知:通知 payload 或 metadata 将在每条明细中携带 box_remainder(箱内剩余数量/零散件数,number)与 box_weight(实测箱重,number,单位同系统重量,例如 kg)。新增字段为可选,旧客户端可忽略。"
],
"errors": []
}
]
},
{
"groupName": "入库单模块",
"module": "storage.entry",
"list": [
{
"method": "storage.entry.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": "分页参数,支持 page/pageSize"
},
{
"name": "where",
"type": "object",
"required": false,
"source": "body",
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、order_status、store_id、order_type、日期区间等字段。示例:where.order_status={operator:eq,value:waiting}; where.order_type={operator:eq,value:purchase}; where.create_time_start={value:2026-03-01}。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField/sortOrder"
}
],
"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、pending、creating、created、completed、cancelled)"
}
],
"errors": [
{
"code": "400",
"description": "筛选条件格式错误"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "storage.entry.get",
"description": "查询入库单详情",
"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,与 entry_order_code 二选一"
},
{
"name": "entry_order_code",
"type": "string",
"required": false,
"source": "body",
"description": "入库单号,与 id 二选一"
}
],
"response": [
{
"name": "entryOrder",
"type": "object",
"required": true,
"description": "入库单详情(含 items 明细)"
}
],
"errors": [
{
"code": "400",
"description": "id 与 entry_order_code 均未传"
},
{
"code": "0",
"description": "无记录或无权访问"
}
]
},
{
"method": "storage.entry.cancel",
"description": "作废入库单(支持单条或批量作废)",
"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,兼容旧调用;与 `ids` 二选一。若同时传入 `ids`,以 `ids` 为准。"
},
{
"name": "ids",
"type": "array",
"required": false,
"source": "body",
"description": "入库单ID数组(number[]),用于批量作废;必须为非空数组,建议批量操作使用 `ids`,优先于 `id`。"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": false,
"description": "单条作废时返回的入库单ID"
},
{
"name": "ids",
"type": "array",
"required": false,
"description": "批量作废时返回的已成功作废入库单ID数组(number[])"
}
],
"errors": [
{
"code": "400",
"description": "参数错误/参数不合法:需传入非空的 `id` 或 `ids`;`ids` 必须为数字数组且不得包含非法或重复值"
},
{
"code": "404",
"description": "入库单不存在或无权访问"
}
]
},
{
"method": "storage.entry.completeEntry",
"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": "参数不合法、已作废或缺少明细"
},
{
"code": "404",
"description": "入库单不存在或无权访问"
}
]
}
]
},
{
"groupName": "出库单模块",
"module": "storage.stockout",
"list": [
{
"method": "storage.stockout.list",
"name": "出库单列表",
"description": "非订单出库单能力(对应奇门 stockout.create):用于处理由奇门创建的非订单出库单;主出口为 storage.stockout.*,不再推荐通过 storage.delivery.* 命名使用。storage.delivery.* 仅保留兼容转发。",
"isNeedAuth": false,
"isNeedLogin": true,
"isNeedRight": false,
"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": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;常用字段包括 delivery_order_code、status、outbound_status、buyer_nick、mobile 与日期区间字段。"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数,支持 sortField/sortOrder,默认按 updated_at DESC、id DESC"
}
],
"response": [
{
"name": "list",
"type": "array",
"required": true,
"description": "出库单列表"
},
{
"name": "pagination",
"type": "object",
"required": true,
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
}
],
"errors": [
{
"code": "400",
"description": "筛选条件格式错误"
},
{
"code": "500",
"description": "查询失败"
}
]
},
{
"method": "storage.stockout.toOrder",
"name": "出库单转订单(占位)",
"description": "占位接口,暂未开放。当前仅保留方法名用于后续扩展,逻辑暂不能使用。参数 id / delivery_order_code 暂未启用。",
"isNeedAuth": false,
"isNeedLogin": true,
"isNeedRight": false,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": false,
"source": "body",
"description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。"
},
{
"name": "delivery_order_code",
"type": "string",
"required": false,
"source": "body",
"description": "预留参数,暂未启用;当前仅保留字段名用于后续扩展。"
}
],
"response": [
{
"name": "_note",
"type": "string",
"required": false,
"description": "占位接口,当前无有效业务响应"
}
],
"errors": [
{
"code": "405",
"description": "占位接口,暂未开放"
}
]
},
{
"method": "storage.stockout.listItems",
"name": "出库单拉取明细",
"description": "按出库单查询商品明细(用于非订单出库单),底层复用 order.listItems。",
"isNeedAuth": false,
"isNeedLogin": true,
"isNeedRight": false,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "delivery_order_code",
"type": "string",
"required": false,
"source": "body",
"description": "出库单号,可用于定位订单"
},
{
"name": "order_id",
"type": "number",
"required": false,
"source": "body",
"description": "订单ID,可与 id 兼容用于定位订单"
},
{
"name": "id",
"type": "number",
"required": false,
"source": "body",
"description": "订单ID,可选;与 delivery_order_code / order_id 至少传一个"
}
],
"response": [
{
"name": "order",
"type": "object",
"required": true,
"description": "订单基础信息(含 id、delivery_order_code)"
},
{
"name": "items",
"type": "array",
"required": true,
"description": "出库单商品明细"
}
],
"errors": [
{
"code": "404",
"description": "订单不存在"
},
{
"code": "500",
"description": "缺少定位参数或查询失败"
}
]
}
]
},
{
"groupName": "库存操作模块",
"module": "storage.inventory",
"list": [
{
"method": "storage.inventory.quickPutaway",
"description": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成、已审核、货主已开启快捷入库策略且所有明细已匹配系统商品",
"isNeedAuth": true,
"isNeedLogin": true,
"params": [
{
"name": "receiving_id",
"type": "number",
"required": true,
"source": "body",
"description": "收货单ID,兼容 id"
}
],
"response": {
"receiving_id": "收货单ID",
"receiving_number": "收货单号",
"receiving_storage_status": "收货单入库状态(all/partial)",
"entry_order": {
"id": "自动创建的入库单ID",
"entry_order_code": "入库单号",
"order_status": "COMPLETED"
},
"items": [
{
"detail_id": "收货明细ID",
"product_name": "商品名称",
"stock_warehouse_id": "库存商品ID",
"inbound_quantity": "入库数量",
"space_id": "库位ID",
"storage_status": "明细入库状态"
}
]
},
"errors": [
{
"code": 400,
"message": "receiving_id 必填"
},
{
"code": 400,
"message": "收货单状态须为已完成"
},
{
"code": 400,
"message": "收货单未审核,审核通过后才能入库"
},
{
"code": 400,
"message": "货主xxxx不允许快速上架,如需开启请到:货主->策略配置调整"
},
{
"code": 400,
"message": "商品未匹配系统商品"
},
{
"code": 404,
"message": "收货单绑定的货主与当前仓库不存在有效签约关系"
},
{
"code": 400,
"message": "已全部入库无需重复操作"
},
{
"code": 404,
"message": "收货单不存在或无权访问"
},
{
"code": 409,
"message": "库存记录被锁定(行锁超时)"
}
]
},
{
"method": "storage.inventory.matchPutaway",
"description": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,要求收货单已完成且已审核,完成后根据入库单来源(QM/API)自动触发回传",
"isNeedAuth": true,
"isNeedLogin": true,
"params": [
{
"name": "receiving_ids",
"type": "array",
"required": true,
"source": "body",
"description": "收货单ID列表"
},
{
"name": "entry_order_ids",
"type": "array",
"required": true,
"source": "body",
"description": "入库单ID列表"
}
],
"response": {
"summary": {
"total_products_matched": "匹配的商品种类数",
"total_quantity_inbound": "入库总数量"
},
"receiving_results": [
{
"receiving_id": "收货单ID",
"storage_status": "入库状态(all/partial/none)"
}
],
"entry_order_results": [
{
"entry_order_id": "入库单ID",
"order_status": "入库单状态(COMPLETED 等)",
"callback_triggered": "是否触发回传(boolean)",
"callback_result": "回传结果对象"
}
],
"warnings": "匹配过程中的警告信息列表"
},
"errors": [
{
"code": 400,
"message": "receiving_ids 必填且为数组"
},
{
"code": 400,
"message": "entry_order_ids 必填且为数组"
},
{
"code": 404,
"message": "收货单不存在或无权访问"
},
{
"code": 400,
"message": "收货单未审核,审核通过后才能入库"
},
{
"code": 404,
"message": "入库单不存在或无权访问"
}
]
},
{
"method": "storage.inventory.transferLocation",
"description": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库",
"name": "库存移库(库位转移)",
"isNeedAuth": true,
"isNeedLogin": true,
"params": [
{
"name": "storage_id",
"type": "number",
"required": true,
"source": "body",
"description": "库存记录ID"
},
{
"name": "target_space_id",
"type": "number",
"required": true,
"source": "body",
"description": "目标库位ID"
},
{
"name": "quantity",
"type": "number",
"required": false,
"source": "body",
"description": "移库数量,不传则全部移动"
}
],
"response": {
"storage_id": "原库存记录ID",
"target_space_id": "目标库位ID",
"quantity": "实际移库数量",
"success": "是否成功(boolean)",
"message": "结果说明"
},
"errors": [
{
"code": 400,
"message": "storage_id 必填"
},
{
"code": 400,
"message": "target_space_id 必填"
},
{
"code": 400,
"message": "移库数量必须大于0且不超过可用库存"
},
{
"code": 400,
"message": "目标库位与原库位相同"
},
{
"code": 404,
"message": "库存记录不存在或无权访问"
},
{
"code": 404,
"message": "目标库位不存在或不属于该仓库"
}
]
},
{
"method": "storage.inventory.transferByProduct",
"description": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品",
"name": "按商品移库(库位转移)",
"isNeedAuth": true,
"isNeedLogin": true,
"params": [
{
"name": "space_id",
"type": "number",
"required": true,
"source": "body",
"description": "原库位ID"
},
{
"name": "stock_id",
"type": "number",
"required": true,
"source": "body",
"description": "商品SKU ID(wms_stock_warehouse.id)"
},
{
"name": "target_space_id",
"type": "number",
"required": true,
"source": "body",
"description": "目标库位ID"
},
{
"name": "quantity",
"type": "number",
"required": true,
"source": "body",
"description": "移库数量"
}
]
},
{
"method": "storage.inventory.list",
"description": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)",
"name": "库存列表",
"isNeedAuth": false,
"isNeedLogin": true,
"isNeedRight": false,
"params": [
{
"name": "where",
"type": "object",
"required": false,
"source": "body",
"description": "统一 where 条件对象,可用字段:stock_id(商品ID)、space_id(库位ID)、store_id(货主ID)、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、batch_no(批次号)、inbound_order_no(入库单号)、available_quantity(可用数量,支持 gt/lt)、inbound_time(入库时间,支持 between)、created_at(创建时间,支持 between)"
},
{
"name": "pagination",
"type": "object",
"required": false,
"source": "body",
"description": "分页参数 { page, pageSize },默认 page=1, pageSize=20"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'"
},
{
"name": "group_by_batch",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否按批次查询,默认 false。false=合并模式(按库位+商品聚合quantity/locked_quantity/available_quantity),true=明细模式(逐条返回含 batch_no/production_date/expiry_date 等)"
}
],
"response": {
"_note": "响应结构因 group_by_batch 而异",
"_shelf_life_note": "production_date 和 expiry_date 为库存批次日期字段;is_shelf_life_warning_triggered 表示该库存在商品启用保质期管理且剩余天数小于等于阈值时是否触发效期预警。",
"list_merged": {
"_description": "group_by_batch=false(默认合并模式)",
"list": [
{
"stock_id": "商品库存ID",
"space_id": "库位ID",
"inventory_type": "库存类型",
"warehouse_id": "仓库ID",
"store_id": "货主ID",
"quantity": "总库存数量(SUM)",
"locked_quantity": "总锁定数量(SUM)",
"available_quantity": "总可用数量(SUM)",
"first_inbound_time": "最早入库时间",
"last_inbound_time": "最晚入库时间",
"batch_count": "批次数",
"production_date": "生产日期(库存批次日期字段,合并模式下可能为 null)",
"expiry_date": "过期日期(库存批次日期字段,合并模式下可能为 null)",
"is_shelf_life_warning_triggered": "布尔,表示效期预警是否触发(仅在商品启用保质期管理且剩余天数 ≤ 阈值时为 true)",
"stock": {
"id": "商品ID",
"item_code": "商品编码",
"item_name": "商品名称",
"sku_property": "规格",
"stock_unit": "单位",
"store_name": "货主名称(来源于签约表 store_remask,若无签约关系则为 null)"
},
"space": {
"id": "库位ID",
"space_code": "库位编码",
"custom_name": "库位名称"
}
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 100,
"totalPages": 5
}
},
"list_detail": {
"_description": "group_by_batch=true(明细模式)",
"list": [
{
"id": "库存记录ID",
"warehouse_id": "仓库ID",
"store_id": "货主ID",
"space_id": "库位ID",
"stock_id": "商品库存ID",
"batch_no": "批次号",
"inventory_type": "库存类型",
"quantity": "库存数量",
"locked_quantity": "锁定数量",
"available_quantity": "可用数量",
"production_date": "生产日期(库存批次日期字段)",
"expiry_date": "过期日期(库存批次日期字段)",
"inbound_time": "入库时间",
"inbound_order_no": "入库单号",
"receiving_id": "收货单ID",
"entry_order_id": "入库单ID",
"supplier_batch_no": "供应商批次号",
"created_at": "创建时间",
"updated_at": "更新时间",
"is_shelf_life_warning_triggered": "布尔,表示效期预警是否触发(仅在商品启用保质期管理且剩余天数 ≤ 阈值时为 true)",
"stock": {
"id": "商品ID",
"item_code": "商品编码",
"item_name": "商品名称",
"sku_property": "规格",
"stock_unit": "单位",
"store_name": "货主名称(来源于签约表 store_remask,若无签约关系则为 null)"
},
"space": {
"id": "库位ID",
"space_code": "库位编码",
"custom_name": "库位名称"
}
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 100,
"totalPages": 5
}
}
}
},
{
"method": "storage.expiry.list",
"description": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。",
"name": "库存有效期列表(或:库存效期预警列表)",
"isNeedAuth": false,
"isNeedLogin": true,
"isNeedRight": false,
"params": [
{
"name": "where",
"type": "object",
"required": false,
"source": "body",
"description": "统一 where 条件对象;支持字段:item_code、goods_code、item_name、sku_property、stock_unit、is_shelf_life_mgmt、remaining_threshold_days。示例:where.item_code={operator:like,value:ABC}; where.remaining_threshold_days={operator:lte,value:7}。注意:无需传入 store_id 或 warehouse_id,服务端会从当前登录用户获取仓库上下文。"
},
{
"name": "pagination",
"type": "object",
"required": false,
"source": "body",
"description": "分页参数 { page, pageSize },默认 page=1, pageSize=20"
}
],
"response": [
{
"name": "data.list",
"type": "array",
"required": true,
"description": "匹配到的库存效期项数组"
},
{
"name": "data.list[]",
"type": "object",
"description": "列表项,包含至少以下字段",
"children": [
{
"name": "id",
"type": "number",
"description": "库存记录ID(wms_storage.id)"
},
{
"name": "warehouse_id",
"type": "number",
"description": "仓库ID"
},
{
"name": "store_id",
"type": "number",
"description": "货主ID"
},
{
"name": "space_id",
"type": "number",
"description": "库位ID"
},
{
"name": "stock_id",
"type": "number",
"description": "商品库存ID(stock_warehouse.id)"
},
{
"name": "batch_no",
"type": "string",
"description": "批次号"
},
{
"name": "quantity",
"type": "number",
"description": "库存数量"
},
{
"name": "expiry_date",
"type": "string",
"description": "过期/到期日期(ISO)"
},
{
"name": "remaining_days",
"type": "number",
"description": "距到期剩余天数(正数表示未过期,0 当日到期,负数表示已过期)"
},
{
"name": "threshold_days",
"type": "number",
"description": "阈值天数,优先使用传入 remaining_threshold_days,否则使用商品配置"
},
{
"name": "is_expired",
"type": "boolean",
"description": "是否已过期(true=已过期)"
},
{
"name": "stock",
"type": "object",
"description": "关联商品信息(id、item_code、item_name、sku_property、stock_unit 等)"
},
{
"name": "space",
"type": "object",
"description": "关联库位信息(id、space_code、custom_name 等)"
},
{
"name": "created_at",
"type": "string",
"description": "记录创建时间"
},
{
"name": "updated_at",
"type": "string",
"description": "记录更新时间"
},
{
"name": "inbound_time",
"type": "string",
"description": "入库时间"
},
{
"name": "production_date",
"type": "string",
"description": "生产日期"
}
]
},
{
"name": "data.pagination",
"type": "object",
"required": true,
"description": "分页信息,含 page、pageSize、total、totalPages"
}
],
"errors": [
{
"code": 400,
"message": "where 条件格式不正确"
}
]
},
{
"method": "storage.transaction.list",
"description": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)",
"name": "出入库流水记录列表",
"isNeedAuth": false,
"isNeedLogin": true,
"isNeedRight": false,
"params": [
{
"name": "where",
"type": "object",
"required": false,
"source": "body",
"description": "统一 where 条件对象,可用字段:transaction_type(ENUM INBOUND/OUTBOUND)、stock_id、space_id、store_id、order_type(SCRK/MATCH)、order_no、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、operator_name、created_at(支持 between)"
},
{
"name": "pagination",
"type": "object",
"required": false,
"source": "body",
"description": "分页参数 { page, pageSize },默认 page=1, pageSize=20"
},
{
"name": "sort",
"type": "object",
"required": false,
"source": "body",
"description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'"
},
{
"name": "group_by_batch",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否按批次查询明细,默认 false。false=合并模式(按库位+商品聚合),true=明细模式(逐条返回)"
}
],
"response": {
"_note": "响应结构因 group_by_batch 而异",
"list_merged": {
"_description": "group_by_batch=false(默认合并模式)",
"list": [
{
"stock_id": "商品库存ID",
"space_id": "库位ID",
"transaction_type": "INBOUND/OUTBOUND",
"inventory_type": "库存类型",
"warehouse_id": "仓库ID",
"store_id": "货主ID",
"order_type": "关联单据类型",
"quantity": "合计数量",
"first_created_at": "最早记录时间",
"last_created_at": "最晚记录时间",
"record_count": "合并记录条数",
"stockItem": {
"id": "商品ID",
"item_code": "商品编码",
"item_name": "商品名称",
"sku_property": "规格",
"stock_unit": "单位"
}
}
],
"pagination": {
"page": "当前页",
"pageSize": "每页条数",
"total": "总记录数",
"totalPages": "总页数"
}
},
"list_detail": {
"_description": "group_by_batch=true(明细模式)",
"list": [
{
"id": "记录ID",
"transaction_type": "INBOUND/OUTBOUND",
"warehouse_id": "仓库ID",
"store_id": "货主ID",
"stock_id": "商品库存ID",
"storage_id": "库存记录ID",
"space_id": "库位ID",
"quantity": "数量",
"batch_no": "批次号",
"inventory_type": "库存类型",
"order_type": "关联单据类型",
"order_no": "关联单据号",
"order_id": "关联单据ID",
"receiving_id": "收货单ID",
"entry_order_id": "入库单ID",
"operator_id": "操作人ID",
"operator_name": "操作人姓名",
"remark": "备注",
"created_at": "创建时间",
"stockItem": {
"id": "商品ID",
"item_code": "商品编码",
"item_name": "商品名称",
"sku_property": "规格",
"stock_unit": "单位"
}
}
],
"pagination": {
"page": "当前页",
"pageSize": "每页条数",
"total": "总记录数",
"totalPages": "总页数"
}
}
},
"errors": [
{
"code": 400,
"message": "where 条件格式不正确"
},
{
"code": 400,
"message": "分页参数不合法"
}
]
}
]
},
{
"groupName": "主体模块",
"module": "store",
"list": [
{
"method": "store.createStore",
"description": "store.createStore 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "subject_config",
"type": "object",
"required": false,
"source": "body",
"description": "货主主体配置,不传时自动写入默认值"
},
{
"name": "subject_config.max_notice_webhook_count",
"type": "number",
"required": false,
"source": "body.subject_config",
"description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5"
},
{
"name": "subject_config.default_express_code",
"type": "string",
"required": false,
"source": "body.subject_config",
"description": "默认快递编码,缺省为 STO"
},
{
"name": "subject_config.default_platform_code",
"type": "string",
"required": false,
"source": "body.subject_config",
"description": "默认平台编码,缺省为 TB"
},
{
"name": "subject_config.group_wave_prefix",
"type": "string",
"required": false,
"source": "body.subject_config",
"description": "团购波次前缀,最多 5 个字符,默认 B"
},
{
"name": "subject_config.min_group_order_fetch_quantity",
"type": "number",
"required": false,
"source": "body.subject_config",
"description": "最小团购订单抓取数量,默认 13"
},
{
"name": "subject_config.auto_grouping_enabled",
"type": "boolean",
"required": false,
"source": "body.subject_config",
"description": "是否自动加团,默认 false(关闭)"
}
],
"response": [],
"errors": []
},
{
"method": "store.createWarehouse",
"description": "store.createWarehouse 接口,subject_config 未传时默认写入 max_notice_webhook_count=5、default_express_code=STO、default_platform_code=TB、group_wave_prefix=B、min_group_order_fetch_quantity=13、auto_grouping_enabled=false(是否自动加团,默认 false(关闭))",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "subject_config",
"type": "object",
"required": false,
"source": "body",
"description": "货主主体配置,不传时自动写入默认值"
},
{
"name": "subject_config.max_notice_webhook_count",
"type": "number",
"required": false,
"source": "body.subject_config",
"description": "当前主体最多允许绑定 / 触达的消息推送接口数量,默认 5"
},
{
"name": "subject_config.default_express_code",
"type": "string",
"required": false,
"source": "body.subject_config",
"description": "默认快递编码,缺省为 STO"
},
{
"name": "subject_config.default_platform_code",
"type": "string",
"required": false,
"source": "body.subject_config",
"description": "默认平台编码,缺省为 TB"
},
{
"name": "subject_config.group_wave_prefix",
"type": "string",
"required": false,
"source": "body.subject_config",
"description": "团购波次前缀,最多 5 个字符,默认 B"
},
{
"name": "subject_config.min_group_order_fetch_quantity",
"type": "number",
"required": false,
"source": "body.subject_config",
"description": "最小团购订单抓取数量,默认 13"
},
{
"name": "subject_config.auto_grouping_enabled",
"type": "boolean",
"required": false,
"source": "body.subject_config",
"description": "是否自动加团,默认 false(关闭)"
}
],
"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": "storeWarehouse.store",
"list": [
{
"method": "storeWarehouse.store.list",
"description": "查询当前主体可见的仓库-货主签约列表",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "page",
"type": "number",
"required": false,
"source": "body",
"description": "页码,默认 1"
},
{
"name": "page_size",
"type": "number",
"required": false,
"source": "body",
"description": "分页大小,默认 20"
},
{
"name": "keyword",
"type": "string",
"required": false,
"source": "body",
"description": "签约备注或主体名称关键字"
}
],
"response": [
{
"name": "data.list",
"type": "array",
"description": "签约关系列表"
},
{
"name": "data.list[].id",
"type": "number",
"description": "签约关系主键 ID"
},
{
"name": "data.list[].store_id",
"type": "number",
"description": "货主 ID"
},
{
"name": "data.list[].store_name",
"type": "string",
"description": "货主名称(优先取备注名,无则取 company_name)"
},
{
"name": "data.list[].warehouse_id",
"type": "number",
"description": "仓库 ID"
},
{
"name": "data.list[].warehouse_name",
"type": "string",
"description": "仓库名称(优先取备注名,无则取 company_name)"
},
{
"name": "data.list[].counterparty_id",
"type": "number",
"description": "对方主体 ID(当前为仓库则返回货主 ID,反之亦然)"
},
{
"name": "data.list[].counterparty_name",
"type": "string",
"description": "对方主体名称"
},
{
"name": "data.list[].current_subject_role",
"type": "string",
"description": "当前主体角色:warehouse 或 store"
},
{
"name": "data.list[].auth_status",
"type": "number",
"description": "签约状态:1=申请中 2=已通过 3=已拒绝 4=已解除 5=已过期"
},
{
"name": "data.list[].auth_status_label",
"type": "string",
"description": "签约状态中文标签"
},
{
"name": "data.list[].apply_reason",
"type": "string",
"description": "申请原因"
},
{
"name": "data.list[].review_comment",
"type": "string",
"description": "审核评语"
},
{
"name": "data.list[].apply_time",
"type": "string|null",
"description": "申请时间"
},
{
"name": "data.list[].review_time",
"type": "string|null",
"description": "审核时间"
},
{
"name": "data.list[].auth_start",
"type": "string|null",
"description": "授权开始时间"
},
{
"name": "data.list[].auth_end",
"type": "string|null",
"description": "授权结束时间"
},
{
"name": "data.list[].actual_end",
"type": "string|null",
"description": "实际结束时间"
},
{
"name": "data.list[].print_quantity",
"type": "number",
"description": "面单余额数量"
},
{
"name": "data.list[].applied_by",
"type": "number|null",
"description": "申请人账号 ID"
},
{
"name": "data.list[].reviewed_by",
"type": "number|null",
"description": "审核人账号 ID"
},
{
"name": "data.list[].ended_by",
"type": "number|null",
"description": "解除人账号 ID"
},
{
"name": "data.list[].remask",
"type": "string",
"description": "备注名(当前为仓库则返回货主备注名,反之亦然)"
},
{
"name": "data.list[].use_status",
"type": "number",
"description": "启用状态:0=禁用 1=启用"
},
{
"name": "data.list[].policy_config",
"type": "object|null",
"description": "签约策略配置对象,无则为 null"
},
{
"name": "data.list[].is_auth_valid",
"type": "boolean",
"description": "签约是否在有效期内"
},
{
"name": "data.list[].remaining_days",
"type": "number",
"description": "剩余有效天数(未在有效期内时为 0)"
},
{
"name": "data.list[].has_qimen_config",
"type": "boolean",
"description": "该货主是否已配置奇门(true=已配置,false=未配置)"
},
{
"name": "data.total",
"type": "number",
"description": "总记录数"
},
{
"name": "data.page",
"type": "number",
"description": "当前页码"
},
{
"name": "data.page_size",
"type": "number",
"description": "每页条数"
},
{
"name": "data.current_subject.store_id",
"type": "number",
"description": "当前主体 ID"
},
{
"name": "data.current_subject.company_name",
"type": "string",
"description": "当前主体公司名称"
},
{
"name": "data.current_subject.role",
"type": "string",
"description": "当前主体角色:warehouse 或 store"
}
],
"errors": []
},
{
"method": "storeWarehouse.store.sign",
"description": "发起或确认仓库-货主签约",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "store_id",
"type": "number",
"required": false,
"source": "body",
"description": "货主ID;由仓库侧发起时必传"
},
{
"name": "warehouse_id",
"type": "number",
"required": false,
"source": "body",
"description": "仓库ID;由货主侧发起时必传"
},
{
"name": "temp_code",
"type": "string",
"required": false,
"source": "body",
"description": "临时签约码;传入后进入确认或预览流程"
}
],
"response": [],
"errors": []
},
{
"method": "storeWarehouse.store.rename",
"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,兼容 contract_id"
}
],
"response": [],
"errors": []
},
{
"method": "storeWarehouse.store.unbind",
"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,兼容 contract_id"
},
{
"name": "use_status",
"type": "number",
"required": false,
"source": "body",
"description": "使用状态,0=停用,1=恢复"
}
],
"response": [],
"errors": []
},
{
"method": "storeWarehouse.store.adjustPrintQuantity",
"description": "人工调整签约关系下的面单余额并记录变更日志",
"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,兼容 contract_id"
},
{
"name": "print_quantity",
"type": "number",
"required": false,
"source": "body",
"description": "目标面单余额(覆盖值);优先使用该字段"
},
{
"name": "target_quantity",
"type": "number",
"required": false,
"source": "body",
"description": "目标面单余额(覆盖值);兼容别名"
},
{
"name": "change_quantity",
"type": "number",
"required": true,
"source": "body",
"description": "兼容旧字段;当前按目标面单余额(覆盖值)解释,差值将自动写入变更日志"
},
{
"name": "adjust_quantity",
"type": "number",
"required": false,
"source": "body",
"description": "兼容旧字段;当前按目标面单余额(覆盖值)解释"
},
{
"name": "reason",
"type": "string",
"required": true,
"source": "body",
"description": "人工调整缘由,必填"
},
{
"name": "business_type",
"type": "string",
"required": false,
"source": "body",
"description": "业务来源类型,预留给后续 order_express 等自动扣减场景"
},
{
"name": "business_id",
"type": "number",
"required": false,
"source": "body",
"description": "业务关联ID,预留给后续关联 wms_order_express.id"
}
],
"response": [],
"errors": []
},
{
"method": "storeWarehouse.store.getPolicyConfig",
"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,兼容 contract_id"
}
],
"response": [],
"errors": []
},
{
"method": "storeWarehouse.store.getPolicyConfigFields",
"description": "获取签约策略可配置字段元信息列表",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": [],
"errors": []
},
{
"method": "storeWarehouse.store.savePolicyConfig",
"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,兼容 contract_id"
},
{
"name": "policy_config",
"type": "object",
"required": true,
"source": "body",
"description": "策略配置对象;仅支持 receive_mode、auto_allocate_bin、auto_allocate_express(是否自动分配快递)、auto_allocate_storage(是否自动分配储位)、allow_mix_batch、allow_temp_storage、storage_separation、print_recharge_price(面单充值元/单,支持 2 位小数)、max_daily_inbound、remark"
}
],
"response": [],
"errors": []
},
{
"method": "storeWarehouse.store.listApiConfig",
"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,兼容 contract_id"
},
{
"name": "interface_type_id",
"type": "number",
"required": false,
"source": "body",
"description": "接口类型ID,默认查询全部可用类型"
}
],
"response": [
{
"name": "data.list[].callback_url",
"type": "string",
"description": "API回调通知URL,来自 serializeQimenConfig 序列化"
}
],
"errors": []
},
{
"method": "storeWarehouse.store.saveApiConfig",
"description": "新增或更新签约关系下的接口配置。QM_WMS 类型须填写奇门字段;OPEN_API 类型由系统自动生成 self_app_key 和 self_app_secret",
"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,兼容 contract_id"
},
{
"name": "interface_type_id",
"type": "number",
"required": true,
"source": "body",
"description": "接口类型ID,必须是 wms_interface_type 已存在的类型"
},
{
"name": "qimen_app_key",
"type": "string",
"required": false,
"source": "body",
"description": "奇门 AppKey(QM_WMS 类型必填,OPEN_API 类型不需要)"
},
{
"name": "qimen_customer_id",
"type": "string",
"required": false,
"source": "body",
"description": "奇门客户ID(QM_WMS 类型必填,OPEN_API 类型不需要)"
},
{
"name": "qimen_warehouse_code",
"type": "string",
"required": false,
"source": "body",
"description": "奇门仓库编码(QM_WMS 类型必填,OPEN_API 类型不需要)"
},
{
"name": "app_name",
"type": "string",
"required": true,
"source": "body",
"description": "应用名称"
},
{
"name": "callback_url",
"type": "string",
"required": false,
"source": "body",
"description": "API 类型入库单回调地址(VARCHAR(500),仅 OPEN_API 类型使用)"
}
],
"response": [],
"errors": []
},
{
"method": "storeWarehouse.store.deleteQimenConfig",
"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,兼容 contract_id"
},
{
"name": "interface_type_id",
"type": "number",
"required": false,
"source": "body",
"description": "接口类型ID"
}
],
"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.getLoginWechatCode",
"description": "获取微信扫码登录码(无 clientCode 时分配新客户端编码;有 clientCode 时可长轮询刷新)",
"isNeedAuth": false,
"isNeedLogin": false,
"headers": [],
"params": [
{
"name": "clientCode",
"type": "string",
"required": false,
"source": "body",
"description": "客户端编码;首次可不传,后续轮询建议透传已有值"
}
],
"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": "is_active",
"type": "boolean",
"required": false,
"source": "body",
"description": "是否启用,支持 true/false 或 1/0"
},
{
"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.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": true,
"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.exportRackSpaces",
"description": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)",
"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": [
{
"name": "count",
"type": "number",
"description": "导出记录数"
},
{
"name": "fileName",
"type": "string",
"description": "导出文件名"
},
{
"name": "fileUrl",
"type": "string",
"description": "导出文件下载地址"
}
],
"errors": []
},
{
"method": "warehouse.batchUpdateSpaceInfo",
"description": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。",
"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,传入时校验所有 space_code 必须属于该货架,不传则只校验属于任意货架类型库位"
},
{
"name": "items",
"type": "array",
"required": true,
"source": "body",
"description": "批量修改数据数组;每项支持字段:space_code、custom_name、custom_barcode、pick_sequence、location_type_name"
},
{
"name": "items[].space_code",
"type": "string",
"required": true,
"source": "body",
"description": "仓位编码,作为批量修改的唯一定位键;缺失、重复或不存在都会整批失败"
},
{
"name": "items[].custom_name",
"type": "string",
"required": false,
"source": "body",
"description": "自定义名称,空字符串会被清空"
},
{
"name": "items[].custom_barcode",
"type": "string",
"required": false,
"source": "body",
"description": "自定义条码,批次内或系统内冲突都会整批失败;空字符串会被清空"
},
{
"name": "items[].pick_sequence",
"type": "number",
"required": false,
"source": "body",
"description": "拣货顺序,必须为非负整数,超出边界则整批失败"
},
{
"name": "items[].location_type_id",
"type": "number",
"required": false,
"source": "body",
"description": "仓位类型ID,必须为正整数且在当前仓库或全局类型中存在(is_active=true),否则整批失败;传 null 或不传则不修改仓位类型"
}
],
"response": [
{
"name": "count",
"type": "number",
"description": "成功更新的记录数"
}
],
"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": []
}
]
}
]
}
}