5276 lines
234 KiB
JSON
5276 lines
234 KiB
JSON
{
|
||
"module": "system",
|
||
"description": "系统接口标准入口,method 对应系统内置方法,全部使用 POST 请求,参数统一放在 body 内",
|
||
"version": "0.3.0",
|
||
"updatedAt": "2026-03-23",
|
||
"headers": [
|
||
{
|
||
"name": "platform",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "客户端平台标识,如 web/pda/app",
|
||
"list": [
|
||
{
|
||
"value": "web",
|
||
"name": "网页端"
|
||
},
|
||
{
|
||
"value": "pda",
|
||
"name": "PDA端"
|
||
},
|
||
{
|
||
"value": "app",
|
||
"name": "APP端"
|
||
},
|
||
{
|
||
"value": "wx",
|
||
"name": "微信端"
|
||
},
|
||
{
|
||
"value": "miniProgram",
|
||
"name": "小程序端"
|
||
},
|
||
{
|
||
"value": "other",
|
||
"name": "其他"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"type": "string",
|
||
"required": true,
|
||
"name": "project",
|
||
"description": "项目标识,如 all/warehouse/store/tms",
|
||
"list": [
|
||
{
|
||
"value": "all",
|
||
"name": "全部"
|
||
},
|
||
{
|
||
"value": "warehouse",
|
||
"name": "仓库"
|
||
},
|
||
{
|
||
"value": "store",
|
||
"name": "货主"
|
||
},
|
||
{
|
||
"value": "tms",
|
||
"name": "物流"
|
||
}
|
||
]
|
||
}
|
||
],
|
||
"methods": {
|
||
"groups": [
|
||
{
|
||
"groupName": "配置模块",
|
||
"module": "config",
|
||
"list": [
|
||
{
|
||
"method": "config.list",
|
||
"description": "config.list 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "看板模块",
|
||
"module": "dashboard",
|
||
"list": [
|
||
{
|
||
"method": "dashboard.storeStats",
|
||
"description": "dashboard.storeStats 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "dashboard.warehouseStats",
|
||
"description": "dashboard.warehouseStats 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "dashboard.hot_order_rank",
|
||
"description": "dashboard.hot_order_rank 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "dashboard.express_ratio",
|
||
"description": "dashboard.express_ratio 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "dashboard.platform_distribution",
|
||
"description": "dashboard.platform_distribution 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "dashboard.order_trend",
|
||
"description": "dashboard.order_trend 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "基础模块",
|
||
"module": "index",
|
||
"list": [
|
||
{
|
||
"method": "index.fastWhereTree",
|
||
"description": "index.fastWhereTree 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "type",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "type 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.loadStores",
|
||
"description": "index.loadStores 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.getCOSUploadConfig",
|
||
"description": "index.getCOSUploadConfig 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "data",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "data 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.getImages",
|
||
"description": "index.getImages 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.uploadSuccessNotify",
|
||
"description": "index.uploadSuccessNotify 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.ReferenceFile",
|
||
"description": "index.ReferenceFile 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.getMessageDetail",
|
||
"description": "index.getMessageDetail 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.getI18nMessage",
|
||
"description": "index.getI18nMessage 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": false,
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "language",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body|query",
|
||
"description": "language 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.putI18nCollect",
|
||
"description": "index.putI18nCollect 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": false,
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "keys",
|
||
"type": "array",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "keys 参数"
|
||
},
|
||
{
|
||
"name": "locale",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "locale 参数"
|
||
},
|
||
{
|
||
"name": "project",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "project 参数"
|
||
},
|
||
{
|
||
"name": "source",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "source 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.tryAutoTranslateNewKeys",
|
||
"description": "index.tryAutoTranslateNewKeys 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.searchSpace",
|
||
"description": "index.searchSpace 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "index.getExpressList",
|
||
"description": "index.getExpressList 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "订单模块",
|
||
"module": "order",
|
||
"list": [
|
||
{
|
||
"method": "order.getOrderModels",
|
||
"description": "order.getOrderModels 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "order.list",
|
||
"description": "分页查询订单列表",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pagination 参数"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;常用字段包括 delivery_order_code、status、outbound_status、buyer_nick、mobile 与日期区间字段。示例:where.delivery_order_code={operator:like,value:SO202603}; where.status={operator:in,value:[created,pedding]}。"
|
||
}
|
||
],
|
||
"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、operator_name、operate_time_start、operate_time_end 等字段。示例: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、operator_name、operate_time_start、operate_time_end 等字段。示例: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": "订单审核(目录化路由)",
|
||
"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。示例:where.outbound_status={operator:in,value:[created,processing]}; 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": "是否包含已删除工号"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "动态筛选条件,仅支持 employee_id、account_id、real_name、status、username、phone、email、quickWhere;其中 username/phone/email 为账号字段,quickWhere 按 real_name/username/phone/email 模糊搜索"
|
||
}
|
||
],
|
||
"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": "头像访问地址"
|
||
},
|
||
{
|
||
"name": "data[].role_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "工号绑定的角色ID数组"
|
||
},
|
||
{
|
||
"name": "data[].roles[]",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "工号绑定的角色组详情"
|
||
},
|
||
{
|
||
"name": "data[].roles[].role_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "角色ID"
|
||
},
|
||
{
|
||
"name": "data[].roles[].role_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "角色编码"
|
||
},
|
||
{
|
||
"name": "data[].roles[].role_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "角色名称"
|
||
},
|
||
{
|
||
"name": "data[].roles[].pid",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "父级角色ID"
|
||
},
|
||
{
|
||
"name": "data[].roles[].status",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "角色状态:1=启用,0=停用"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "当前登录态缺少主体上下文(store_id)或 where 参数解析失败"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "查询失败"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.account.add",
|
||
"description": "新增工号,按手机号复用或创建账号后绑定到当前主体,并校验角色组 ids 不超出当前角色范围",
|
||
"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": "ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "角色组ID数组,必须在当前登录工号可分配角色范围内;若同时传入父子节点,仅保留父节点"
|
||
},
|
||
{
|
||
"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": "role_ids",
|
||
"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": "参数错误、手机号格式错误、直接使用保留名称、或 ids 超出当前角色范围"
|
||
},
|
||
{
|
||
"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": "更新工号姓名、头像引用和角色组 ids(含当前角色范围校验)",
|
||
"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,作为头像引用"
|
||
},
|
||
{
|
||
"name": "ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"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": "更新后的头像地址"
|
||
},
|
||
{
|
||
"name": "role_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "更新后的角色组ID数组"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数错误、未传 ids、或 ids 超出当前角色范围"
|
||
},
|
||
{
|
||
"code": "404",
|
||
"description": "工号或头像文件不存在"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "更新失败"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"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": "是否包含停用角色,默认 false"
|
||
},
|
||
{
|
||
"name": "includeSystem",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "是否包含系统默认角色(store_id=0/null),默认 false"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "employee_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当前登录工号ID,未识别到登录工号时为 null"
|
||
},
|
||
{
|
||
"name": "roles[]",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "角色列表"
|
||
},
|
||
{
|
||
"name": "roles[].role_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "角色ID"
|
||
},
|
||
{
|
||
"name": "roles[].role_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "角色名称"
|
||
},
|
||
{
|
||
"name": "roles[].selected",
|
||
"type": "boolean",
|
||
"required": true,
|
||
"description": "表示当前登录工号是否已绑定该角色"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数错误"
|
||
},
|
||
{
|
||
"code": "404",
|
||
"description": "工号不存在或无权限"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "查询失败"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.role.add",
|
||
"description": "新增角色并一次性提交权限集(permission_ids)",
|
||
"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": "description",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "角色描述"
|
||
},
|
||
{
|
||
"name": "pid",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "父级角色ID,默认 0"
|
||
},
|
||
{
|
||
"name": "permission_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "权限ID数组,一次性提交"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "role_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新建角色ID"
|
||
},
|
||
{
|
||
"name": "role_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "角色编码"
|
||
},
|
||
{
|
||
"name": "role_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "角色名称"
|
||
},
|
||
{
|
||
"name": "permission_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "提交后的权限ID集合"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数错误、权限ID非法或超出当前登录工号可用权限集"
|
||
},
|
||
{
|
||
"code": "409",
|
||
"description": "role_code 冲突"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "新增失败"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.role.delete",
|
||
"description": "批量删除角色(软删除),并清理对应角色权限关联",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "角色ID数组"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "请求的角色ID数组"
|
||
},
|
||
{
|
||
"name": "deleted_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "本次实际删除(由启用变为停用)的角色ID数组"
|
||
},
|
||
{
|
||
"name": "already_deleted_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "本就处于删除状态的角色ID数组"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "固定返回 deleted"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数错误,ids 必须为正整数数组"
|
||
},
|
||
{
|
||
"code": "404",
|
||
"description": "角色不存在、无权限操作或为系统预设角色(任一ID不满足即失败)"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "删除失败"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.role.update",
|
||
"description": "更新角色信息并一次性重置角色权限(permission_ids)",
|
||
"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": "role_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "角色名称"
|
||
},
|
||
{
|
||
"name": "description",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "角色描述"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "角色状态:1=启用,0=禁用"
|
||
},
|
||
{
|
||
"name": "pid",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "父级角色ID"
|
||
},
|
||
{
|
||
"name": "permission_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "权限ID数组,一次性提交"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "role_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "角色ID"
|
||
},
|
||
{
|
||
"name": "permission_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "更新后的权限ID集合"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数错误、permission_ids 非法或超出当前登录工号可用权限集"
|
||
},
|
||
{
|
||
"code": "404",
|
||
"description": "角色不存在、无权限操作或为系统预设角色"
|
||
},
|
||
{
|
||
"code": "409",
|
||
"description": "角色信息冲突"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "更新失败"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"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": "可选,不传时默认使用当前登录工号的当前角色计算权限选中状态"
|
||
},
|
||
{
|
||
"name": "type",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "可选,按权限类型筛选,如 api/web_pages/pda_pages/btns"
|
||
},
|
||
{
|
||
"name": "keyword",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "可选,按 path/name/meta_title 模糊搜索"
|
||
},
|
||
{
|
||
"name": "includeDisabled",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "是否包含禁用权限,默认 false"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "role_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "查询目标角色ID,未传 role_id 时返回当前登录工号的当前角色ID"
|
||
},
|
||
{
|
||
"name": "permissions[]",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "权限列表"
|
||
},
|
||
{
|
||
"name": "permissions[].permission_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "权限ID"
|
||
},
|
||
{
|
||
"name": "permissions[].path",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "权限路径"
|
||
},
|
||
{
|
||
"name": "permissions[].type",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "权限类型"
|
||
},
|
||
{
|
||
"name": "permissions[].selected",
|
||
"type": "boolean",
|
||
"required": true,
|
||
"description": "当传入 role_id 时,表示该权限是否已绑定"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数错误"
|
||
},
|
||
{
|
||
"code": "404",
|
||
"description": "角色不存在或无权限"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "查询失败"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.permission.add",
|
||
"description": "新增权限",
|
||
"isNeedAuth": true,
|
||
"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": "权限类型:web_pages/pda_pages/btns/api/miniprogram_pages/block"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "权限名称"
|
||
},
|
||
{
|
||
"name": "parent_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "父级权限ID,传 0 或不传表示顶级;若传入必须在当前登录工号可用权限集内"
|
||
},
|
||
{
|
||
"name": "meta_title",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "页面标题"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "排序,默认 0"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "permission_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "权限ID"
|
||
},
|
||
{
|
||
"name": "path",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "权限路径"
|
||
},
|
||
{
|
||
"name": "type",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "权限类型"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数错误或 parent_id 超出当前登录工号可用权限集"
|
||
},
|
||
{
|
||
"code": "404",
|
||
"description": "父级权限不存在"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "新增失败"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.permission.delete",
|
||
"description": "批量删除权限(软删除)",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "权限ID数组,必须在当前登录工号可用权限集内"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "请求的权限ID数组"
|
||
},
|
||
{
|
||
"name": "deleted_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "本次实际删除(由启用变为停用)的权限ID数组"
|
||
},
|
||
{
|
||
"name": "already_deleted_ids",
|
||
"type": "number[]",
|
||
"required": true,
|
||
"description": "本就处于删除状态的权限ID数组"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "固定返回 deleted"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数错误,ids 非法或包含超出当前登录工号可用权限集的权限ID"
|
||
},
|
||
{
|
||
"code": "404",
|
||
"description": "权限不存在"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "删除失败"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "setting.permission.update",
|
||
"description": "更新权限(非角色绑定重置),目标权限必须在当前登录工号可用权限集内",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "permission_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "权限ID,必须在当前登录工号可用权限集内"
|
||
},
|
||
{
|
||
"name": "path",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "权限路径"
|
||
},
|
||
{
|
||
"name": "type",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "权限类型:web_pages/pda_pages/btns/api/miniprogram_pages/block"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "权限名称"
|
||
},
|
||
{
|
||
"name": "parent_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "父级权限ID,传 0 表示顶级;若传入必须在当前登录工号可用权限集内"
|
||
},
|
||
{
|
||
"name": "sort",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "排序"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "权限状态:1=启用,0=禁用"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "permission_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "权限ID"
|
||
},
|
||
{
|
||
"name": "path",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新后的权限路径"
|
||
},
|
||
{
|
||
"name": "type",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "更新后的权限类型"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数错误、未提供更新项,或目标权限超出当前登录工号可用权限集"
|
||
},
|
||
{
|
||
"code": "404",
|
||
"description": "权限不存在"
|
||
},
|
||
{
|
||
"code": "500",
|
||
"description": "更新失败"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"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": "仓库商品关键字搜索",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "库存模块",
|
||
"module": "storage",
|
||
"list": [
|
||
{
|
||
"method": "storage.receiving.getReceivingList",
|
||
"description": "storage.receiving.getReceivingList 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "分页参数,支持 page/pageSize"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "统一 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.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": []
|
||
},
|
||
{
|
||
"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.create",
|
||
"description": "创建入库单",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_type",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "业务类型:SCRK/LYRK/CCRK/CGRK/DBRK/QTRK/B2BRK/XNRK"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "货主ID,不传默认使用当前用户 store_id"
|
||
},
|
||
{
|
||
"name": "entry_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "入库单号,不传时系统自动生成"
|
||
},
|
||
{
|
||
"name": "purchase_order_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "采购单号"
|
||
},
|
||
{
|
||
"name": "remark",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "备注"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新建入库单ID"
|
||
},
|
||
{
|
||
"name": "entry_order_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "入库单号"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数缺失或业务类型不合法"
|
||
},
|
||
{
|
||
"code": "409",
|
||
"description": "入库单号已存在"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.entry.addDetail",
|
||
"description": "新增入库明细",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "入库单ID"
|
||
},
|
||
{
|
||
"name": "count",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "计划入库数量,必须大于0"
|
||
},
|
||
{
|
||
"name": "item_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "商品编码"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新建明细ID"
|
||
},
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "所属入库单ID"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数不合法或状态不允许新增明细"
|
||
},
|
||
{
|
||
"code": "404",
|
||
"description": "入库单不存在或无权访问"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.entry.deleteDetail",
|
||
"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": "明细或入库单不存在"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.entry.detailChange",
|
||
"description": "修改入库明细",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "明细ID"
|
||
},
|
||
{
|
||
"name": "count",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "计划入库数量,必须大于0且不能小于已收货数量"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "修改成功的明细ID"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数不合法或没有可更新字段"
|
||
},
|
||
{
|
||
"code": "404",
|
||
"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": true,
|
||
"source": "body",
|
||
"description": "入库单ID"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "作废成功的入库单ID"
|
||
}
|
||
],
|
||
"errors": [
|
||
{
|
||
"code": "400",
|
||
"description": "参数不合法或已完成单据不允许作废"
|
||
},
|
||
{
|
||
"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": "store",
|
||
"list": [
|
||
{
|
||
"method": "store.createStore",
|
||
"description": "store.createStore 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "store.createWarehouse",
|
||
"description": "store.createWarehouse 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "store.joinStore",
|
||
"description": "store.joinStore 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "store.joinWarehouse",
|
||
"description": "store.joinWarehouse 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "store.getStoreRoles",
|
||
"description": "store.getStoreRoles 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "申请码(join_token)"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "store.auditApply",
|
||
"description": "store.auditApply 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "audit_status",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "审核状态(approved/rejected)"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "申请码(join_token)"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "当前审批门店ID"
|
||
},
|
||
{
|
||
"name": "role_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "分配角色ID数组"
|
||
},
|
||
{
|
||
"name": "reject_reason",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "拒绝原因(audit_status=rejected 时可传)"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "用户模块",
|
||
"module": "user",
|
||
"list": [
|
||
{
|
||
"method": "user.login",
|
||
"description": "用户登录(仅返回 token)",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": false,
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "password",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "password 参数"
|
||
},
|
||
{
|
||
"name": "username",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "username 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "user.loginByCode",
|
||
"description": "登录码登录(使用本系统缓存登录码,不依赖 ye4s_user.tmp_code)",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": false,
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "登录码(6位字母数字混合,对应本系统登录码缓存)"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "user.getLoginWechatCode",
|
||
"description": "获取微信扫码登录码:不传客户端编码时生成新的6位客户端编码与登录码;传客户端编码且缓存命中时进入长轮询,优先监听 Redis 登录事件,收到 ye4s_user_id 后立即签发登录 token;未收到事件则刷新登录码返回",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": false,
|
||
"headers": [],
|
||
"params": [
|
||
{
|
||
"name": "clientCode",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "客户端编码(6位字母数字混合)。不传则服务端自动生成;传入时仅在缓存命中才进入长轮询,缓存不存在按空值处理并重新分配 clientCode"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "client_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "客户端编码(6位字母数字混合)"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "微信扫码登录码(6位字母数字混合)。当 status=authorized 时可能为空"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "登录状态:pending(等待扫码)或 authorized(已完成登录)"
|
||
},
|
||
{
|
||
"name": "updated_at",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "状态更新时间(ISO 时间)"
|
||
},
|
||
{
|
||
"name": "expires_at",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "过期时间戳(毫秒)"
|
||
},
|
||
{
|
||
"name": "expire_after_ms",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "距离过期剩余毫秒数"
|
||
},
|
||
{
|
||
"name": "source",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "数据来源,如 generated/refreshed/cache/event"
|
||
},
|
||
{
|
||
"name": "ye4s_user_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "当 status=authorized 时返回的 ye4s 用户ID"
|
||
},
|
||
{
|
||
"name": "loginToken",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "当 status=authorized 时返回的本地登录 token"
|
||
}
|
||
],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "user.getBindWechatCode",
|
||
"description": "获取微信绑定状态与绑定码:绑定码为6位字母数字混合且固定60秒有效,默认立即返回;longPoll=true 时最长等待60秒,若无事件则自动刷新新码返回",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "longPoll",
|
||
"type": "boolean",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "是否启用长轮询;默认 false,true 时等待绑定事件或超时刷新"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "account_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "WMS 账号ID"
|
||
},
|
||
{
|
||
"name": "code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "绑定码(已绑定时为空字符串)"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "绑定状态:pending/scanned/bound"
|
||
},
|
||
{
|
||
"name": "is_bound",
|
||
"type": "boolean",
|
||
"required": true,
|
||
"description": "是否已绑定微信"
|
||
},
|
||
{
|
||
"name": "updated_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "状态更新时间(ISO 时间)"
|
||
},
|
||
{
|
||
"name": "expires_at",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "过期时间戳(毫秒),bound 状态可为空"
|
||
},
|
||
{
|
||
"name": "expire_after_ms",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "距离过期剩余毫秒数"
|
||
},
|
||
{
|
||
"name": "scanned_at",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "扫码时间(未扫码可为空)"
|
||
},
|
||
{
|
||
"name": "source",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "数据来源,如 cache/generated/refreshed/db"
|
||
},
|
||
{
|
||
"name": "ye4s_user_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "已绑定的 ye4s 用户ID(未绑定可为空)"
|
||
}
|
||
],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "user.unbindWechat",
|
||
"description": "解绑微信账号(清理 ye4s 关联账号数据)",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "user.logout",
|
||
"description": "用户登出",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "user.info",
|
||
"description": "获取当前用户信息",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "user.changeRole",
|
||
"description": "user.changeRole 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "user.register",
|
||
"description": "user.register 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": false,
|
||
"headers": [],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"groupName": "仓库模块",
|
||
"module": "warehouse",
|
||
"list": [
|
||
{
|
||
"method": "warehouse.getWarehouseZones",
|
||
"description": "warehouse.getWarehouseZones 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.getWarehouseTree",
|
||
"description": "warehouse.getWarehouseTree 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouseId",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "warehouseId 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.getChildren",
|
||
"description": "warehouse.getChildren 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "zoneId",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "zoneId 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.create",
|
||
"description": "warehouse.create 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.update",
|
||
"description": "warehouse.update 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
},
|
||
{
|
||
"name": "aisles",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "aisles 参数"
|
||
},
|
||
{
|
||
"name": "cell_height",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "cell_height 参数"
|
||
},
|
||
{
|
||
"name": "cell_length",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "cell_length 参数"
|
||
},
|
||
{
|
||
"name": "cell_width",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "cell_width 参数"
|
||
},
|
||
{
|
||
"name": "direction",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "direction 参数"
|
||
},
|
||
{
|
||
"name": "height",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "height 参数"
|
||
},
|
||
{
|
||
"name": "length",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "length 参数"
|
||
},
|
||
{
|
||
"name": "rack_columns",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "rack_columns 参数"
|
||
},
|
||
{
|
||
"name": "rack_levels",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "rack_levels 参数"
|
||
},
|
||
{
|
||
"name": "rack_rows",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "rack_rows 参数"
|
||
},
|
||
{
|
||
"name": "width",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "width 参数"
|
||
},
|
||
{
|
||
"name": "x",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "x 参数"
|
||
},
|
||
{
|
||
"name": "y",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "y 参数"
|
||
},
|
||
{
|
||
"name": "z",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "z 参数"
|
||
},
|
||
{
|
||
"name": "zone_code",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "zone_code 参数"
|
||
},
|
||
{
|
||
"name": "zone_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "zone_name 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.delete",
|
||
"description": "warehouse.delete 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.detail",
|
||
"description": "warehouse.detail 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.checkBarcodeUnique",
|
||
"description": "warehouse.checkBarcodeUnique 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "barcode",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "barcode 参数"
|
||
},
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.toggleActive",
|
||
"description": "warehouse.toggleActive 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
},
|
||
{
|
||
"name": "isActive",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "isActive 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.getPath",
|
||
"description": "warehouse.getPath 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.createRack",
|
||
"description": "warehouse.createRack 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "height",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "height 参数"
|
||
},
|
||
{
|
||
"name": "length",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "length 参数"
|
||
},
|
||
{
|
||
"name": "rack_columns",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "rack_columns 参数"
|
||
},
|
||
{
|
||
"name": "rack_levels",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "rack_levels 参数"
|
||
},
|
||
{
|
||
"name": "rack_rows",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "rack_rows 参数"
|
||
},
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "warehouse_id 参数"
|
||
},
|
||
{
|
||
"name": "width",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "width 参数"
|
||
},
|
||
{
|
||
"name": "x",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "x 参数"
|
||
},
|
||
{
|
||
"name": "y",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "y 参数"
|
||
},
|
||
{
|
||
"name": "zone_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "zone_code 参数"
|
||
},
|
||
{
|
||
"name": "zone_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "zone_name 参数"
|
||
},
|
||
{
|
||
"name": "color",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "color 参数"
|
||
},
|
||
{
|
||
"name": "direction",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "direction 参数"
|
||
},
|
||
{
|
||
"name": "parent_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "parent_id 参数"
|
||
},
|
||
{
|
||
"name": "z",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "z 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.getPickPath",
|
||
"description": "warehouse.getPickPath 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "query",
|
||
"description": "warehouse_id 参数"
|
||
},
|
||
{
|
||
"name": "include_spaces",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "query",
|
||
"description": "include_spaces 参数"
|
||
},
|
||
{
|
||
"name": "limit",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "query",
|
||
"description": "limit 参数"
|
||
},
|
||
{
|
||
"name": "sort_by",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "query",
|
||
"description": "sort_by 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.updateRackPosition",
|
||
"description": "warehouse.updateRackPosition 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "x",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "x 参数"
|
||
},
|
||
{
|
||
"name": "y",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "y 参数"
|
||
},
|
||
{
|
||
"name": "rack_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "path",
|
||
"description": "rack_id 参数"
|
||
},
|
||
{
|
||
"name": "z",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "z 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.recalculatePickPath",
|
||
"description": "warehouse.recalculatePickPath 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "warehouse_id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.updateNeighbors",
|
||
"description": "warehouse.updateNeighbors 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "warehouse_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "warehouse_id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.getAreaRacks",
|
||
"description": "warehouse.getAreaRacks 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "area_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "query",
|
||
"description": "area_id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.getSpacesByRack",
|
||
"description": "warehouse.getSpacesByRack 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.createRackWithSpaces",
|
||
"description": "warehouse.createRackWithSpaces 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.getSpaceInfo",
|
||
"description": "warehouse.getSpaceInfo 接口",
|
||
"isNeedAuth": false,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
},
|
||
{
|
||
"method": "warehouse.updateSpaceInfo",
|
||
"description": "warehouse.updateSpaceInfo 接口",
|
||
"isNeedAuth": true,
|
||
"isNeedLogin": true,
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"source": "body",
|
||
"description": "id 参数"
|
||
},
|
||
{
|
||
"name": "custom_barcode",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "custom_barcode 参数"
|
||
},
|
||
{
|
||
"name": "custom_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "custom_name 参数"
|
||
},
|
||
{
|
||
"name": "location_type_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "location_type_id 参数"
|
||
},
|
||
{
|
||
"name": "pick_sequence",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "pick_sequence 参数"
|
||
},
|
||
{
|
||
"name": "space_status",
|
||
"type": "string",
|
||
"required": false,
|
||
"source": "body",
|
||
"description": "space_status 参数"
|
||
}
|
||
],
|
||
"response": [],
|
||
"errors": []
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|
||
}
|