2026-06-02 18:10:32 +08:00

250 lines
6.3 KiB
JSON

{
"generatedAt": "2026-06-02 13:57:54",
"generatedAtLocal": "2026-06-02 13:57:54",
"source": "remote",
"filter": {
"platform": {
"value": "web",
"label": "网页端"
},
"project": {
"value": "all",
"label": "全部"
}
},
"module": {
"name": "package-supplier-module",
"key": "setting.packageSupplier",
"folder": "setting.packagesupplier",
"interfaceCount": 5
},
"changes": {
"fromPreviousSnapshot": {
"moduleAdded": false,
"moduleRenamed": false,
"interfaceChanges": {
"addedMethods": [],
"deletedMethods": [],
"paramsUpdatedMethods": [],
"responseUpdatedMethods": []
}
}
},
"interfaces": [
{
"method": "setting.packageSupplier.create",
"title": "Create package supplier (current warehouse scope)",
"description": "Create package supplier (current warehouse scope)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "supplier_code",
"type": "string",
"required": true,
"description": "Supplier code (uppercased, unique in warehouse)"
},
{
"name": "supplier_name",
"type": "string",
"required": true,
"description": "Supplier name"
},
{
"name": "contact_name",
"type": "string",
"required": false,
"description": "Contact name"
},
{
"name": "contact_phone",
"type": "string",
"required": false,
"description": "Contact phone"
},
{
"name": "status",
"type": "number",
"required": false,
"description": "Status 0/1, default 1"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "Created supplier id"
}
]
},
{
"method": "setting.packageSupplier.update",
"title": "Update package supplier by id (partial update supported)",
"description": "Update package supplier by id (partial update supported)",
"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": "Supplier id (also supports supplier_id / supplierId)"
}
],
"response": [
{
"name": "id",
"type": "number",
"required": true,
"description": "Supplier id"
}
]
},
{
"method": "setting.packageSupplier.delete",
"title": "Delete package suppliers (supports ids array or comma-separated string)",
"description": "Delete package suppliers (supports ids array or comma-separated string)",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "ids",
"type": "array|number|string",
"required": true,
"description": "IDs to delete"
}
],
"response": [
{
"name": "deleted",
"type": "boolean",
"required": true,
"description": "Deleted flag"
}
]
},
{
"method": "setting.packageSupplier.get",
"title": "Get package supplier list (supports where + pagination). list is an alias to get; prefer get.",
"description": "Get package supplier list (supports where + pagination). list is an alias to get; prefer get.",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [
{
"name": "pagination",
"type": "object",
"required": false,
"description": "Pagination parameters"
},
{
"name": "where",
"type": "object",
"required": false,
"description": "Filter conditions"
}
],
"response": [
{
"name": "page",
"type": "number",
"required": true,
"description": "Current page"
},
{
"name": "page_size",
"type": "number",
"required": true,
"description": "Page size"
},
{
"name": "total",
"type": "number",
"required": true,
"description": "Total"
},
{
"name": "list",
"type": "array",
"required": true,
"description": "Supplier array"
}
]
},
{
"method": "setting.packageSupplier.list",
"title": "Compatibility alias for get; internally forwards to get. Prefer setting.packageSupplier.get.",
"description": "Compatibility alias for get; internally forwards to get. Prefer setting.packageSupplier.get.",
"endpoint": "/system",
"authRequired": false,
"loginRequired": true,
"status": {
"isUsed": false,
"isPlaceholder": false
},
"headers": [
{
"name": "Authorization",
"type": "string",
"required": true,
"description": "Bearer token"
}
],
"params": [],
"response": []
}
]
}