# 闪送配送 API 契约

## 通用约定

- 用户/骑手端要求请求头 `token`，身份字段不进入请求体。
- 平台权限：`flash:pricing:list/edit`、`flash:order:list/query/cancel/complete`。
- 响应沿用 `AjaxResult`：`{"code":200,"msg":"...","data":...}`；分页 data 为 `records,total,current,size`。
- 金额为整数 TWD；路线距离为米，运价配置距离为公里。
- `serviceType`：`HELP_SEND`、`HELP_PICKUP`。
- `deliveryType`：`NORMAL`、`URGENT`。
- `packageType`：`DOCUMENT`、`GIFT`、`CLOTHING`、`BEAUTY`、`DAILY_NECESSITIES`、`FOOD_INGREDIENTS`、`ELECTRONICS`、`SMALL_APPLIANCE`、`OTHER`。
- 物品信息提交 `packageType`、正整数 `quantity`、必填 `weightRange` 及最长 255 字符的可选 `specification`；`weightRange` 只接受 `UP_TO_5_KG`、`OVER_5_TO_10_KG`、`OVER_10_TO_15_KG`、`OVER_15_TO_20_KG`。
- `deliveryMode`：`NOW`、`SCHEDULED`。预约起止时间使用 ISO 日期时间，时段固定 30 分钟且开始时间不晚于三天后。
- `status`：`WAITING_ACCEPTANCE`、`ACCEPTED`、`PICKED_UP`、`DELIVERED`、`COMPLETED`、`CANCELLED`。

## 地址对象

```json
{"name":"王小明","phone":"0912345678","address":"台北市信义区市府路1号","addressDetail":"3楼A室","longitude":121.5645,"latitude":25.0330,"country":"TW","province":"台北市","city":"台北市","area":"信义区","annexes":""}
```

| 方法 | 路径 | 参数/说明 |
|---|---|---|
| GET | `/system/address/getaddress` | header token；query `keyword?`；仅本人，搜索并置顶优先 |
| GET | `/system/address/getaddressxq` | header token；query `id`；仅本人 |
| POST | `/system/address/address` | header token；body 地址对象，可含 `id`；忽略 userId |
| DELETE | `/system/address/{id}` | header token；仅本人 |
| POST | `/system/address/{id}/top` | header token；仅本人 |

## 用户端

| 方法 | 路径 | 请求/说明 |
|---|---|---|
| GET | `/system/flashDelivery/home` | 返回 `serviceTypes=[HELP_SEND,HELP_PICKUP]`、`deliveryTypes=[NORMAL,URGENT]` 及当前时刻命中的统一运价摘要；不返回内部更新人、时间或地图密钥 |
| POST | `/system/flashDelivery/quote` | `serviceType,deliveryType,deliveryMode,scheduledPickupStartAt?,scheduledPickupEndAt?,packageType,quantity,weightRange,specification?,tipAmount,pickup,delivery`；立即订单按当前时刻、预约订单按预约开始时刻匹配运价 |
| POST | `/system/flashDelivery/orders` | 报价请求字段 + `clientRequestId,pricingId,pricingVersion,quotedBaseDeliveryFee,quotedDistanceFee,quotedUrgentFee,quotedAmount,pinRequired?,senderImageUrls?,userNote?`；服务端复算并逐项校验后幂等创建 |
| GET | `/system/flashDelivery/orders` | `page,size,role?`；`role=sender/receiver`，省略为 `sender`；按创建时间倒序返回当前用户作为寄件人或已绑定收件人的订单摘要 |
| GET | `/system/flashDelivery/orders/{id}` | 订单创建人或创建时已绑定收件人的 App 订单详情；`data` 直接为订单字段，不返回原始状态日志 |
| POST | `/system/flashDelivery/orders/{id}/cancel` | `{"reason":"行程变化"}`；仅订单创建人且状态为待接/已接 |
| POST | `/system/flashDelivery/orders/{id}/confirmReceipt` | 无 body；订单创建人或已绑定收件人可对 DELIVERED 订单确认签收 |

用户列表摘要字段固定为：`id,orderNo,serviceType,deliveryType,status,packageType,quantity,weightRange,deliveryMode,scheduledPickupStartAt,scheduledPickupEndAt,pickupAddress,pickupDetailAddress,deliveryAddress,deliveryDetailAddress,estimatedDurationSeconds,baseDeliveryFee,urgentFee,tipAmount,amount,currency,deliveredAt,createTime`。列表不返回联系人、电话、精确坐标、照片、日志或内部计价审计字段。`receiver` 不是按当前手机号动态查询：订单只在创建时唯一匹配已注册普通用户并固化 `receiverUserId`，未匹配订单以后不追溯认领。

报价响应 data：`serviceType,deliveryType,deliveryMode,scheduledPickupStartAt?,scheduledPickupEndAt?,pricingId,startTime,endTime,distanceMeters,distanceSource,estimatedDurationSeconds?,startingDistance,startingFare,distance,freight,billableDistance,distanceFee,baseDeliveryFee,urgentRate,minimumUrgentFee,urgentFee,tipAmount,amount,currency,pricingVersion`。`billableDistance` 为按外卖规则处理 0.5 公里边界后的计费公里数；全部费用为整数 TWD，`urgentRate` 为百分比。`baseDeliveryFee=startingFare+distanceFee`；普通配送 `urgentFee=0`；加急配送 `urgentFee=max(minimumUrgentFee,roundHalfUp(baseDeliveryFee*urgentRate/100))`；`amount=baseDeliveryFee+urgentFee+tipAmount`。

创建时服务端重新获取路线、按配送方式匹配运价并复算费用。`pricingId`、`pricingVersion`、`quotedBaseDeliveryFee`、`quotedDistanceFee`、`quotedUrgentFee`、`quotedAmount` 任一不一致时不创建订单，返回国际化“报价已变化，请重新确认”及完整最新报价。地址快照字段为联系人、电话、市/区、交付方式、地址、详细地址和经纬度。用户创建和详情响应的 `data` 直接为订单详情字段，照片分别为 `senderImageUrls,pickupImageUrls,deliveryImageUrls`，不返回原始状态日志；`deliveryPinCode` 仅在启用时向订单参与用户返回，用户仅在 `ACCEPTED`、`PICKED_UP` 阶段获得骑手位置。

## 骑手端

所有接口要求 token 用户 `userType=2`。

| 方法 | 路径 | 请求/说明 |
|---|---|---|
| GET | `/system/flashDelivery/rider/orders` | `page,size,tab,longitude?,latitude?`；参数方式与骑手外卖列表一致，`tab=newTask/toPickup/delivering/completed/cancelled`；坐标用于新任务附近范围、取件点距离和排序 |
| GET | `/system/flashDelivery/rider/orders/{id}` | `data` 直接为稳定的骑手订单详情；未接单隐藏敏感字段，接单后仅订单骑手可见完整履约信息 |
| POST | `/system/flashDelivery/rider/orders/{id}/accept` | 原子抢单，成功后 `data` 直接返回骑手订单详情 |
| POST | `/system/flashDelivery/rider/orders/{id}/pickup` | `{"imageUrls":["https://.../pickup.jpg"]}`；至少一张 |
| POST | `/system/flashDelivery/rider/orders/{id}/deliver` | `{"imageUrls":["https://.../delivery.jpg"],"pinCode":"4821"}`；图片至少一张，启用 PIN 时必须正确 |

骑手页签状态映射：`newTask=WAITING_ACCEPTANCE`、`toPickup=ACCEPTED`、`delivering=PICKED_UP`、`completed=DELIVERED+COMPLETED`、`cancelled=CANCELLED`。除 `newTask` 外只返回当前骑手本人任务；闪送没有 `refund` 页签。

骑手列表摘要字段固定为：`id,orderNo,serviceType,deliveryType,status,packageType,quantity,weightRange,specification,deliveryMode,scheduledPickupStartAt,scheduledPickupEndAt,pinRequired,pickupAddress,pickupDetailAddress,deliveryAddress,deliveryDetailAddress,pickupDistanceMeters,distanceMeters,estimatedDurationSeconds,baseDeliveryFee,urgentFee,tipAmount,amount,currency,createTime`。`newTask` 分页 data 在 `records,total,current,size` 外增加 `nearbyTaskCount,highestOrderAmount`；不返回加急比例、最低加急费或骑手收入字段。

骑手接单前可按原型查看完整取送文字地址，但不返回用户 ID、联系人、电话、实际 PIN、精确经纬度、备注、幂等请求号、履约凭证或日志。抢单成功后才向中单骑手返回完整联系方式、坐标和有权限查看的照片数组。骑手详情在接单前后使用同一个直接 DTO，不返回 `{order,images,logs}` 包装，也不要求 App 判断 `data.order`。

## 平台端

| 方法 | 路径 | 请求/说明 |
|---|---|---|
| GET | `/system/flashDelivery/admin/pricing` | 返回帮送和帮取共享的全部统一运价时段，按开始时间排序 |
| POST | `/system/flashDelivery/admin/pricing` | `startTime,endTime,startingDistance,startingFare,distance,freight,urgentRate,minimumUrgentFee`；保存即生效 |
| PUT | `/system/flashDelivery/admin/pricing/{id}` | 与新增相同的完整请求体；版本原子加一，并发覆盖返回业务错误 |
| DELETE | `/system/flashDelivery/admin/pricing/{id}` | 删除运价时段并立即停止用于报价 |
| GET | `/system/flashDelivery/admin/orders` | 分页；可按状态、类型、订单号、用户、骑手筛选 |
| GET | `/system/flashDelivery/admin/orders/{id}` | 完整详情、凭证、日志 |
| POST | `/system/flashDelivery/admin/orders/{id}/cancel` | `reason` 必填；非终态可取消 |
| POST | `/system/flashDelivery/admin/orders/{id}/complete` | 无 body；仅 DELIVERED |

本期没有支付、退款、取消费、退回费、结算、骑手收入、代购/垫付、商品金额、违禁品电子确认、骑手放弃或自动派单字段和接口。所有闪送金额保持整数 TWD；创建订单后直接待接单，不存在待支付状态。`deliveryType=URGENT` 为 1 对 1 独占配送，相关外卖与闪送接单入口必须执行跨订单独占检查。骑手小费仅为订单费用明细，不代表已付款。

运价时段使用业务当地时间和 `HH:mm` 格式，采用开始时间包含、结束时间不包含的匹配语义；`24:00` 只允许作为结束时间，跨午夜时段必须拆成两个配置。全部时间段不得重叠。起送距离和计价距离必须为正数，起送价格和计价金额必须为正整数，加急比例和最低加急费必须为非负数；立即订单按当前时刻、预约订单按预约开始时刻匹配，目标时刻没有匹配时段时报“对应取件时段暂无可用运价”。

## 2026-09-09：待接单订单修改取送信息与追加小费

以下接口均要求 header `token`，仅订单创建人可调用。订单必须为 `WAITING_ACCEPTANCE` 且无骑手。用户详情新增 `orderVersion`；这是修改时必须回传的订单版本，与运价版本 `pricingVersion` 不同。

| 方法 | 路径 | 用途 |
|---|---|---|
| POST | `/system/flashDelivery/orders/{id}/address/quote` | 修改地址预报价，不更新订单 |
| POST | `/system/flashDelivery/orders/address` | 用户确认报价后保存地址、路线和费用 |
| POST | `/system/flashDelivery/orders/tip` | 追加小费并更新总金额 |

### 地址预报价

请求 DTO：`FlashDeliveryAddressChangeRequest`。必须提交两端完整地址；只改发件或收件一端时，另一端按订单详情原样回传。地址簿数据不随之更新。

```json
{
  "orderVersion": 2,
  "pickup": {
    "name": "寄件人", "phone": "0911111111", "address": "台北市中山區取件地址",
    "addressDetail": "3樓", "city": "台北市", "area": "中山區", "handoffMethod": "到門口取件",
    "latitude": 25.0100, "longitude": 121.5100
  },
  "delivery": {
    "name": "收件人", "phone": "0922222222", "address": "台北市大安區新收件地址",
    "addressDetail": "交前台", "city": "台北市", "area": "大安區", "handoffMethod": "交前台",
    "latitude": 25.0200, "longitude": 121.5200
  }
}
```

`name/phone/address/latitude/longitude` 必填，其余地址字段可空；取送主地址加详细地址不能完全相同，坐标不能相同，路线不得超过 40 公里。

成功 `data` 为既有 `FlashDeliveryQuoteView` 加 `orderVersion`，包括 `distanceMeters/distanceSource/estimatedDurationSeconds/baseDeliveryFee/distanceFee/urgentFee/tipAmount/amount` 及原订单计价快照。即时单和预约单都沿用原订单运价，不因后台调价或跨时段切换价格；已有小费保留。此接口不更改原订单和状态日志。

### 确认保存地址

请求 DTO：`FlashDeliveryAddressConfirmRequest`。订单 ID 改为请求体必填的正整数 `orderId`，不放 URL；提交上述完整地址、同一 `orderVersion`，并回传本次报价字段：

```json
{
  "orderId": 101,
  "orderVersion": 2,
  "pickup": {"name":"寄件人","phone":"0911111111","address":"取件地址","latitude":25.0100,"longitude":121.5100},
  "delivery": {"name":"收件人","phone":"0922222222","address":"新收件地址","latitude":25.0200,"longitude":121.5200},
  "quotedDistanceMeters": 4500,
  "quotedBaseDeliveryFee": 113,
  "quotedDistanceFee": 23,
  "quotedUrgentFee": 0,
  "quotedAmount": 123
}
```

金额仅为示例，客户端必须使用实际报价；`distanceFee` 已包含于 `baseDeliveryFee`，总金额为 `baseDeliveryFee + urgentFee + tipAmount`。

保存前服务端重新计算路线和价格。距离或任一确认金额不同（包括漏传）时，返回非成功 AjaxResult，`msg` 为国际化 `flash.delivery.quote.changed`，`data` 为最新完整报价，订单不变。客户端展示最新报价，经用户再次确认后重新提交，不能自动按新报价扣改金额。

成功返回直接订单详情 DTO（包括新地址、路线、费用和递增后的 `orderVersion`）。修改收件电话后重新匹配收件账号，无法唯一匹配时清空旧账号绑定，原收件人随即失去该订单的查询与签收权限。保持订单 ID、编号、状态、原运价、物品、预约和已有小费。

### 追加小费

请求 DTO：`FlashDeliveryTipAddRequest`：

```json
{"orderId": 101, "orderVersion": 2, "additionalTipAmount": 20}
```

`orderId` 必填，为用户订单详情的正整数 `id`，不放 URL。

`additionalTipAmount` 表示本次增量，必须为正整数 TWD，不是小费最终总额。小费由 10 变为 30 时传 20；总金额同时增加 20，基础配送费、加急费和路线不变。零、负数、空值及金额溢出拒绝。成功返回更新后的直接订单详情和递增版本。此操作仍属于非支付订单金额调整，不产生支付或结算。

### 状态、并发与重试

- 创建人以外的用户（包括已绑定收件人）请求返回订单不存在；状态不是待接单或已有骑手返回 `flash.delivery.edit.not.allowed`。
- 缺失或负数版本返回 `flash.delivery.order.version.invalid`；旧版本或最终条件 UPDATE 未命中返回 `flash.delivery.state.changed`。
- 最终 UPDATE 同时匹配订单 ID、创建人、待接单、无骑手和版本；接单、取消、另一次地址修改或追加小费先成功时，本次不得覆盖。
- 同一小费请求成功后重发旧版本会被拒绝，不会重复加款。网络超时应刷新详情核对小费和总金额，不应自动换新版本重复追加。
- 地址报价后如追加过小费，旧地址确认失效；刷新详情、重新报价并让用户确认。
- 当前取消规则、支付和退款范围不变；无新增数据库字段或迁移 SQL。