300 lines
9.4 KiB
JSON
300 lines
9.4 KiB
JSON
{
|
||
"generatedAt": "2026-06-11 13:47:01",
|
||
"generatedAtLocal": "2026-06-11 13:47:01",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "打印模块",
|
||
"key": "order.print",
|
||
"folder": "order.print",
|
||
"interfaceCount": 4
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "order.print.getWavePrintData",
|
||
"title": "按波次 IDs 获取订单打印数据,自动过滤快递未完全分配的波次,返回通过过滤的波次订单明细,按波次号分组",
|
||
"description": "按波次 IDs 获取订单打印数据,自动过滤快递未完全分配的波次,返回通过过滤的波次订单明细,按波次号分组",
|
||
"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": "仓库ID"
|
||
},
|
||
{
|
||
"name": "wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "summary",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "汇总信息"
|
||
},
|
||
{
|
||
"name": "wave_list",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "波次列表(按 wave_no 排序)"
|
||
},
|
||
{
|
||
"name": "ext",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "扩展字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.print.getWavePlatformPrintData",
|
||
"title": "按波次 IDs 获取平台打印中间态数据,自动过滤快递未完全分配的波次,返回 waveGroups(波次 -> 平台 -> 订单)结构",
|
||
"description": "按波次 IDs 获取平台打印中间态数据,自动过滤快递未完全分配的波次,返回 waveGroups(波次 -> 平台 -> 订单)结构",
|
||
"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": "仓库ID(必须与当前用户上下文 store_id 一致)"
|
||
},
|
||
{
|
||
"name": "wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "summary",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "汇总信息"
|
||
},
|
||
{
|
||
"name": "wave_ids",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "通过过滤的波次ID数组"
|
||
},
|
||
{
|
||
"name": "waveGroups",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "主返回结构:按波次分组(波次 -> 平台 -> 订单)"
|
||
},
|
||
{
|
||
"name": "platform_groups",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "兼容字段:按平台分组结果(保留以兼容旧客户端)"
|
||
},
|
||
{
|
||
"name": "order_list",
|
||
"type": "array",
|
||
"required": false,
|
||
"description": "兼容字段:逐单平台打印中间态明细(保留以兼容旧客户端)"
|
||
},
|
||
{
|
||
"name": "ext",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "扩展字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.print.unlockWavePlatformPrintDataByGroup",
|
||
"title": "按分组解锁波次平台打印锁:按传入的 groups 条件匹配已锁定订单并将其 print_lock_status 置为 none,返回解锁统计与解锁订单列表。",
|
||
"description": "按分组解锁波次平台打印锁:按传入的 groups 条件匹配已锁定订单并将其 print_lock_status 置为 none,返回解锁统计与解锁订单列表。",
|
||
"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": "仓库ID(必须与当前用户上下文 store_id 一致)"
|
||
},
|
||
{
|
||
"name": "wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "波次ID列表(支持数字或字符串,内部自动去重与归一化)"
|
||
},
|
||
{
|
||
"name": "group_type",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "分组类型,支持 platform、platform_express、order;默认 platform_express"
|
||
},
|
||
{
|
||
"name": "unlock_scope",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "解锁范围,支持 group、wave;默认 group"
|
||
},
|
||
{
|
||
"name": "groups",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "分组条件列表。元素为对象,可包含字段:wave_id(必填)、platform(平台编码)、sys_logistics_code(系统快递编码)、order_ids(订单ID数组)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "summary",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "解锁操作的汇总统计"
|
||
},
|
||
{
|
||
"name": "wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "通过过滤的波次ID数组"
|
||
},
|
||
{
|
||
"name": "unlocked_order_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "被解锁的订单ID数组"
|
||
},
|
||
{
|
||
"name": "unlocked_orders",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "被解锁订单简要信息列表"
|
||
},
|
||
{
|
||
"name": "ext",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "扩展字段"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.print.getOrderPrintData",
|
||
"title": "按订单ID拉取平台打印中间态数据,与 getWavePlatformPrintData 返回结构一致。不限制打印锁定状态,所有订单(包括已锁定)统一返回。仓库ID统一从当前上下文获取,无需调用方传入。自动过滤快递未完全分配的订单(post_status !== 'fin'),返回 waveGroups(波次 -> 平台 -> 订单)结构。",
|
||
"description": "按订单ID拉取平台打印中间态数据,与 getWavePlatformPrintData 返回结构一致。不限制打印锁定状态,所有订单(包括已锁定)统一返回。仓库ID统一从当前上下文获取,无需调用方传入。自动过滤快递未完全分配的订单(post_status !== 'fin'),返回 waveGroups(波次 -> 平台 -> 订单)结构。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "订单ID列表(支持数字或字符串,内部自动去重与归一化,必须为非空数组)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "summary",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "汇总信息"
|
||
},
|
||
{
|
||
"name": "wave_ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "通过过滤的波次ID数组"
|
||
},
|
||
{
|
||
"name": "waveGroups",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "主返回结构:按波次分组(波次 -> 平台 -> 订单)"
|
||
},
|
||
{
|
||
"name": "ext",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "扩展字段"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|