215 lines
10 KiB
JSON
215 lines
10 KiB
JSON
{
|
||
"generatedAt": "2026-06-12 15:55:40",
|
||
"generatedAtLocal": "2026-06-12 15:55:40",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "订单待处理模块",
|
||
"key": "order",
|
||
"folder": "order",
|
||
"interfaceCount": 3
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "order.wave.batchList",
|
||
"title": "波次列表查询。仅使用当前登录操作者仓库上下文(禁止传入 warehouse_id/warehouseId)。支持 where 白名单过滤,固定查询 wave_status=0/1;返回波次基础信息及分配状态汇总。支持 only_todo=1 仅返回仍有未复核订单的波次,并返回复核状态汇总(review_assignment_status)与未复核数量(unreviewed_order_count)。",
|
||
"description": "波次列表查询。仅使用当前登录操作者仓库上下文(禁止传入 warehouse_id/warehouseId)。支持 where 白名单过滤,固定查询 wave_status=0/1;返回波次基础信息及分配状态汇总。支持 only_todo=1 仅返回仍有未复核订单的波次,并返回复核状态汇总(review_assignment_status)与未复核数量(unreviewed_order_count)。",
|
||
"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": "分页参数,支持 page / pageSize"
|
||
},
|
||
{
|
||
"name": "only_todo",
|
||
"type": "number|boolean|string",
|
||
"required": false,
|
||
"description": "是否仅返回待处理(仍有未复核订单)的波次,默认 0;传 1/true 时仅返回 unreviewed_order_count > 0 的波次。"
|
||
},
|
||
{
|
||
"name": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "筛选白名单字段(object,可选)。仅支持下列字段过滤,且禁止传入 warehouse_id / warehouseId: - wave_id(等值) - wave_no(模糊) - wave_type(等值) - wave_status(等值,接口固定叠加状态 0/1) - creator(模糊) - logistics_name(模糊) - item_part_type(等值) - item_part(模糊) - item_snapshot_key(模糊) - item_detail_machine(模糊) - distinguish_express(等值) - total_orders_min / total_orders_max(范围) - processed_orders_min / processed_orders_max(范围) - express_assignment_status(等值,string,可选,英文枚举,取值:unassigned、partially_assigned、assigned;语义:按快递分配聚合判断,assigned 表示聚合后全部 fin,partially_assigned 表示部分已分配且不含 error,unassigned 表示全 none 或包含 error(异常并入未分配集合))。 - print_assignment_status(等值,string,可选,英文枚举,取值:unprinted、partially_printed、printed;语义:按打印分配聚合判断,printed 表示聚合后全部已打印)。 - storage_assignment_status(等值,string,可选,取值:未分配、部分分配、已分配;默认不传不做限制)。过滤语义:已分配=聚合后全部 fin;部分分配=不含 error,且既不是全 none,也不是全 fin;未分配=全 none 或包含 error(异常并入未分配筛选集合)。说明:返回字段 storage_assignment_status 的展示值保持不变,包含 error 时仍可显示“分配异常”;此处 where 的过滤语义会把异常计入“未分配”,以避免把过滤语义与展示值混淆。 - source(可选,number)来源过滤:0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务;不传则不过滤。 说明:express_assignment_status 与 print_assignment_status 要求使用英文枚举值;storage_assignment_status 仍向后兼容中文展示值。若传入的枚举值不在允许集合内,接口会返回 400(参数校验失败),并在 message 中说明错误字段与允许取值。 - review_assignment_status(等值,string,可选,英文枚举:unreviewed、partially_reviewed、reviewed;分别表示未复核、部分复核、已复核)。"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "波次列表,包含波次基础信息与状态汇总(order_count / storage_assignment_status / express_assignment_status / print_assignment_status / review_assignment_status / unreviewed_order_count)。每条记录新增字段 source(number):来源标识,0=普通波次(正常后台操作),1=管理后台策略任务,2=PDA策略任务。"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.downloadCreateTemplate",
|
||
"title": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为 .xlsx 附件下载。表头中标注 * 的列为必填项(橙色背景),可选列为灰色背景,包含示例数据行和填写说明工作表。多行相同订单号的行组成一个完整订单,每行代表一条商品明细。模板必填列:订单号(delivery_order_code)、收件人姓名(name)、手机号(mobile)、详细地址(detail_address)、商品编码(item_code)、计划数量(plan_qty);非必填列含:货主ID(store_id)、省份(province)、城市(city)、区/县(area)、店铺名称(shop_nick)等。",
|
||
"description": "下载创建订单的 Excel 导入模板。返回 base64 编码的 xlsx 文件,前端解码后作为 .xlsx 附件下载。表头中标注 * 的列为必填项(橙色背景),可选列为灰色背景,包含示例数据行和填写说明工作表。多行相同订单号的行组成一个完整订单,每行代表一条商品明细。模板必填列:订单号(delivery_order_code)、收件人姓名(name)、手机号(mobile)、详细地址(detail_address)、商品编码(item_code)、计划数量(plan_qty);非必填列含:货主ID(store_id)、省份(province)、城市(city)、区/县(area)、店铺名称(shop_nick)等。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": [
|
||
{
|
||
"name": "base64",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "base64 编码的 xlsx 文件内容"
|
||
},
|
||
{
|
||
"name": "filename",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "建议保存的文件名,固定为 创建订单导入模板.xlsx"
|
||
},
|
||
{
|
||
"name": "mime",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "文件 MIME 类型,固定为 application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
|
||
},
|
||
{
|
||
"name": "shop_nick",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "模板中新增的店铺名称列(非必填),用于标识订单所属店铺"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "order.pendingOrder.manualWaybill",
|
||
"title": "手工录入运单号。为指定待处理订单创建一条运单记录(wms_order_express 表),仅允许 step 在 [1,2,3] 且 outbound_status 不为 'padding' 的订单操作。完成后自动更新订单表的 print_status 与 post_status 为 'fin',表示外部已打印。",
|
||
"description": "手工录入运单号。为指定待处理订单创建一条运单记录(wms_order_express 表),仅允许 step 在 [1,2,3] 且 outbound_status 不为 'padding' 的订单操作。完成后自动更新订单表的 print_status 与 post_status 为 'fin',表示外部已打印。",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "订单 ID,必须为正整数"
|
||
},
|
||
{
|
||
"name": "waybill_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "运单号,非空字符串"
|
||
},
|
||
{
|
||
"name": "logistics_interface_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "物流接口名称(选填),手工填入的值,trim 后为空则传 null"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "创建的运单记录 ID"
|
||
},
|
||
{
|
||
"name": "order_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "订单 ID"
|
||
},
|
||
{
|
||
"name": "waybill_code",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "运单号"
|
||
},
|
||
{
|
||
"name": "business_key",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "递增的业务键,同一订单下从 1 开始递增"
|
||
},
|
||
{
|
||
"name": "logistics_interface_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "写入的物流接口名称,未传时为 null"
|
||
},
|
||
{
|
||
"name": "create_at",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "创建时间"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|