95 lines
5.5 KiB
YAML
95 lines
5.5 KiB
YAML
openapi: 3.0.3
|
||
info:
|
||
title: 货物废弃全部筛选数量统计
|
||
version: 1.1.0
|
||
paths:
|
||
/api/platform/v1/last-leg/cargo-discards/statistics:
|
||
get:
|
||
summary: 按平台允许的客户范围汇总全部筛选结果
|
||
description: 与废弃列表共用筛选条件，page和size不限制统计范围。未记录的实际数量、商品件数或托盘事实返回null。实际数取PDA确认事实，不从申请数或状态推算。
|
||
parameters:
|
||
- {name: customerId, in: query, schema: {type: string}}
|
||
- {$ref: '#/components/parameters/DiscardNo'}
|
||
- {$ref: '#/components/parameters/InboundCode'}
|
||
- {$ref: '#/components/parameters/Warehouse'}
|
||
- {$ref: '#/components/parameters/Status'}
|
||
- {$ref: '#/components/parameters/CreatedFrom'}
|
||
- {$ref: '#/components/parameters/CreatedTo'}
|
||
- {$ref: '#/components/parameters/CompletedFrom'}
|
||
- {$ref: '#/components/parameters/CompletedTo'}
|
||
- {$ref: '#/components/parameters/Page'}
|
||
- {$ref: '#/components/parameters/Size'}
|
||
responses:
|
||
'200':
|
||
description: 标准ApiResponse，data为全部筛选数量统计
|
||
content:
|
||
application/json:
|
||
schema: {$ref: '#/components/schemas/Envelope'}
|
||
/api/merchant/v1/last-leg/cargo-discards/statistics:
|
||
get:
|
||
summary: 按当前认证客户汇总全部筛选结果
|
||
description: 需要merchant:overseas-warehouse:discard:list权限；客户归属只取认证身份。完成时间筛选同时适用于列表。
|
||
parameters:
|
||
- {$ref: '#/components/parameters/DiscardNo'}
|
||
- {$ref: '#/components/parameters/InboundCode'}
|
||
- {$ref: '#/components/parameters/Warehouse'}
|
||
- {$ref: '#/components/parameters/Status'}
|
||
- {$ref: '#/components/parameters/CreatedFrom'}
|
||
- {$ref: '#/components/parameters/CreatedTo'}
|
||
- {$ref: '#/components/parameters/CompletedFrom'}
|
||
- {$ref: '#/components/parameters/CompletedTo'}
|
||
- {$ref: '#/components/parameters/Page'}
|
||
- {$ref: '#/components/parameters/Size'}
|
||
responses:
|
||
'200':
|
||
description: 标准ApiResponse，data为当前客户全部筛选统计
|
||
content:
|
||
application/json:
|
||
schema: {$ref: '#/components/schemas/Envelope'}
|
||
components:
|
||
parameters:
|
||
DiscardNo: {name: discardNo, in: query, schema: {type: string}}
|
||
InboundCode: {name: inboundCode, in: query, schema: {type: string}}
|
||
Warehouse: {name: overseasWarehouseId, in: query, schema: {type: string}}
|
||
Status: {name: status, in: query, schema: {type: string}}
|
||
CreatedFrom: {name: createdFrom, in: query, schema: {type: string, format: date-time}}
|
||
CreatedTo: {name: createdTo, in: query, schema: {type: string, format: date-time}}
|
||
CompletedFrom: {name: completedFrom, in: query, description: 客户确认完成时间下界，包含边界, schema: {type: string, format: date-time}}
|
||
CompletedTo: {name: completedTo, in: query, description: 客户确认完成时间上界，包含边界, schema: {type: string, format: date-time}}
|
||
Page: {name: page, in: query, required: true, schema: {type: integer, minimum: 1}}
|
||
Size: {name: size, in: query, required: true, schema: {type: integer, minimum: 1, maximum: 200}}
|
||
schemas:
|
||
SummaryDimensions:
|
||
type: object
|
||
description: 平台及客户废弃列表records与详情summary均返回这些维度；totalPackages保留作业阶段展示箱数，申请箱数须读取requestedPackages。
|
||
required: [skuCodes, skuCount, requestedPackages, actualPackages]
|
||
properties:
|
||
skuCodes: {type: array, items: {type: string}, description: 申请明细去重并排序后的全部SKU}
|
||
skuCount: {type: integer, description: 本单SKU种数}
|
||
requestedPackages: {type: integer, description: 申请物理箱数，同一混装箱跨SKU仅计一次}
|
||
actualPackages: {type: integer, nullable: true, description: PDA已确认实际物理箱数，未作业为null}
|
||
CandidateSku:
|
||
type: object
|
||
description: 库存仓位按物理箱计量，箱内全部SKU从真实实收JSON投影；完整混箱必须携带全部SKU明细，库存冻结和扣减按仓位及箱身份去重。
|
||
properties:
|
||
skuCode: {type: string}
|
||
productName: {type: string, nullable: true}
|
||
availablePackages: {type: string, description: 包含本SKU的可选物理箱数}
|
||
availablePieces: {type: string, nullable: true, description: 真实箱内本SKU件数，缺失时null，不按箱规推算}
|
||
Envelope:
|
||
type: object
|
||
properties:
|
||
code: {type: string}
|
||
data: {$ref: '#/components/schemas/Statistics'}
|
||
Statistics:
|
||
type: object
|
||
description: Long值遵循全局序列化配置，可能以十进制字符串返回；退货SKU按件汇总并按实物箱去重，转运件数只取所选箱实点SKU事实，其他缺失事实保留null。
|
||
properties:
|
||
orderCount: {type: string, description: 筛选订单票数}
|
||
skuCount: {type: integer, description: 筛选内去重SKU种数}
|
||
requestedPackages: {type: string, description: 申请物理箱数}
|
||
actualPackages: {type: string, nullable: true, description: 已确认实际物理箱数}
|
||
requestedPieces: {type: string, nullable: true, description: 申请商品件数}
|
||
actualPieces: {type: string, nullable: true, description: 已确认实际商品件数}
|
||
palletCount: {type: integer, nullable: true, description: 客户和仓范围内去重真实来源托盘数，缺失或散箱返回null}
|