# 自有车队取件与配送

自有车队上门取件与末端配送使用同一套接口。创建取件或配送订单 → 打印本地面单 → 追踪 → 接收事件通知 → 取消测试订单。

`type` 决定停靠点：`D` 配送，`P` 取件。请按步骤顺序调用。询价为可选步骤，创建订单前不必先询价。

请将 `YOUR_HOST` 与 `ACCESS_TOKEN` 替换为实际环境中的值。

## 1. 登录

```bash
curl -X POST https://YOUR_HOST/api/v1/user/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"your_password"}'
```

将返回的 `access_token` 置于请求头：

```
Authorization: Bearer ACCESS_TOKEN
```

GraphQL 请求提交至 `POST /api/graphql`，并使用相同的 Authorization 请求头。

[REST 手册](/api/documentation#/paths/v1-user-login/post) · [GraphQL 手册](/api/graphql/documentation#/user/userLogin)

**验证：** 登录成功后返回 `access_token`。后续请求若未携带该令牌，将返回 `401`。

## 2. 询价（可选）

本步骤为可选。仅返回报价，不创建订单。创建订单不依赖事先询价。`type` 取 `D`（配送）或 `P`（取件）。

**REST：** `POST /api/v1/orders/rate` — [REST 手册](/api/documentation#/paths/v1-orders-rate/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/orders/rate \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "D",
    "from_postcode": "H9S2H9",
    "from_country": "CA",
    "to_postcode": "H4B2T5",
    "to_country": "CA",
    "packages": [{
      "weight": 1,
      "weight_unit": 2,
      "length": 30,
      "width": 20,
      "height": 10,
      "dimension_unit": 2
    }]
  }'
```

`weight_unit`：`1` 克，`2` 千克，`3` 盎司，`4` 磅。`dimension_unit`：`1` 毫米，`2` 厘米，`3` 米，`4` 英寸。

```json
{
  "result": true,
  "shipping_price": "6.99",
  "currency": "CAD",
  "price_details": {
    "shipping_fee": "6.99",
    "tax_details": [{ "tax_name": "HST", "tax_rate": "13.00", "tax": "0.91" }]
  }
}
```

**GraphQL**（JSON 标量，不要选择集） (`ordersRate` ([GraphQL 手册](/api/graphql/documentation#/orders/ordersRate)))：

```graphql
mutation {
  ordersRate(
    type: "D"
    from_postcode: "H9S2H9"
    from_country: "CA"
    to_postcode: "H4B2T5"
    to_country: "CA"
    packages: [{ weight: 1, weight_unit: 2, length: 30, width: 20, height: 10, dimension_unit: 2 }]
  )
}
```

**验证：** 若执行本调用，`result` 为 true，且 `shipping_price` 是数字。可用 `type` `P` 再询一次取件价格。未返回价格说明邮编不在有效服务范围内。是否询价不影响随后创建订单。

## 3. 创建订单

**REST：** `POST /api/v1/client/orderCreate` — [REST 手册](/api/documentation#/paths/v1-client-orderCreate/post)

请求须包含 `Idempotency-Key`，以避免重试时重复创建订单。

### 配送（`type` `D`）

```bash
curl -X POST https://YOUR_HOST/api/v1/client/orderCreate \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: dev-local-001" \
  -d '{
    "type": "D",
    "need_pick_up": 0,
    "ref": "DEV-LOCAL-001",
    "name": "Jane Recipient",
    "telephone": "5555555555",
    "email": "jane@example.com",
    "address_1": "2667 boul des sources",
    "city": "Pointe-Claire",
    "province": "QC",
    "postcode": "H9S2H9",
    "country": "Canada",
    "packages": 1,
    "packagesDetail": [{
      "ref": "PKG-001",
      "weight": 1,
      "weight_unit": 2,
      "length": 30,
      "width": 20,
      "height": 10,
      "dimension_unit": 2
    }],
    "delivery_instruction": "放侧门"
  }'
```

### 取件（`type` `P`）

同一接口。地址为取件点。

```bash
curl -X POST https://YOUR_HOST/api/v1/client/orderCreate \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: dev-pickup-001" \
  -d '{
    "type": "P",
    "need_pick_up": 1,
    "ref": "DEV-PICKUP-001",
    "name": "Jane Sender",
    "telephone": "5555555555",
    "email": "jane@example.com",
    "address_1": "2667 boul des sources",
    "city": "Pointe-Claire",
    "province": "QC",
    "postcode": "H9S2H9",
    "country": "Canada",
    "packages": 1,
    "packagesDetail": [{
      "ref": "PKG-P-001",
      "weight": 1,
      "weight_unit": 2,
      "length": 30,
      "width": 20,
      "height": 10,
      "dimension_unit": 2
    }],
    "pickup_instruction": "Ring the side bell"
  }'
```

| 字段 | 含义 |
|---|---|
| `type` | `D` 配送，或 `P` 取件 |
| `need_pick_up` | `0` — 货物已入库。`1` — 司机须上门取件 |
| `ref` | 外部参考号，用于查询与对账 |
| `name` / 地址 | 配送：收件人。取件：取件点 |
| `auto_deduplication` | 为 `1` 时，重复的包裹 `ref` 将被拒绝 |

**GraphQL：** `clientOrderCreate` ([GraphQL 手册](/api/graphql/documentation#/client/clientOrderCreate))（JSON 标量）。

```json
{ "result": true, "id": 12345, "tracking_number": "SR123456789012", "orders_status_id": 2 }
```

`orders_status_id` `2` 是新订单。请保存 `id`、`tracking_number` 与 `ref`。

**验证：** 使用相同的 `Idempotency-Key` 再次提交同一请求体，必须返回相同的 `id`，不得产生第二笔订单。

以下情况**不会**创建订单：

| `code` | 处理方式 |
|---|---|
| `INSUFFICIENT_BALANCE` | `insufficient_balance` 中包含应付金额、可用余额与差额。完成充值后重试。 |
| `OUT_OF_DELIVERY_AREA` | 地址超出服务范围，且商户选择删除此类订单。请改用服务范围内的地址。 |
| `IDEMPOTENCY_CONFLICT` | 相同的幂等键对应了不同的请求体。请更换新的 `Idempotency-Key`。 |

被保留的超区订单仍可能返回 `result: true`，但 `shipping_price` 为 `null` 并带 `warning`。须读取该字段。

## 4. 查询订单

```bash
curl "https://YOUR_HOST/api/v1/orders/list?page=1&per_page=50" \
  -H "Authorization: Bearer ACCESS_TOKEN"

curl https://YOUR_HOST/api/v1/orders/12345 \
  -H "Authorization: Bearer ACCESS_TOKEN"
```

**REST：** `GET /api/v1/orders/list` — 该账号的全部订单，最新的在前，每条订单都带上它的包裹与货物明细。同时传 `page` 和 `per_page` 即可分页（`per_page` 最大 1000）；不传则返回最新的 1000 条并附带 `truncated` 标记。[REST 手册](/api/documentation#/paths/v1-orders-list/get)

**GraphQL：** `ordersList` ([GraphQL 手册](/api/graphql/documentation#/orders/ordersList))

**REST：** `GET /api/v1/orders/{orderId}` — [REST 手册](/api/documentation#/paths/v1-orders-orderId/get)

**GraphQL：** `orders` ([GraphQL 手册](/api/graphql/documentation#/orders/orders))

**验证：** 确认该订单归属当前账号。`ref` 与创建时提交的值一致。`tracking_number` 与第 3 步一致。

## 5. 打印本地面单

**REST：** `POST /api/v1/shipping/getShippingLabel` — [REST 手册](/api/documentation#/paths/v1-shipping-getShippingLabel/post)

```bash
curl -X POST https://YOUR_HOST/api/v1/shipping/getShippingLabel \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "SR123456789012",
    "type": "TRACKING_NUMBER",
    "base64": 1,
    "hide_sender_address": 0,
    "hide_receiver_address": 0
  }'
```

`type`：`TRACKING_NUMBER`、`ORDER_ID` 或 `REF`。`base64: 0`（默认）直接下发 PDF 流。 `base64: 1` 时整个响应体是一个顶层 JSON 字符串，直接存放 base64 PDF，而不是带 `pdf_data` 字段的对象。如果希望标签包在常规 JSON 对象里，请改调 `POST /api/v2/shipping/getShippingLabel`。

**GraphQL：** `shippingGetShippingLabel` ([GraphQL 手册](/api/graphql/documentation#/shipping/shippingGetShippingLabel))。`shippingGetShippingLabelV2` ([GraphQL 手册](/api/graphql/documentation#/shipping/shippingGetShippingLabelV2)) 始终返回 JSON（`pdf_data`）。

**验证：** PDF 可正常打开。配送面单显示收件人；取件面单显示取件地址。若隐藏了某一侧地址，该侧将留空。

## 6. 追踪

公开查询接口，无需访问令牌。

```bash
curl https://YOUR_HOST/api/v1/tracking/SR123456789012
```

[REST 手册](/api/documentation#/operations/getPublicTracking) · [GraphQL 手册](/api/graphql/documentation#/tracking/trackingPublic)

若 `ref` 已保存为外部单号，同一 URL 亦可使用 `ref` 查询。

**GraphQL**（带类型，需要选择集）：

```graphql
query {
  trackingPublic(trackingNumber: "SR123456789012") {
    result
    deliveried
    returntosender
    rejectedbyrecipient
    postcode
    data {
      tracking_event_status_id
      tracking_event_key
      description
      updated_at_localized
    }
    proofs { file_id type full_url signed_url }
  }
}
```

请按 `tracking_event_status_id` 分支，不要依据 `description`（该字符串跟随 `Accept-Language`）：

| `tracking_event_status_id` | 侧 | 含义 |
|---|---|---|
| `100` | 两侧 | 已接收订单 |
| `300` / `301` | 配送 | 已入设施 |
| `450` | 配送 | 正在派送 |
| `500` | 配送 | 已送达 |
| `501` | 配送 | 派送失败，需要重新计划 |
| `460` | 取件 | 正在取件 |
| `510` | 取件 | 已取件 |
| `512` | 取件 | 取件失败，稍后再试 |
| `513` | 取件 | 取件异常 |

`data` 最新在前。第一行表示当前状态。`500` 之后 `deliveried: true`。

`500` 或 `510` 时 `proofs[]` 可能带 `type` `1`（签名）或 `2`（照片），以及 `file_id`、`signed_url`。该事件之后上传的照片不会出现在该次响应中，须在第 7 步订阅 `pod.files_updated`。

**验证：** 创建完成后，最新事件应为 `100`，`deliveried` 为 false。未知运单号返回 `result: false` 或 HTTP 404。应展示未找到状态，请勿生成不存在的轨迹事件。

## 7. 配置事件通知

按业务需要配置以下回调地址：

| 配置项 | 事件 | 触发时机 |
|---|---|---|
| `order_create_webhook_url` | `order.created` | 保存 `id` 和 `tracking_number` |
| `order_status_change_webhook_url` | `order.status_change` | 面向收件人的订单状态 |
| `tracking_event_webhook_url` | `tracking.event` | 取件或配送轨迹时间线 |
| `pod_files_webhook_url` | `pod.files_updated` | 取件或送达后的照片/签名 |
| `order_cancel_failed_webhook_url` | `order.cancel_failed` | 你发起的取消被拒绝 |

**REST:** `PUT /api/v1/webhook-settings` — [REST 手册](/api/documentation#/paths/v1-webhook-settings/put)

**GraphQL:** `webhookSettingsUpdate` ([GraphQL 手册](/api/graphql/documentation#/webhooks/webhookSettingsUpdate)).

```bash
curl -X PUT https://YOUR_HOST/api/v1/webhook-settings \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "order_create_webhook_url": "https://erp.example.com/hooks/superroute",
    "order_status_change_webhook_url": "https://erp.example.com/hooks/superroute",
    "tracking_event_webhook_url": "https://erp.example.com/hooks/superroute",
    "webhook_sign_secret": "YOUR_LONG_RANDOM_SECRET",
    "webhook_verify_ssl": 1
  }'
```

用**原始报文**校验 **v2**：`HMAC_SHA256(timestamp + "." + raw_body, secret)` 对照 `X-Webhook-Signature-V2`。用 `X-Webhook-Event-Id` 去重。**3 秒内返回 2xx**。

```php
$raw = file_get_contents('php://input');
$ts  = $_SERVER['HTTP_X_WEBHOOK_TIMESTAMP'] ?? '';
$sig = $_SERVER['HTTP_X_WEBHOOK_SIGNATURE_V2'] ?? '';
$expected = hash_hmac('sha256', $ts . '.' . $raw, $sharedSecret);
if (!hash_equals($expected, $sig)) {
    http_response_code(401);
    exit;
}
```

**验证：** 创建一笔测试订单，应收到包含同一 `id` / `tracking_number` 的 `order.created`。签名校验失败时，接收端应返回 `401`。同一 `X-Webhook-Event-Id` 的重复投递不得被处理两次。

## 8. 取消测试订单

**REST：** `POST /api/v1/orders/cancel` — [REST 手册](/api/documentation#/paths/v1-orders-cancel/post)——`order_id`、`tracking_number`、`external_tracking_number` 三个参数仅能传入其中一个。

```bash
curl -X POST https://YOUR_HOST/api/v1/orders/cancel \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tracking_number":"SR123456789012"}'
```

已经取消：`200` 且 `already_cancelled: true`。**GraphQL：** `ordersCancel` ([GraphQL 手册](/api/graphql/documentation#/orders/ordersCancel))。

**验证：** 公开追踪不再将该运单视为有效在途件。若取消被拒（`409`，例如 `ORDER_ALREADY_IN_DELIVERY`），会发出 `order.cancel_failed`。

## 9. 批量创建（可选）

- `POST /api/v1/client/batchOrderCreate` — [REST 手册](/api/documentation#/paths/v1-client-batchOrderCreate/post) — 同步等待全部行处理完成。
- `POST /api/v1/client/batchOrderCreateAsync` — [REST 手册](/api/documentation#/paths/v1-client-batchOrderCreateAsync/post) — 立即返回任务标识；轮询 `GET /api/v1/client/async/{id}` — [REST 手册](/api/documentation#/paths/v1-client-async-id/get) 或收 `order.create_async`。

字段与第 3 步一致，以订单数组形式提交。每一行可以是 `type` `D` 或 `P`。**GraphQL：** `clientBatchOrderCreate` ([GraphQL 手册](/api/graphql/documentation#/client/clientBatchOrderCreate)) / `clientBatchOrderCreateAsync` ([GraphQL 手册](/api/graphql/documentation#/client/clientBatchOrderCreateAsync))。

**验证：** 每一行均包含独立的 `result`。订单数量超过约 100 笔时，建议使用异步接口。

## 验收清单

请使用测试参考号，例如 `DEV-LOCAL-001` / `DEV-PICKUP-001`：

- [ ] （可选）`type` `D` 询价应返回价格。
- [ ] （可选）`type` `P` 询价应返回价格。
- [ ] 创建配送订单返回 `id` + `tracking_number`；同一 `Idempotency-Key` 不会重复创建订单。
- [ ] 创建取件订单返回 `id` + `tracking_number`；`need_pick_up` 为 `1`。
- [ ] 列表与详情中可查询到当前账号下的该订单。
- [ ] 本地面单 PDF 可正常打开，并显示收件人或取件地址。
- [ ] 公开追踪无需访问令牌即可返回时间线，最新事件为 `100`。
- [ ] 应收到 `order.created`，且 v2 签名校验通过。
- [ ] 取消应返回 `result: true`（重试时为 `already_cancelled: true`）。