748 lines
19 KiB
JSON
748 lines
19 KiB
JSON
{
|
||
"generatedAt": "2026-04-25 09:24:55",
|
||
"generatedAtLocal": "2026-04-25 09:24:55",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "收货单模块",
|
||
"key": "storage_receiving",
|
||
"folder": "storage_receiving",
|
||
"interfaceCount": 15
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": false,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [],
|
||
"deletedMethods": [],
|
||
"paramsUpdatedMethods": [],
|
||
"responseUpdatedMethods": []
|
||
}
|
||
}
|
||
},
|
||
"interfaces": [
|
||
{
|
||
"method": "storage.receiving.getReceivingList",
|
||
"title": "storage.receiving.getReceivingList 接口",
|
||
"description": "storage.receiving.getReceivingList 接口",
|
||
"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": "where",
|
||
"type": "object",
|
||
"required": false,
|
||
"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)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.receiving.getReceivingDetail",
|
||
"title": "storage.receiving.getReceivingDetail 接口",
|
||
"description": "storage.receiving.getReceivingDetail 接口",
|
||
"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": "pagination",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "明细分页参数,支持 page/pageSize"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "receiving",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "收货单详情(含 details、images、pagination)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.receiving.batchCancelReceiving",
|
||
"title": "storage.receiving.batchCancelReceiving 接口",
|
||
"description": "storage.receiving.batchCancelReceiving 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "ids",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "待作废收货单ID数组"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "message",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "批量作废处理结果"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.receiving.create",
|
||
"title": "storage.receiving.create 接口",
|
||
"description": "storage.receiving.create 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "delivery_method",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "到货方式:truck/express/air_freight/sea_freight/other"
|
||
},
|
||
{
|
||
"name": "loading_method",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "装卸方式:with_pallet/without_pallet"
|
||
},
|
||
{
|
||
"name": "license_plate",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "车牌号(delivery_method=truck 时建议传)"
|
||
},
|
||
{
|
||
"name": "tracking_number",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "物流单号(非 truck/other 场景建议传)"
|
||
},
|
||
{
|
||
"name": "store_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "货主ID"
|
||
},
|
||
{
|
||
"name": "total_boxes",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "总箱数"
|
||
},
|
||
{
|
||
"name": "total_pallets",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "总托盘数"
|
||
},
|
||
{
|
||
"name": "remark",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "备注"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "新建收货单ID"
|
||
},
|
||
{
|
||
"name": "receiving_number",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "收货单号"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.receiving.bindStore",
|
||
"title": "收货单绑定货主",
|
||
"description": "收货单绑定货主",
|
||
"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": "store_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "货主ID(必须与当前仓库存在有效签约关系)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "data.id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货单ID"
|
||
},
|
||
{
|
||
"name": "data.store_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "已绑定的货主ID"
|
||
},
|
||
{
|
||
"name": "data.store_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "货主名称/签约备注名"
|
||
},
|
||
{
|
||
"name": "data.status",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "当前收货单状态"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.receiving.bindDetailProduct",
|
||
"title": "收货单明细绑定或改绑系统商品",
|
||
"description": "收货单明细绑定或改绑系统商品",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [
|
||
{
|
||
"name": "detail_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货单明细ID(兼容字段 `id`)"
|
||
},
|
||
{
|
||
"name": "system_product_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "系统商品ID(`StockWarehouse.id`,且必须属于当前仓库)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "data.detail_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货单明细ID"
|
||
},
|
||
{
|
||
"name": "data.receiving_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货单ID"
|
||
},
|
||
{
|
||
"name": "data.system_product_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "已绑定的系统商品ID"
|
||
},
|
||
{
|
||
"name": "data.product_name",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "自动回填的商品名称"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.receiving.addItem",
|
||
"title": "storage.receiving.addItem 接口",
|
||
"description": "storage.receiving.addItem 接口",
|
||
"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 参数"
|
||
},
|
||
{
|
||
"name": "item",
|
||
"type": "object",
|
||
"required": false,
|
||
"description": "item 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.removeItem",
|
||
"title": "storage.receiving.removeItem 接口",
|
||
"description": "storage.receiving.removeItem 接口",
|
||
"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 参数"
|
||
},
|
||
{
|
||
"name": "item_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "item_id 参数"
|
||
}
|
||
],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.saveReceiving",
|
||
"title": "storage.receiving.saveReceiving 接口",
|
||
"description": "storage.receiving.saveReceiving 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": true,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.get",
|
||
"title": "storage.receiving.get 接口",
|
||
"description": "storage.receiving.get 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.addDetail",
|
||
"title": "storage.receiving.addDetail 接口",
|
||
"description": "storage.receiving.addDetail 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.deleteDetail",
|
||
"title": "storage.receiving.deleteDetail 接口",
|
||
"description": "storage.receiving.deleteDetail 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.detailChange",
|
||
"title": "修改收货单明细(数量/箱规/批次/商品信息回写等)",
|
||
"description": "修改收货单明细(数量/箱规/批次/商品信息回写等)",
|
||
"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": "receiving_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货单ID"
|
||
},
|
||
{
|
||
"name": "actual_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实际收货数量"
|
||
},
|
||
{
|
||
"name": "batch_number",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "批次号"
|
||
},
|
||
{
|
||
"name": "production_date",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "生产日期(可解析的日期字符串)"
|
||
},
|
||
{
|
||
"name": "expiry_date",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "到期日期(可解析的日期字符串)。若早于当前日期,接口会返回 400 并拒绝录入。"
|
||
},
|
||
{
|
||
"name": "box_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "箱数"
|
||
},
|
||
{
|
||
"name": "boxes_per_pallet",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "每托盘箱数"
|
||
},
|
||
{
|
||
"name": "pallet_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "托盘数"
|
||
},
|
||
{
|
||
"name": "space_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "库位 ID(可回写)"
|
||
},
|
||
{
|
||
"name": "remark",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "备注"
|
||
},
|
||
{
|
||
"name": "system_product_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "系统商品 ID(StockWarehouse.id)。若提供,服务端会尝试回填 barcode/weight/箱规/product_name/product_snapshot 等。"
|
||
},
|
||
{
|
||
"name": "barcode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "条码(未传 system_product_id 时可单独更新)"
|
||
},
|
||
{
|
||
"name": "product_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "商品名称(未传 system_product_id 时可单独更新)"
|
||
},
|
||
{
|
||
"name": "box_width",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "箱宽"
|
||
},
|
||
{
|
||
"name": "box_height",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "箱高"
|
||
},
|
||
{
|
||
"name": "box_length",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "箱长"
|
||
},
|
||
{
|
||
"name": "weight",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "毛重/重量"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "data.id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货明细 ID"
|
||
},
|
||
{
|
||
"name": "data.receiving_id",
|
||
"type": "number",
|
||
"required": true,
|
||
"description": "收货单 ID"
|
||
},
|
||
{
|
||
"name": "data.actual_quantity",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "实际收货数量"
|
||
},
|
||
{
|
||
"name": "data.product_name",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "商品名称"
|
||
},
|
||
{
|
||
"name": "data.barcode",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "条码"
|
||
},
|
||
{
|
||
"name": "data.system_product_id",
|
||
"type": "number",
|
||
"required": false,
|
||
"description": "系统商品 ID"
|
||
},
|
||
{
|
||
"name": "data.updated_at",
|
||
"type": "string",
|
||
"required": false,
|
||
"description": "记录更新时间(ISO)"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"method": "storage.receiving.cancel",
|
||
"title": "storage.receiving.cancel 接口",
|
||
"description": "storage.receiving.cancel 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
},
|
||
{
|
||
"method": "storage.receiving.completeReceiving",
|
||
"title": "storage.receiving.completeReceiving 接口",
|
||
"description": "storage.receiving.completeReceiving 接口",
|
||
"endpoint": "/system",
|
||
"authRequired": false,
|
||
"loginRequired": true,
|
||
"status": {
|
||
"isUsed": false,
|
||
"isPlaceholder": false
|
||
},
|
||
"headers": [
|
||
{
|
||
"name": "Authorization",
|
||
"type": "string",
|
||
"required": true,
|
||
"description": "Bearer token"
|
||
}
|
||
],
|
||
"params": [],
|
||
"response": []
|
||
}
|
||
]
|
||
}
|