6333 lines
292 KiB
JSON
6333 lines
292 KiB
JSON
{
|
||
"module": "system",
|
||
"description": "系统接口标准入口,method 对应系统内置方法,全部使用 POST 请求,参数统一放在 body 内",
|
||
"version": "0.3.3",
|
||
"updatedAt": "2026-04-08",
|
||
"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": "index.searchSpace 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.listInterfaceTypes",
|
||
"description": "查询可用的接口类型列表(如奇门仓储、开放接口等)",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"params": []
|
||
},
|
||
{
|
||
"method": "index.getExpressList",
|
||
"description": "index.getExpressList 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "订单模块",
|
||
"module": "order",
|
||
"list": [
|
||
{
|
||
"method": "order.getOrderModels",
|
||
"description": "order.getOrderModels 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.base.getOrderModels",
|
||
"description": "订单模型能力兼容入口(当前与 order.getOrderModels 返回一致)",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.list",
|
||
"description": "分页查询订单列表",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pagination 参数"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;常用字段包括 delivery_order_code、status、step、outbound_status、buyer_nick、mobile 与日期区间字段。示例:where.delivery_order_code={operator:like,value:SO202603}; where.status={operator:in,value:[created,pedding]}; where.step={operator:eq,value:1}。"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.detail",
|
||
"description": "查询订单详情",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "delivery_order_code 参数"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.listItems",
|
||
"description": "查询订单商品明细",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "delivery_order_code 参数"
|
||
},
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "order_id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.stats",
|
||
"description": "订单统计",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;统计口径与 order.list 共用筛选字段。示例:where.status={operator:eq,value:fin}; where.create_time_start={value:2026-03-01}; where.create_time_end={value:2026-03-31}。"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.getreviewOrderlist",
|
||
"description": "分页查询订单审核列表",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pagination 参数"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构;支持 inspection_status、step、operator_name、operate_time_start、operate_time_end 等字段。示例:where.step={operator:in,value:[0,1]}; where.inspection_status={operator:eq,value:pending}; where.operator_name={operator:like,value:张}; where.operate_time_start={value:2026-03-01}。"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.updateStatus",
|
||
"description": "更新订单状态",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "claim_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "claim_status 参数"
|
||
},
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "delivery_order_code 参数"
|
||
},
|
||
{
|
||
"name": "delivery_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "delivery_time 参数"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
},
|
||
{
|
||
"name": "inspection_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "inspection_status 参数"
|
||
},
|
||
{
|
||
"name": "intercept_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "intercept_status 参数"
|
||
},
|
||
{
|
||
"name": "lock_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "lock_status 参数"
|
||
},
|
||
{
|
||
"name": "outbound_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "outbound_status 参数"
|
||
},
|
||
{
|
||
"name": "pack_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pack_status 参数"
|
||
},
|
||
{
|
||
"name": "pick_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pick_status 参数"
|
||
},
|
||
{
|
||
"name": "post_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "post_status 参数"
|
||
},
|
||
{
|
||
"name": "print_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "print_status 参数"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "status 参数"
|
||
},
|
||
{
|
||
"name": "storage_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "storage_status 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.updateDeliveryTime",
|
||
"description": "更新发货时间",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "delivery_time",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "delivery_time 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.reviewOrder",
|
||
"description": "订单审核",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "delivery_order_code 参数"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
},
|
||
{
|
||
"name": "inspection_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "inspection_status 参数(兼容入参)"
|
||
},
|
||
{
|
||
"name": "review_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "review_status 参数,默认 fin"
|
||
},
|
||
{
|
||
"name": "operator_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "operator_name 参数"
|
||
},
|
||
{
|
||
"name": "operate_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "operate_time 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.reviewOrder.getreviewOrderlist",
|
||
"description": "分页查询订单审核列表(目录化路由)",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pagination 参数"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构;支持 inspection_status、step、operator_name、operate_time_start、operate_time_end 等字段。示例:where.step={operator:in,value:[0,1]}; where.inspection_status={operator:eq,value:pending}; where.operator_name={operator:like,value:张}; where.operate_time_start={value:2026-03-01}。"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.reviewOrder.reviewOrder",
|
||
"description": "订单审核(目录化路由)。执行后会更新 inspection_status,并同步更新订单整数字段 step。",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "delivery_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "delivery_order_code 参数"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
},
|
||
{
|
||
"name": "inspection_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "inspection_status 参数(兼容入参)"
|
||
},
|
||
{
|
||
"name": "review_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "review_status 参数,默认 fin"
|
||
},
|
||
{
|
||
"name": "operator_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "operator_name 参数"
|
||
},
|
||
{
|
||
"name": "operate_time",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "operate_time 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.deliveryOrder.getdeliveryOrderlist",
|
||
"description": "分页查询已进入出库流程的订单列表",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pagination 参数"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构;未传 outbound_status 时默认过滤 outbound_status != none;支持 step 筛选。示例:where.outbound_status={operator:in,value:[created,processing]}; where.step={operator:in,value:[4,5]}; where.store_id={operator:eq,value:1001}。"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.getpendingOrderlist",
|
||
"description": "分页查询待处理订单列表",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pagination 参数"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构;未传时默认 status in [pedding, created] 且 outbound_status = none。示例:where.status={operator:in,value:[pedding,created]}; where.outbound_status={operator:eq,value:none}。"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.expectionOrder.getexpectionOrderlist",
|
||
"description": "分页查询异常订单列表",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pagination 参数"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构;未传时默认筛选各流程 error 或拦截 exception。示例:where.status={operator:eq,value:error}; where.outbound_status={operator:eq,value:exception}。"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.archiveOrder.getarchiveOrderlist",
|
||
"description": "分页查询归档订单列表(暂使用当前订单表完成态数据)",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pagination 参数"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构;未传 outbound_status 时默认过滤 outbound_status = fin。示例:where.outbound_status={operator:eq,value:fin}; where.store_id={operator:eq,value:1001}。"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "打印模块",
|
||
"module": "print",
|
||
"list": [
|
||
{
|
||
"method": "print.send",
|
||
"description": "print.send 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "computerId",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "computerId 参数"
|
||
},
|
||
{
|
||
"name": "count",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "count 参数"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "data 参数"
|
||
},
|
||
{
|
||
"name": "printer",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "printer 参数"
|
||
},
|
||
{
|
||
"name": "template",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "template 参数"
|
||
},
|
||
{
|
||
"name": "timestamp",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "timestamp 参数"
|
||
},
|
||
{
|
||
"name": "type",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "type 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "print.getPrintResult",
|
||
"description": "print.getPrintResult 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "printId",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "printId 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "print.getPrintRecordItem",
|
||
"description": "print.getPrintRecordItem 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "print.getList",
|
||
"description": "print.getList 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "page",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "page 参数"
|
||
},
|
||
{
|
||
"name": "pageSize",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pageSize 参数"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 where 条件对象;推荐使用 { 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.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.saveWarehouseStock",
|
||
"description": "更新仓库商品资料",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.createWarehouseStock",
|
||
"description": "新建仓库商品资料",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.getBarcodes",
|
||
"description": "查询商品条码列表",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.saveWarehouseStockBarcode",
|
||
"description": "保存商品条码信息",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.getStoreStocks",
|
||
"description": "查询仓库商品与货主关联列表",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.bindItem",
|
||
"description": "绑定货主商品关系",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.unbindItem",
|
||
"description": "解绑货主商品关系",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.checkItemCodeUnique",
|
||
"description": "校验商品编码在货主维度唯一性",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "item_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "item_code 参数"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "store_id 参数"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.queryStockLogs",
|
||
"description": "查询库存操作日志",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouseId",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "warehouseId 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.handleBatchDelete",
|
||
"description": "批量删除仓库商品资料",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.deleteUnit",
|
||
"description": "删除库存单位",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.deleteProhibited",
|
||
"description": "删除违禁品类型",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.handleBatchChange",
|
||
"description": "批量修改仓库商品字段",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.getStockUnits",
|
||
"description": "查询可用库存单位(系统+仓库)",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.getUnitList",
|
||
"description": "查询当前仓库自定义单位列表",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.createProhibited",
|
||
"description": "新增违禁品类型",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "name 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.createUnit",
|
||
"description": "新增库存单位",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "name 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "stock.warehouse.search",
|
||
"description": "仓库商品关键字搜索,按 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": "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": [
|
||
{
|
||
"code": 0,
|
||
"message": "搜索失败,请稍后重试",
|
||
"description": "服务端查询异常时返回"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "stock.warehouse.getStockDetail",
|
||
"description": "查询商品的库存明细,返回 wms_storage 表的数据(按库位/批次维度展示库存分布)",
|
||
"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(页码,默认1)和 pageSize(每页条数,默认20)"
|
||
},
|
||
{
|
||
"name": "group_by_batch",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "是否区分批次。false(默认)时按库位合并数量,批次相关字段(batch_no, production_date, expiry_date, inbound_time, inbound_order_no, supplier_batch_no)置 null;true 时按原逻辑返回每条明细"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "stockItem",
|
||
"type": "object",
|
||
"description": "商品概要信息,含 id, item_code, item_name, sku_property, stock_unit, quantity, locked_quantity"
|
||
},
|
||
{
|
||
"name": "storageList",
|
||
"type": "array",
|
||
"description": "库存明细数组,每条含 id, space_id, batch_no, inventory_type, quantity, locked_quantity, available_quantity, production_date, expiry_date, inbound_time, inbound_order_no, supplier_batch_no, created_at,关联 space 对象(id, space_code, custom_name)。当 group_by_batch=false 时,批次相关字段为 null"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"description": "分页信息,含 page, pageSize, total"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": 0,
|
||
"message": "参数 stock_id 不能为空"
|
||
},
|
||
{
|
||
"code": 0,
|
||
"message": "商品不存在或不属于当前仓库"
|
||
},
|
||
{
|
||
"code": 0,
|
||
"message": "查询库存明细失败,请稍后重试"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "stock.stockWarehouse",
|
||
"description": "仓库商品列表查询兼容入口(等同于 stock.warehouse.list)",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "分页参数"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "筛选条件,写法与 stock.warehouse.list 一致"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "库存模块",
|
||
"module": "storage",
|
||
"list": [
|
||
{
|
||
"method": "storage.receiving.getReceivingList",
|
||
"description": "storage.receiving.getReceivingList 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "分页参数,支持 page/pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 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)"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "0",
|
||
"description": "无记录或无权访问"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "服务器错误"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.receiving.batchCancelReceiving",
|
||
"description": "storage.receiving.batchCancelReceiving 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "待作废收货单ID数组"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "批量作废处理结果"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "0",
|
||
"description": "部分单据不存在、无权访问或状态不允许作废"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "服务器错误"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.receiving.create",
|
||
"description": "storage.receiving.create 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "delivery_method",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "到货方式:truck/express/air_freight/sea_freight/other"
|
||
},
|
||
{
|
||
"name": "loading_method",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "装卸方式:with_pallet/without_pallet"
|
||
},
|
||
{
|
||
"name": "license_plate",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "车牌号(delivery_method=truck 时建议传)"
|
||
},
|
||
{
|
||
"name": "tracking_number",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "物流单号(非 truck/other 场景建议传)"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "货主ID"
|
||
},
|
||
{
|
||
"name": "total_boxes",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "总箱数"
|
||
},
|
||
{
|
||
"name": "total_pallets",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "总托盘数"
|
||
},
|
||
{
|
||
"name": "remark",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "备注"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新建收货单ID"
|
||
},
|
||
{
|
||
"name": "receiving_number",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "收货单号"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "0",
|
||
"description": "创建失败(如字段枚举不合法、数据库约束异常)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.receiving.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.addItem",
|
||
"description": "storage.receiving.addItem 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
},
|
||
{
|
||
"name": "item",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "item 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.removeItem",
|
||
"description": "storage.receiving.removeItem 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
},
|
||
{
|
||
"name": "item_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "item_id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.saveReceiving",
|
||
"description": "storage.receiving.saveReceiving 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.get",
|
||
"description": "storage.receiving.get 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.addDetail",
|
||
"description": "storage.receiving.addDetail 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.deleteDetail",
|
||
"description": "storage.receiving.deleteDetail 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.detailChange",
|
||
"description": "storage.receiving.detailChange 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.cancel",
|
||
"description": "storage.receiving.cancel 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.completeReceiving",
|
||
"description": "storage.receiving.completeReceiving 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "入库单模块",
|
||
"module": "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": "已全部入库无需重复操作" },
|
||
{ "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": 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 而异",
|
||
"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": "批次数",
|
||
"stock": { "id": "商品ID", "item_code": "商品编码", "item_name": "商品名称", "sku_property": "规格", "stock_unit": "单位" },
|
||
"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": "更新时间",
|
||
"stock": { "id": "商品ID", "item_code": "商品编码", "item_name": "商品名称", "sku_property": "规格", "stock_unit": "单位" },
|
||
"space": { "id": "库位ID", "space_code": "库位编码", "custom_name": "库位名称" }
|
||
}
|
||
],
|
||
"pagination": { "page": 1, "pageSize": 20, "total": 100, "totalPages": 5 }
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"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 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "store.createWarehouse",
|
||
"description": "store.createWarehouse 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "store.joinStore",
|
||
"description": "store.joinStore 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "store.joinWarehouse",
|
||
"description": "store.joinWarehouse 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "store.getStoreRoles",
|
||
"description": "store.getStoreRoles 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "申请码(join_token)"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "store.auditApply",
|
||
"description": "store.auditApply 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "audit_status",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "审核状态(approved/rejected)"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "申请码(join_token)"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "当前审批门店ID"
|
||
},
|
||
{
|
||
"name": "role_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "分配角色ID数组"
|
||
},
|
||
{
|
||
"name": "reject_reason",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "拒绝原因(audit_status=rejected 时可传)"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "货主-仓库签约模块",
|
||
"module": "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、sku_visibility、auto_allocate_bin、allow_mix_batch、allow_temp_storage、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.createRack",
|
||
"description": "warehouse.createRack 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "height",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "height 参数"
|
||
},
|
||
{
|
||
"name": "length",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "length 参数"
|
||
},
|
||
{
|
||
"name": "rack_columns",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "rack_columns 参数"
|
||
},
|
||
{
|
||
"name": "rack_levels",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "rack_levels 参数"
|
||
},
|
||
{
|
||
"name": "rack_rows",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "rack_rows 参数"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "warehouse_id 参数"
|
||
},
|
||
{
|
||
"name": "width",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "width 参数"
|
||
},
|
||
{
|
||
"name": "x",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "x 参数"
|
||
},
|
||
{
|
||
"name": "y",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "y 参数"
|
||
},
|
||
{
|
||
"name": "zone_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "zone_code 参数"
|
||
},
|
||
{
|
||
"name": "zone_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "zone_name 参数"
|
||
},
|
||
{
|
||
"name": "color",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "color 参数"
|
||
},
|
||
{
|
||
"name": "direction",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "direction 参数"
|
||
},
|
||
{
|
||
"name": "parent_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "parent_id 参数"
|
||
},
|
||
{
|
||
"name": "z",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "z 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.getPickPath",
|
||
"description": "warehouse.getPickPath 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "query",
|
||
"description": "warehouse_id 参数"
|
||
},
|
||
{
|
||
"name": "include_spaces",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "query",
|
||
"description": "include_spaces 参数"
|
||
},
|
||
{
|
||
"name": "limit",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "query",
|
||
"description": "limit 参数"
|
||
},
|
||
{
|
||
"name": "sort_by",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "query",
|
||
"description": "sort_by 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.updateRackPosition",
|
||
"description": "warehouse.updateRackPosition 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "x",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "x 参数"
|
||
},
|
||
{
|
||
"name": "y",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "y 参数"
|
||
},
|
||
{
|
||
"name": "rack_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "path",
|
||
"description": "rack_id 参数"
|
||
},
|
||
{
|
||
"name": "z",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "z 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.recalculatePickPath",
|
||
"description": "warehouse.recalculatePickPath 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "warehouse_id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.updateNeighbors",
|
||
"description": "warehouse.updateNeighbors 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "warehouse_id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.getAreaRacks",
|
||
"description": "warehouse.getAreaRacks 接口",
|
||
"isNeedAuth": 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.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": []
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
}
|