​

变更记录

Flex Forward API 与文档的重要变更按时间倒序列出。

---

​

2026 年 7 月

​

变更

• 文档 / OpenAPI： 更正公开身份验证说明。客户集成必须同时发送 x-rr-apikey 与 x-rr-apitoken。已移除 Bearer 令牌示例与公开 OpenAPI 的 bearerAuth 方案作为客户身份验证方式。
• 身份验证： API 认证信息改为从 Return Helper User Portal 的 Settings → Signing Key and API Token 获取，取代以往通过电子邮件申请令牌的流程。

---

​

2026 年 6 月

​

Added

• 端点： GET /couriers — 列出您账户可用的物流商代码。使用返回的 code 值作为创建标签或列出物流商产品时的 courier。

---

​

2026 年 5 月

​

Added

• 端点： GET /products — 列出物流商可用的配送产品。使用返回的产品代码创建标签。
• 认证： 记载 Flex Forward 请求使用 API 密钥 + 令牌头认证（x-rr-apikey / x-rr-apitoken）。
• 端点： GET /labels/{id} — 现在支持以逗号分隔的标识符（标签 UUID 或客户订单编号）进行批量获取。未找到或失败的标签会从响应中省略。
• 响应： GET /labels/{id} 响应现在包含 customerOrderNumber 字段。

​

Changed

• 破坏性变更： 从标签创建请求中移除 shipperAccountId。此字段不再是 service 对象的必填项。
• API 规格： 为所有端点添加详细描述、示例和操作 ID。
• 文档： 改进快速入门指南、请求示例及其他修正。

---

​

v1.0.0

Flex Forward API 与开发者文档的首次公开发布。

​

Added

• 端点： POST /labels（创建配送标签）、GET /labels/{id}（获取标签文档 URL）、GET /tracking/{id}（获取配送追踪）
• 生产物流商： YunExpress（全球跨境电商配送路线）
• 幂等性： 通过 idempotencyKey 内建标签创建重复防止功能
• 统一追踪： 规范化状态标签（Pending、InfoReceived、InTransit、Delivered、Exception、Cancelled、Unknown）以及跨所有物流商的结构化检查点格式
• 认证： API 密钥 + 令牌头认证（x-rr-apikey / x-rr-apitoken），生产与开发环境使用独立认证信息
• 文档： 快速入门指南、认证参考、错误处理指南、幂等性与重试模式、环境详情、核心概念、版本管理政策、常见问题