580 lines
35 KiB
YAML
580 lines
35 KiB
YAML
openapi: 3.0.3
|
||
info:
|
||
title: Lastleg Overseas Business API
|
||
version: 1.0.0
|
||
paths:
|
||
/api/platform/v1/last-leg/orders:
|
||
get:
|
||
summary: 分页查询尾程订单
|
||
description: 权限 platform:overseas-warehouse:order:list；平台管理员省略 customerId 时查询全部客户。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: page, in: query, schema: { type: integer, minimum: 1, default: 1 } }
|
||
- { name: size, in: query, schema: { type: integer, minimum: 1, maximum: 200, default: 20 } }
|
||
- { name: orderNo, in: query, schema: { type: string } }
|
||
- { name: orderType, in: query, schema: { type: string, enum: [FIRST_LEG, RELABEL_APPLICATION, WAREHOUSE_TRANSFER, LOCAL_LOOSEBOARD, RETURN_RELABEL, ONE_CLICK_DROPSHIP] } }
|
||
- { name: currentStatus, in: query, schema: { type: string } }
|
||
- { name: inboundCode, in: query, schema: { type: string } }
|
||
- { name: sourceOrderNo, in: query, schema: { type: string } }
|
||
- { name: containerNo, in: query, schema: { type: string } }
|
||
- { name: warehouse, in: query, schema: { type: string } }
|
||
- { name: transferWarehouseCode, in: query, schema: { type: string } }
|
||
- { name: abnormal, in: query, schema: { type: boolean } }
|
||
- { name: detained, in: query, schema: { type: boolean } }
|
||
- { name: createdFrom, in: query, schema: { type: string, format: date-time } }
|
||
- { name: createdTo, in: query, schema: { type: string, format: date-time } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的尾程订单分页 } }
|
||
/api/platform/v1/last-leg/dispatches:
|
||
get:
|
||
summary: 分页查询排车单
|
||
description: 权限 platform:overseas-warehouse:inbound-order:list；平台跨客户分页查询，前端不传 customerId。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: page, in: query, schema: { type: integer, minimum: 1, default: 1 } }
|
||
- { name: size, in: query, schema: { type: integer, minimum: 1, maximum: 200, default: 20 } }
|
||
- { name: dispatchNo, in: query, schema: { type: string } }
|
||
- { name: vehiclePlate, in: query, schema: { type: string } }
|
||
- { name: status, in: query, schema: { type: string } }
|
||
- { name: fbaAppointmentNo, in: query, schema: { type: string } }
|
||
responses:
|
||
'200': { description: 统一 ApiResponse 包装的排车单分页，records 元素为 DispatchResponse }
|
||
/api/platform/v1/last-leg/dispatches/{dispatchNo}:
|
||
get:
|
||
summary: 查询排车单详情
|
||
description: 权限 platform:overseas-warehouse:inbound-order:list；平台按全局排车单号定位记录，并使用记录自身客户范围查询明细，前端不传 customerId。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: dispatchNo, in: path, required: true, schema: { type: string } }
|
||
responses:
|
||
'200': { description: 统一 ApiResponse 包装的 DispatchResponse }
|
||
'404': { description: 排车单不存在 }
|
||
'409': { description: 排车单号在不同客户下重复，无法唯一定位 }
|
||
/api/platform/v1/last-leg/dispatches/candidates:
|
||
get:
|
||
summary: 查询智能排车候选托盘
|
||
description: 权限 platform:overseas-warehouse:inbound-order:list；planIds 为空时平台跨客户查询全部可排托盘，传入时按所选入库计划解析客户范围；仅返回尚未被有效排车锁定的计划或已实收托盘，前端不传 customerId。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- name: planIds
|
||
in: query
|
||
required: false
|
||
description: 可选的入库计划 ID，逗号分隔；省略时平台查询全部客户候选。
|
||
schema: { type: array, minItems: 1, maxItems: 500, items: { type: integer, format: int64 } }
|
||
style: form
|
||
explode: false
|
||
- { name: orderNo, in: query, schema: { type: string } }
|
||
- { name: fbaWarehouseCode, in: query, schema: { type: string } }
|
||
- { name: sourceStage, in: query, schema: { type: string, enum: [PLAN, RECEIVED] } }
|
||
responses:
|
||
'200':
|
||
description: 统一 ApiResponse 包装的候选托盘数组
|
||
content: { application/json: { schema: { type: array, items: { $ref: '#/components/schemas/SmartDispatchCandidate' } } } }
|
||
/api/platform/v1/last-leg/dispatches/pre-arrange:
|
||
post:
|
||
summary: 创建智能预排车单
|
||
description: 权限 platform:overseas-warehouse:inbound-order:smart-dispatch；服务端根据所选托盘解析并校验唯一客户范围，锁定同一海外仓的托盘并创建 PENDING_DEPARTURE 排车单，前端不传 customerId；不开放编辑、取消、depart、PDA 出库或派送。
|
||
security: [{ bearerAuth: [] }]
|
||
requestBody:
|
||
required: true
|
||
content: { application/json: { schema: { $ref: '#/components/schemas/SmartDispatchPreArrange' } } }
|
||
responses:
|
||
'200': { description: 统一 ApiResponse 包装的预排车详情, content: { application/json: { schema: { $ref: '#/components/schemas/DispatchResponse' } } } }
|
||
/api/platform/v1/last-leg/dispatches/draft-locks/lock:
|
||
post:
|
||
summary: 将托盘移入智能排车草稿并立即锁定
|
||
description: 权限 platform:overseas-warehouse:inbound-order:smart-dispatch；草稿锁 30 分钟失效，与正式排车锁共享托盘排他约束。
|
||
security: [{ bearerAuth: [] }]
|
||
requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/SmartDispatchDraftPallet' } } } }
|
||
responses: { '200': { description: 锁定成功 }, '409': { description: 托盘已被其他草稿或正式排车锁定 } }
|
||
/api/platform/v1/last-leg/dispatches/draft-locks/unlock:
|
||
post:
|
||
summary: 从智能排车草稿移除托盘并立即解锁
|
||
security: [{ bearerAuth: [] }]
|
||
requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/SmartDispatchDraftPallet' } } } }
|
||
responses: { '200': { description: 解锁成功 }, '409': { description: 草稿锁不属于当前操作人 } }
|
||
/api/platform/v1/last-leg/dispatches/draft-locks/release:
|
||
post:
|
||
summary: 关闭智能排车草稿并释放草稿内全部托盘
|
||
security: [{ bearerAuth: [] }]
|
||
requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/SmartDispatchDraftRelease' } } } }
|
||
responses: { '200': { description: 草稿锁已全部释放 } }
|
||
/api/platform/v1/last-leg/overseas-procurements:
|
||
get:
|
||
summary: 分页查询海外采购订单
|
||
description: 权限 platform:overseas-business:purchase:list；customerId 为空时查询全部客户。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: customerId, in: query, schema: { type: string } }
|
||
- { name: page, in: query, required: true, schema: { type: integer, minimum: 1 } }
|
||
- { name: size, in: query, required: true, schema: { type: integer, minimum: 1, maximum: 200 } }
|
||
- { name: orderNo, in: query, schema: { type: string } }
|
||
- { name: customerKeyword, in: query, schema: { type: string } }
|
||
- { name: purchaseCategory, in: query, schema: { type: string } }
|
||
- { name: productName, in: query, schema: { type: string } }
|
||
- { name: status, in: query, schema: { $ref: '#/components/schemas/ProcurementStatus' } }
|
||
- { name: purchaseWarehouseId, in: query, schema: { type: string } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的采购订单分页 } }
|
||
/api/platform/v1/last-leg/overseas-procurements/customer-options:
|
||
get:
|
||
summary: 查询已有采购订单的客户候选
|
||
description: 权限 platform:overseas-business:purchase:list；候选来自尾程库采购订单客户快照，不跨库查询 IAM。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: keyword, in: query, schema: { type: string } }
|
||
- { name: limit, in: query, schema: { type: integer, minimum: 1, maximum: 200, default: 50 } }
|
||
responses:
|
||
'200':
|
||
description: 客户候选
|
||
content: { application/json: { schema: { $ref: '#/components/schemas/CustomerOptionResponse' } } }
|
||
/api/platform/v1/last-leg/overseas-procurements/warehouse-options:
|
||
get:
|
||
summary: 查询启用的海外合作采购仓候选
|
||
description: 权限 platform:overseas-business:purchase:list；复用服务端缓存目录，浏览器不访问国内内部 API。
|
||
security: [{ bearerAuth: [] }]
|
||
responses:
|
||
'200':
|
||
description: 采购仓候选
|
||
content: { application/json: { schema: { $ref: '#/components/schemas/WarehouseOptionResponse' } } }
|
||
/api/platform/v1/last-leg/overseas-procurements/{orderNo}:
|
||
parameters:
|
||
- { name: orderNo, in: path, required: true, schema: { type: string } }
|
||
- { name: customerId, in: query, required: true, schema: { type: string, pattern: '^[1-9][0-9]*$' } }
|
||
get:
|
||
summary: 查询海外采购订单详情及操作流水
|
||
description: 权限 platform:overseas-business:purchase:list。
|
||
security: [{ bearerAuth: [] }]
|
||
responses: { '200': { description: 统一 ApiResponse 包装的采购订单详情 } }
|
||
patch:
|
||
summary: 编辑海外采购订单
|
||
description: 权限 platform:overseas-business:purchase:edit；可选字段缺失表示不修改，显式 null 或空串表示清空。采购仓名称由 warehouse ID 对应候选快照决定。采购出库不属于本 API。
|
||
security: [{ bearerAuth: [] }]
|
||
requestBody:
|
||
required: true
|
||
content: { application/json: { schema: { $ref: '#/components/schemas/ProcurementUpdate' } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的采购订单详情 }, '409': { description: 乐观锁冲突或状态不允许 } }
|
||
/api/platform/v1/last-leg/overseas-procurements/{orderNo}/review:
|
||
post:
|
||
summary: 审核海外采购订单
|
||
description: 权限 platform:overseas-business:purchase:review。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: orderNo, in: path, required: true, schema: { type: string } }
|
||
- { name: customerId, in: query, required: true, schema: { type: string, pattern: '^[1-9][0-9]*$' } }
|
||
requestBody:
|
||
required: true
|
||
content: { application/json: { schema: { type: object, required: [decision], properties: { decision: { type: string, enum: [APPROVE, REJECT] }, remark: { type: string, nullable: true, maxLength: 1000 } } } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的采购订单详情 } }
|
||
/api/merchant/v1/last-leg/overseas-procurements:
|
||
post:
|
||
summary: 客户创建海外采购订单
|
||
description: 客户 ID 只取认证身份；新单固定进入 PENDING_REVIEW。
|
||
security: [{ bearerAuth: [] }]
|
||
requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/ProcurementCreate' } } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的采购订单详情 } }
|
||
get:
|
||
summary: 客户分页查询自己的海外采购订单
|
||
security: [{ bearerAuth: [] }]
|
||
responses: { '200': { description: 统一 ApiResponse 包装的采购订单分页 } }
|
||
/api/merchant/v1/last-leg/overseas-procurements/{orderNo}:
|
||
get:
|
||
summary: 客户查询自己的海外采购订单详情及流水
|
||
security: [{ bearerAuth: [] }]
|
||
parameters: [{ name: orderNo, in: path, required: true, schema: { type: string } }]
|
||
responses: { '200': { description: 统一 ApiResponse 包装的采购订单详情 } }
|
||
/api/platform/v1/last-leg/us-truck-orders:
|
||
get:
|
||
summary: 分页查询本土卡车订单
|
||
description: 权限 platform:overseas-business:truck:list。
|
||
security: [{ bearerAuth: [] }]
|
||
responses: { '200': { description: 统一 ApiResponse 包装的卡车订单分页 } }
|
||
post:
|
||
summary: 平台为指定客户创建本土卡车订单
|
||
description: 权限 platform:overseas-business:truck:create；customerId 必填且只作为可信服务端隔离键。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters: [{ name: customerId, in: query, required: true, schema: { type: string, pattern: '^[1-9][0-9]*$' } }]
|
||
requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/TruckCreate' } } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的卡车订单详情 } }
|
||
/api/platform/v1/last-leg/us-truck-orders/{orderNo}:
|
||
parameters:
|
||
- { name: orderNo, in: path, required: true, schema: { type: string } }
|
||
- { name: customerId, in: query, required: true, schema: { type: string, pattern: '^[1-9][0-9]*$' } }
|
||
get:
|
||
summary: 查询本土卡车订单详情
|
||
description: 权限 platform:overseas-business:truck:list。
|
||
security: [{ bearerAuth: [] }]
|
||
responses: { '200': { description: 统一 ApiResponse 包装的卡车订单详情 } }
|
||
patch:
|
||
summary: 平台普通编辑本土卡车订单
|
||
description: 权限 platform:overseas-business:truck:edit；仅待审核订单可编辑，不能修改状态。
|
||
security: [{ bearerAuth: [] }]
|
||
requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/TruckUpdate' } } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的卡车订单详情 } }
|
||
/api/platform/v1/last-leg/us-truck-orders/{orderNo}/status:
|
||
patch:
|
||
summary: 推进本土卡车订单状态
|
||
description: 权限 platform:overseas-business:truck:status；普通编辑接口不能修改状态。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: orderNo, in: path, required: true, schema: { type: string } }
|
||
- { name: customerId, in: query, required: true, schema: { type: string, pattern: '^[1-9][0-9]*$' } }
|
||
requestBody: { required: true, content: { application/json: { schema: { type: object, required: [version, status], properties: { version: { type: integer, format: int64, minimum: 0 }, status: { $ref: '#/components/schemas/TruckStatus' }, remark: { type: string, nullable: true, maxLength: 1000 } } } } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的卡车订单详情 }, '409': { description: 非法状态迁移 } }
|
||
/api/platform/v1/last-leg/us-truck-orders/{orderNo}/receive-pallets:
|
||
post:
|
||
summary: 记录本土卡车订单实收托盘
|
||
description: 权限 platform:overseas-business:truck:status；幂等记录实收，不创建海外仓出库或派送单。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: orderNo, in: path, required: true, schema: { type: string } }
|
||
- { name: customerId, in: query, required: true, schema: { type: string, pattern: '^[1-9][0-9]*$' } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的卡车订单详情 } }
|
||
/api/platform/v1/last-leg/local-looseboard-orders:
|
||
get:
|
||
summary: 分页查询本土散板订单
|
||
description: 权限 platform:overseas-business:looseboard:list。
|
||
security: [{ bearerAuth: [] }]
|
||
responses: { '200': { description: 统一 ApiResponse 包装的散板订单分页 } }
|
||
post:
|
||
summary: 创建本土散板订单
|
||
description: 权限 platform:overseas-business:looseboard:create；独立稳定子域，不复用卡车端点。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters: [{ name: customerId, in: query, required: true, schema: { type: string, pattern: '^[1-9][0-9]*$' } }]
|
||
requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/LooseboardCreate' } } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的散板订单详情 } }
|
||
/api/platform/v1/last-leg/local-looseboard-orders/{orderNo}:
|
||
parameters:
|
||
- { name: orderNo, in: path, required: true, schema: { type: string } }
|
||
- { name: customerId, in: query, required: true, schema: { type: string, pattern: '^[1-9][0-9]*$' } }
|
||
get:
|
||
summary: 查询本土散板订单详情及操作流水
|
||
description: 权限 platform:overseas-business:looseboard:list。
|
||
security: [{ bearerAuth: [] }]
|
||
responses: { '200': { description: 统一 ApiResponse 包装的散板订单详情 } }
|
||
put:
|
||
summary: 全量更新待接单的本土散板订单
|
||
description: 权限 platform:overseas-business:looseboard:edit；可空字段传 null 或空串即清空；状态由独立端点推进。
|
||
security: [{ bearerAuth: [] }]
|
||
requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/LooseboardUpdate' } } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的散板订单详情 }, '409': { description: 版本或状态冲突 } }
|
||
/api/platform/v1/last-leg/local-looseboard-orders/{orderNo}/status:
|
||
patch:
|
||
summary: 推进或取消本土散板订单
|
||
description: 权限 platform:overseas-business:looseboard:status；只允许 PENDING_ACCEPTANCE→DISPATCHED→IN_TRANSIT→COMPLETED，未完成节点按规则取消。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: orderNo, in: path, required: true, schema: { type: string } }
|
||
- { name: customerId, in: query, required: true, schema: { type: string, pattern: '^[1-9][0-9]*$' } }
|
||
requestBody: { required: true, content: { application/json: { schema: { type: object, required: [version, status], properties: { version: { type: integer, format: int64, minimum: 0 }, status: { $ref: '#/components/schemas/LooseboardStatus' }, remark: { type: string, nullable: true, maxLength: 1000 } } } } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的散板订单详情 }, '409': { description: 非法状态迁移 } }
|
||
/api/platform/v1/last-leg/relabel-applications:
|
||
get:
|
||
summary: 分页查询海外换标单
|
||
description: 权限 platform:overseas-warehouse:relabel-order:list；平台查询全部换标单，不接收 customerId。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: page, in: query, schema: { type: integer, minimum: 1, default: 1 } }
|
||
- { name: size, in: query, schema: { type: integer, minimum: 1, maximum: 200, default: 20 } }
|
||
- { name: relabelNo, in: query, schema: { type: string, maxLength: 64 } }
|
||
- { name: customerOrderNo, in: query, schema: { type: string, maxLength: 128 } }
|
||
- { name: skuCode, in: query, schema: { type: string, maxLength: 128 } }
|
||
- { name: status, in: query, schema: { $ref: '#/components/schemas/RelabelStatus' } }
|
||
- { name: overseasWarehouseId, in: query, schema: { type: string, maxLength: 128 } }
|
||
- { name: createdFrom, in: query, schema: { type: string, format: date-time } }
|
||
- { name: createdTo, in: query, schema: { type: string, format: date-time } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的换标单分页 } }
|
||
post:
|
||
summary: 创建海外换标单
|
||
description: 权限 platform:overseas-warehouse:relabel-order:create；明细与换标文件按请求快照保存，使用 idempotencyKey 幂等。
|
||
security: [{ bearerAuth: [] }]
|
||
requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/RelabelCreate' } } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的换标单详情 }, '409': { description: 幂等键冲突 } }
|
||
/api/platform/v1/last-leg/relabel-applications/{relabelNo}:
|
||
get:
|
||
summary: 查询海外换标单详情
|
||
description: 权限 platform:overseas-warehouse:relabel-order:list。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: relabelNo, in: path, required: true, schema: { type: string, maxLength: 64 } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的换标单详情 }, '404': { description: 换标单不存在或不属于当前客户 } }
|
||
/api/platform/v1/last-leg/relabel-applications/{relabelNo}/status:
|
||
put:
|
||
summary: 变更海外换标单状态
|
||
description: 权限 platform:overseas-warehouse:relabel-order:status；状态按 PENDING_PROCESSING→PROCESSING→COMPLETED/REJECTED/CANCELLED 流转。
|
||
security: [{ bearerAuth: [] }]
|
||
parameters:
|
||
- { name: relabelNo, in: path, required: true, schema: { type: string, maxLength: 64 } }
|
||
requestBody: { required: true, content: { application/json: { schema: { $ref: '#/components/schemas/RelabelStatusChange' } } } }
|
||
responses: { '200': { description: 统一 ApiResponse 包装的换标单详情 }, '409': { description: 非法状态迁移或关联尾程单缺失 } }
|
||
components:
|
||
schemas:
|
||
SmartDispatchCandidate:
|
||
type: object
|
||
properties:
|
||
planId: { type: string }
|
||
planPalletId: { type: string }
|
||
warehousePalletId: { type: string, nullable: true }
|
||
orderId: { type: string }
|
||
customerId: { type: string }
|
||
customerName: { type: string, nullable: true }
|
||
planNo: { type: string, nullable: true }
|
||
orderType: { type: string, nullable: true }
|
||
volumeWeightKg: { type: number, nullable: true }
|
||
containerNo: { type: string, nullable: true }
|
||
appointmentAt: { type: string, format: date-time, nullable: true }
|
||
expectedLoadingAt: { type: string, format: date-time, nullable: true }
|
||
overseasWarehouseId: { type: string }
|
||
overseasWarehouseName: { type: string }
|
||
orderNo: { type: string }
|
||
orderRefs: { type: string }
|
||
inboundCode: { type: string }
|
||
palletNo: { type: string }
|
||
destinationWarehouseId: { type: string }
|
||
destinationWarehouseCode: { type: string }
|
||
destinationWarehouseName: { type: string }
|
||
fbaWarehouseCode: { type: string }
|
||
packageCount: { type: integer }
|
||
volumeCbm: { type: number }
|
||
sourceStage: { type: string, enum: [PLAN, RECEIVED] }
|
||
cartonMarks: { type: string, nullable: true, description: 该托盘箱号，逗号分隔 }
|
||
SmartDispatchPreArrange:
|
||
type: object
|
||
required: [planPalletIds]
|
||
properties:
|
||
planPalletIds: { type: array, minItems: 1, maxItems: 500, uniqueItems: true, items: { type: string } }
|
||
route: { type: string, nullable: true, maxLength: 255 }
|
||
fbaAppointmentNo: { type: string, nullable: true, maxLength: 64 }
|
||
fbaAppointmentStatus: { type: string, nullable: true, maxLength: 32, default: PENDING }
|
||
vehicleAppointmentStatus: { type: string, nullable: true, maxLength: 32, default: PENDING }
|
||
draftToken: { type: string, nullable: true, maxLength: 64, description: 拖入托盘时使用的智能排车草稿标识 }
|
||
SmartDispatchDraftPallet:
|
||
type: object
|
||
required: [planPalletId, draftToken]
|
||
properties:
|
||
planPalletId: { type: string }
|
||
draftToken: { type: string, minLength: 1, maxLength: 64 }
|
||
SmartDispatchDraftRelease:
|
||
type: object
|
||
required: [draftToken]
|
||
properties:
|
||
draftToken: { type: string, minLength: 1, maxLength: 64 }
|
||
DispatchResponse:
|
||
type: object
|
||
properties:
|
||
id: { type: string }
|
||
dispatchNo: { type: string }
|
||
vehiclePlate: { type: string, nullable: true }
|
||
driverName: { type: string, nullable: true }
|
||
driverPhone: { type: string, nullable: true }
|
||
carrierName: { type: string, nullable: true }
|
||
orderNos: { type: string }
|
||
route: { type: string, nullable: true }
|
||
overseasWarehouseId: { type: string }
|
||
overseasWarehouseName: { type: string }
|
||
departAt: { type: string, format: date-time, nullable: true }
|
||
fbaAppointmentNo: { type: string, nullable: true }
|
||
fbaAppointmentStatus: { type: string }
|
||
vehicleAppointmentStatus: { type: string }
|
||
estimatedArrivalAt: { type: string, format: date-time, nullable: true }
|
||
status: { type: string, description: 预排新建固定为 PENDING_DEPARTURE；查询可返回历史排车状态 }
|
||
itemCount: { type: integer }
|
||
palletCount: { type: integer }
|
||
packageCount: { type: integer }
|
||
pickedPackageCount: { type: integer }
|
||
shippedPackageCount: { type: integer }
|
||
remainingPackageCount: { type: integer }
|
||
partialCompletionReason: { type: string, nullable: true }
|
||
createdAt: { type: string, format: date-time }
|
||
items: { type: array, items: { $ref: '#/components/schemas/DispatchItem' } }
|
||
DispatchItem:
|
||
type: object
|
||
properties:
|
||
id: { type: string }
|
||
planPalletId: { type: string }
|
||
warehousePalletId: { type: string, nullable: true }
|
||
palletNo: { type: string }
|
||
overseasWarehouseId: { type: string }
|
||
overseasWarehouseName: { type: string }
|
||
orderNo: { type: string }
|
||
orderRefs: { type: string }
|
||
inboundCode: { type: string }
|
||
destinationWarehouseCode: { type: string }
|
||
destinationWarehouseName: { type: string }
|
||
fbaWarehouseCode: { type: string }
|
||
packageCount: { type: integer }
|
||
volumeCbm: { type: number }
|
||
sourceStage: { type: string, enum: [PLAN, RECEIVED] }
|
||
RelabelStatus: { type: string, enum: [PENDING_PROCESSING, PROCESSING, COMPLETED, REJECTED, CANCELLED] }
|
||
RelabelCreate:
|
||
type: object
|
||
required: [customerOrderNo, overseasWarehouseId, labelDeadline, contactName, contactPhone, idempotencyKey, items]
|
||
properties:
|
||
customerOrderNo: { type: string, maxLength: 128 }
|
||
overseasWarehouseId: { type: string, maxLength: 128 }
|
||
labelDeadline: { type: string, format: date-time }
|
||
contactName: { type: string, maxLength: 128 }
|
||
contactPhone: { type: string, maxLength: 64 }
|
||
remark: { type: string, nullable: true, maxLength: 1000 }
|
||
idempotencyKey: { type: string, maxLength: 255 }
|
||
items: { type: array, minItems: 1, maxItems: 500, items: { $ref: '#/components/schemas/RelabelItem' } }
|
||
RelabelItem:
|
||
type: object
|
||
required: [skuCode, productNameZh, totalPackageCount, notifiedPackageCount, shipmentNo, newSkuCode]
|
||
properties:
|
||
skuCode: { type: string, maxLength: 128 }
|
||
productImageFileId: { type: string, nullable: true, maxLength: 128 }
|
||
productImageFileName: { type: string, nullable: true, maxLength: 255 }
|
||
productImageUrl: { type: string, nullable: true, maxLength: 1000 }
|
||
productNameZh: { type: string, maxLength: 255 }
|
||
totalPackageCount: { type: integer, minimum: 1 }
|
||
notifiedPackageCount: { type: integer, minimum: 1 }
|
||
shipmentNo: { type: string, maxLength: 128 }
|
||
trackingCode: { type: string, nullable: true, maxLength: 255 }
|
||
newSkuCode: { type: string, maxLength: 128 }
|
||
labelRequirement: { type: string, nullable: true, maxLength: 1000 }
|
||
relabelFileId: { type: string, nullable: true, maxLength: 128 }
|
||
relabelFileName: { type: string, nullable: true, maxLength: 255 }
|
||
relabelFileUrl: { type: string, nullable: true, maxLength: 1000 }
|
||
RelabelStatusChange:
|
||
type: object
|
||
required: [status]
|
||
properties:
|
||
status: { $ref: '#/components/schemas/RelabelStatus' }
|
||
remark: { type: string, nullable: true, maxLength: 1000 }
|
||
ProcurementStatus: { type: string, enum: [PENDING_REVIEW, APPROVED, REJECTED] }
|
||
ProcurementCreate:
|
||
type: object
|
||
required: [purchaseCategory, productName, purchaseQuantity, contactName, contactPhone, idempotencyKey]
|
||
properties:
|
||
customerName: { type: string, nullable: true, maxLength: 255 }
|
||
purchaseCategory: { type: string, maxLength: 128 }
|
||
productName: { type: string, maxLength: 255 }
|
||
productSpecification: { type: string, nullable: true, maxLength: 500 }
|
||
productUrl: { type: string, nullable: true, maxLength: 2000 }
|
||
purchaseQuantity: { type: integer, format: int64, minimum: 1 }
|
||
budgetUnitPrice: { type: number, nullable: true, minimum: 0 }
|
||
currency: { type: string, minLength: 3, maxLength: 3, default: USD }
|
||
receivingAddress: { type: string, nullable: true, maxLength: 1000 }
|
||
contactName: { type: string, maxLength: 128 }
|
||
contactPhone: { type: string, maxLength: 64 }
|
||
remark: { type: string, nullable: true, maxLength: 1000 }
|
||
idempotencyKey: { type: string, maxLength: 255 }
|
||
NullableTextPatch: { type: string, nullable: true, description: 缺失不修改；null 或空串清空 }
|
||
ProcurementUpdate:
|
||
type: object
|
||
required: [version]
|
||
properties:
|
||
version: { type: integer, format: int64, minimum: 0 }
|
||
purchaseCategory: { type: string, maxLength: 128 }
|
||
productName: { type: string, maxLength: 255 }
|
||
productSpecification: { $ref: '#/components/schemas/NullableTextPatch' }
|
||
productUrl: { $ref: '#/components/schemas/NullableTextPatch' }
|
||
inboundQuantity: { type: integer, format: int64, minimum: 0 }
|
||
purchaseWarehouseId: { $ref: '#/components/schemas/NullableTextPatch' }
|
||
purchaseWarehouseName: { $ref: '#/components/schemas/NullableTextPatch' }
|
||
domesticCarrier: { $ref: '#/components/schemas/NullableTextPatch' }
|
||
domesticTrackingNo: { $ref: '#/components/schemas/NullableTextPatch' }
|
||
overseasCarrier: { $ref: '#/components/schemas/NullableTextPatch' }
|
||
overseasTrackingNo: { $ref: '#/components/schemas/NullableTextPatch' }
|
||
estimatedArrivalAt: { type: string, format: date-time, nullable: true, description: 缺失不修改；null 或空串清空 }
|
||
remark: { $ref: '#/components/schemas/NullableTextPatch' }
|
||
CustomerOptionResponse:
|
||
type: object
|
||
properties:
|
||
code: { type: string, enum: ['200'] }
|
||
data: { type: array, items: { type: object, properties: { customerId: { type: string }, customerName: { type: string } } } }
|
||
WarehouseOptionResponse:
|
||
type: object
|
||
properties:
|
||
code: { type: string, enum: ['200'] }
|
||
data: { type: array, items: { type: object, properties: { warehouseId: { type: string }, warehouseCode: { type: string }, warehouseName: { type: string }, countryCode: { type: string } } } }
|
||
TruckStatus: { type: string, enum: [PENDING_REVIEW, WAITING_INBOUND, RECEIVING, WAITING_CONSOLIDATION, PALLET_OVERAGE_REVIEW, PARTIALLY_ALLOCATED, ALLOCATED, PENDING_DISPATCH, DISPATCHED, IN_TRANSIT, COMPLETED, REJECTED, CANCELLED] }
|
||
TruckCreate:
|
||
type: object
|
||
required: [origin, destination, palletCount, totalWeightKg, totalVolumeCbm, contactName, contactInfo, requestedDate, idempotencyKey]
|
||
properties:
|
||
transportType: { type: string, enum: [PORT_PICKUP, WAREHOUSE_TO_WAREHOUSE, WAREHOUSE_TO_DOOR] }
|
||
origin: { type: string, maxLength: 255 }
|
||
originAddress: { type: string, nullable: true, maxLength: 500 }
|
||
destination: { type: string, maxLength: 255 }
|
||
destinationAddress: { type: string, nullable: true, maxLength: 500 }
|
||
containerType: { type: string, nullable: true, maxLength: 32 }
|
||
palletCount: { type: integer, minimum: 1 }
|
||
packageCount: { type: integer, nullable: true, minimum: 0 }
|
||
totalWeightKg: { type: number, minimum: 0 }
|
||
totalVolumeCbm: { type: number, minimum: 0 }
|
||
budgetAmount: { type: number, nullable: true, minimum: 0 }
|
||
currency: { type: string, minLength: 3, maxLength: 3, default: USD }
|
||
contactName: { type: string, maxLength: 128 }
|
||
contactInfo: { type: string, maxLength: 128 }
|
||
requestedDate: { type: string, format: date }
|
||
remark: { type: string, nullable: true, maxLength: 1000 }
|
||
idempotencyKey: { type: string, maxLength: 255 }
|
||
TruckUpdate:
|
||
type: object
|
||
required: [version]
|
||
properties:
|
||
version: { type: integer, format: int64, minimum: 0 }
|
||
transportType: { type: string, enum: [PORT_PICKUP, WAREHOUSE_TO_WAREHOUSE, WAREHOUSE_TO_DOOR] }
|
||
origin: { type: string, maxLength: 255 }
|
||
originAddress: { type: string, nullable: true, maxLength: 500 }
|
||
destination: { type: string, maxLength: 255 }
|
||
destinationAddress: { type: string, nullable: true, maxLength: 500 }
|
||
containerType: { type: string, nullable: true, maxLength: 32 }
|
||
palletCount: { type: integer, minimum: 1 }
|
||
packageCount: { type: integer, minimum: 0 }
|
||
totalWeightKg: { type: number, minimum: 0 }
|
||
totalVolumeCbm: { type: number, minimum: 0 }
|
||
budgetAmount: { type: number, nullable: true, minimum: 0 }
|
||
currency: { type: string, minLength: 3, maxLength: 3 }
|
||
contactName: { type: string, maxLength: 128 }
|
||
contactInfo: { type: string, maxLength: 128 }
|
||
requestedDate: { type: string, format: date }
|
||
remark: { type: string, nullable: true, maxLength: 1000 }
|
||
LooseboardStatus: { type: string, enum: [PENDING_ACCEPTANCE, DISPATCHED, IN_TRANSIT, COMPLETED, CANCELLED] }
|
||
LooseboardCreate:
|
||
type: object
|
||
required: [transportMode, palletRequired, transportType, origin, destination, packageCount, totalWeightKg, totalVolumeCbm, idempotencyKey]
|
||
properties:
|
||
transportMode: { type: string, enum: [SHARED_TRUCK, PRIORITY_CONSOLIDATION] }
|
||
palletRequired: { type: string, enum: [YES, NO] }
|
||
transportType: { type: string, enum: [PORT_PICKUP, WAREHOUSE_TO_WAREHOUSE, WAREHOUSE_TO_DOOR] }
|
||
origin: { type: string, maxLength: 255 }
|
||
originAddress: { type: string, nullable: true, maxLength: 500 }
|
||
destination: { type: string, maxLength: 255 }
|
||
destinationAddress: { type: string, nullable: true, maxLength: 500 }
|
||
containerType: { type: string, nullable: true, maxLength: 32 }
|
||
packageCount: { type: integer, minimum: 0 }
|
||
totalWeightKg: { type: number, minimum: 0 }
|
||
totalVolumeCbm: { type: number, minimum: 0 }
|
||
budgetAmount: { type: number, nullable: true, minimum: 0 }
|
||
currency: { type: string, minLength: 3, maxLength: 3, default: USD }
|
||
contactName: { type: string, nullable: true, maxLength: 128 }
|
||
contactInfo: { type: string, nullable: true, maxLength: 128 }
|
||
requestedDate: { type: string, format: date, nullable: true }
|
||
remark: { type: string, nullable: true, maxLength: 1000 }
|
||
idempotencyKey: { type: string, maxLength: 255 }
|
||
LooseboardUpdate:
|
||
type: object
|
||
required: [version, transportMode, palletRequired, transportType, origin, destination, packageCount, totalWeightKg, totalVolumeCbm]
|
||
properties:
|
||
version: { type: integer, format: int64, minimum: 0 }
|
||
transportMode: { type: string, enum: [SHARED_TRUCK, PRIORITY_CONSOLIDATION] }
|
||
palletRequired: { type: string, enum: [YES, NO] }
|
||
transportType: { type: string, enum: [PORT_PICKUP, WAREHOUSE_TO_WAREHOUSE, WAREHOUSE_TO_DOOR] }
|
||
origin: { type: string, maxLength: 255 }
|
||
originAddress: { type: string, nullable: true, maxLength: 500 }
|
||
destination: { type: string, maxLength: 255 }
|
||
destinationAddress: { type: string, nullable: true, maxLength: 500 }
|
||
containerType: { type: string, nullable: true, maxLength: 32 }
|
||
packageCount: { type: integer, minimum: 0 }
|
||
totalWeightKg: { type: number, minimum: 0 }
|
||
totalVolumeCbm: { type: number, minimum: 0 }
|
||
budgetAmount: { type: number, nullable: true, minimum: 0 }
|
||
currency: { type: string, minLength: 3, maxLength: 3, default: USD }
|
||
contactName: { type: string, nullable: true, maxLength: 128 }
|
||
contactInfo: { type: string, nullable: true, maxLength: 128 }
|
||
requestedDate: { type: string, format: date, nullable: true }
|
||
remark: { type: string, nullable: true, maxLength: 1000 }
|
||
securitySchemes:
|
||
bearerAuth: { type: http, scheme: bearer, bearerFormat: JWT }
|