2026-05-15 18:22:48 +08:00

873 lines
22 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

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

{
"generatedAt": "2026-05-15 17:32:36",
"generatedAtLocal": "2026-05-15 17:32:36",
"source": "remote",
"filter": {
"platform": {
"value": "web",
"label": "网页端"
},
"project": {
"value": "all",
"label": "全部"
}
},
"module": {
"name": "仓库模块",
"key": "warehouse",
"folder": "warehouse",
"interfaceCount": 21
},
"changes": {
"fromPreviousSnapshot": {
"moduleAdded": false,
"moduleRenamed": false,
"interfaceChanges": {
"addedMethods": [],
"deletedMethods": [],
"paramsUpdatedMethods": [],
"responseUpdatedMethods": []
}
}
},
"interfaces": [
{
"method": "warehouse.getWarehouseZones",
"title": "warehouse.getWarehouseZones 接口",
"description": "warehouse.getWarehouseZones 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"method": "warehouse.getWarehouseTree",
"title": "warehouse.getWarehouseTree 接口",
"description": "warehouse.getWarehouseTree 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouseId",
"type": "number",
"required": true,
"description": "warehouseId 参数"
}
],
"response": []
},
{
"method": "warehouse.getChildren",
"title": "warehouse.getChildren 接口",
"description": "warehouse.getChildren 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "zoneId",
"type": "number",
"required": true,
"description": "zoneId 参数"
}
],
"response": []
},
{
"method": "warehouse.create",
"title": "warehouse.create 接口",
"description": "warehouse.create 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
},
{
"method": "warehouse.update",
"title": "warehouse.update 接口",
"description": "warehouse.update 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
},
{
"name": "aisles",
"type": "string",
"required": false,
"description": "aisles 参数"
},
{
"name": "cell_height",
"type": "string",
"required": false,
"description": "cell_height 参数"
},
{
"name": "cell_length",
"type": "string",
"required": false,
"description": "cell_length 参数"
},
{
"name": "cell_width",
"type": "string",
"required": false,
"description": "cell_width 参数"
},
{
"name": "direction",
"type": "string",
"required": false,
"description": "direction 参数"
},
{
"name": "height",
"type": "number",
"required": false,
"description": "height 参数"
},
{
"name": "is_active",
"type": "boolean",
"required": false,
"description": "是否启用,支持 true/false 或 1/0"
},
{
"name": "length",
"type": "number",
"required": false,
"description": "length 参数"
},
{
"name": "rack_columns",
"type": "string",
"required": false,
"description": "rack_columns 参数"
},
{
"name": "rack_levels",
"type": "string",
"required": false,
"description": "rack_levels 参数"
},
{
"name": "rack_rows",
"type": "string",
"required": false,
"description": "rack_rows 参数"
},
{
"name": "width",
"type": "number",
"required": false,
"description": "width 参数"
},
{
"name": "x",
"type": "number",
"required": false,
"description": "x 参数"
},
{
"name": "y",
"type": "number",
"required": false,
"description": "y 参数"
},
{
"name": "z",
"type": "number",
"required": false,
"description": "z 参数"
},
{
"name": "zone_code",
"type": "string",
"required": false,
"description": "zone_code 参数"
},
{
"name": "zone_name",
"type": "string",
"required": false,
"description": "zone_name 参数"
}
],
"response": []
},
{
"method": "warehouse.delete",
"title": "warehouse.delete 接口",
"description": "warehouse.delete 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"method": "warehouse.detail",
"title": "warehouse.detail 接口",
"description": "warehouse.detail 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"method": "warehouse.checkBarcodeUnique",
"title": "warehouse.checkBarcodeUnique 接口",
"description": "warehouse.checkBarcodeUnique 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "barcode",
"type": "string",
"required": true,
"description": "barcode 参数"
},
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"method": "warehouse.toggleActive",
"title": "warehouse.toggleActive 接口",
"description": "warehouse.toggleActive 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
},
{
"name": "isActive",
"type": "string",
"required": false,
"description": "isActive 参数"
}
],
"response": []
},
{
"method": "warehouse.getPath",
"title": "warehouse.getPath 接口",
"description": "warehouse.getPath 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"method": "warehouse.getPickPath",
"title": "warehouse.getPickPath 接口",
"description": "warehouse.getPickPath 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "warehouse_id 参数"
},
{
"name": "include_spaces",
"type": "string",
"required": false,
"description": "include_spaces 参数"
},
{
"name": "limit",
"type": "number",
"required": false,
"description": "limit 参数"
},
{
"name": "sort_by",
"type": "string",
"required": false,
"description": "sort_by 参数"
}
],
"response": []
},
{
"method": "warehouse.updateRackPosition",
"title": "warehouse.updateRackPosition 接口",
"description": "warehouse.updateRackPosition 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "x",
"type": "number",
"required": true,
"description": "x 参数"
},
{
"name": "y",
"type": "number",
"required": true,
"description": "y 参数"
},
{
"name": "rack_id",
"type": "number",
"required": false,
"description": "rack_id 参数"
},
{
"name": "z",
"type": "number",
"required": false,
"description": "z 参数"
}
],
"response": []
},
{
"method": "warehouse.recalculatePickPath",
"title": "warehouse.recalculatePickPath 接口",
"description": "warehouse.recalculatePickPath 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "warehouse_id 参数"
}
],
"response": []
},
{
"method": "warehouse.updateNeighbors",
"title": "warehouse.updateNeighbors 接口",
"description": "warehouse.updateNeighbors 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "warehouse_id",
"type": "number",
"required": true,
"description": "warehouse_id 参数"
}
],
"response": []
},
{
"method": "warehouse.getAreaRacks",
"title": "warehouse.getAreaRacks 接口",
"description": "warehouse.getAreaRacks 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "area_id",
"type": "number",
"required": true,
"description": "area_id 参数"
}
],
"response": []
},
{
"method": "warehouse.getSpacesByRack",
"title": "warehouse.getSpacesByRack 接口",
"description": "warehouse.getSpacesByRack 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"method": "warehouse.createRackWithSpaces",
"title": "warehouse.createRackWithSpaces 接口",
"description": "warehouse.createRackWithSpaces 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
}
],
"response": []
},
{
"method": "warehouse.exportRackSpaces",
"title": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)",
"description": "按货架ID导出仓位模板(含仓库编码、仓位编码、自定义名称、自定义条码、拣货顺序、仓位类型)",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "货架ID,仅导出该货架下仓位"
}
],
"response": [
{
"name": "count",
"type": "number",
"required": false,
"description": "导出记录数"
},
{
"name": "fileName",
"type": "string",
"required": false,
"description": "导出文件名"
},
{
"name": "fileUrl",
"type": "string",
"required": false,
"description": "导出文件下载地址"
}
]
},
{
"method": "warehouse.batchUpdateSpaceInfo",
"title": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。",
"description": "按导出模板批量修改货架仓位信息,任一行越界或冲突则整批失败。前端提交示例:{ id: 36, items: [ { space_code: 'A01-01-01', custom_name: '拣货位1', custom_barcode: 'PICK-001', pick_sequence: 10, location_type_id: 3 } ] }。其中 id 为货架ID(可选,传入时只允许操作该货架下的仓位),space_code 为必填定位键,location_type_id 为仓位类型主键(可通过 index.getLocationTypeList 获取)。",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": false,
"description": "货架ID,传入时校验所有 space_code 必须属于该货架,不传则只校验属于任意货架类型库位"
},
{
"name": "items",
"type": "array",
"required": true,
"description": "批量修改数据数组;每项支持字段:space_code、custom_name、custom_barcode、pick_sequence、location_type_name"
},
{
"name": "items[].space_code",
"type": "string",
"required": true,
"description": "仓位编码,作为批量修改的唯一定位键;缺失、重复或不存在都会整批失败"
},
{
"name": "items[].custom_name",
"type": "string",
"required": false,
"description": "自定义名称,空字符串会被清空"
},
{
"name": "items[].custom_barcode",
"type": "string",
"required": false,
"description": "自定义条码,批次内或系统内冲突都会整批失败;空字符串会被清空"
},
{
"name": "items[].pick_sequence",
"type": "number",
"required": false,
"description": "拣货顺序,必须为非负整数,超出边界则整批失败"
},
{
"name": "items[].location_type_id",
"type": "number",
"required": false,
"description": "仓位类型ID,必须为正整数且在当前仓库或全局类型中存在(is_active=true),否则整批失败;传 null 或不传则不修改仓位类型"
}
],
"response": [
{
"name": "count",
"type": "number",
"required": false,
"description": "成功更新的记录数"
}
]
},
{
"method": "warehouse.getSpaceInfo",
"title": "warehouse.getSpaceInfo 接口",
"description": "warehouse.getSpaceInfo 接口",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": false,
"description": "id 参数"
}
],
"response": []
},
{
"method": "warehouse.updateSpaceInfo",
"title": "warehouse.updateSpaceInfo 接口",
"description": "warehouse.updateSpaceInfo 接口",
"endpoint": "/system",
"authRequired": true,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "id",
"type": "number",
"required": true,
"description": "id 参数"
},
{
"name": "custom_barcode",
"type": "string",
"required": false,
"description": "custom_barcode 参数"
},
{
"name": "custom_name",
"type": "string",
"required": false,
"description": "custom_name 参数"
},
{
"name": "location_type_id",
"type": "number",
"required": false,
"description": "location_type_id 参数"
},
{
"name": "pick_sequence",
"type": "string",
"required": false,
"description": "pick_sequence 参数"
},
{
"name": "space_status",
"type": "string",
"required": false,
"description": "space_status 参数"
}
],
"response": []
}
]
}