跳转到主要内容
此页面由英文翻译而成。英文版为官方权威来源。如翻译内容有任何不一致之处,请以英文版为准。

Flex Forward API

Flex Forward 提供单一 API 来创建配送标签、获取运单文件,以及追踪货件。通过统一的请求格式、规范化的追踪数据与内建幂等性,一次集成即可对接多个物流商。

核心工作流程

创建标签

通过支持的物流商创建配送标签,支持幂等请求。

获取标签文件

获取已创建标签的运单 PDF。

货件追踪

以统一格式获取所有物流商的实时追踪信息。

三步骤开始

1

获取 API 访问权限

请至 Return Helper User Portal(Settings → Signing Key and API Token)获取 API 密钥与 API 令牌,或联系 [email protected] 寻求帮助。
2

创建您的第一个标签

发送包含配送信息的 POST /labels 请求。API 将返回标签 ID 和追踪号码。
3

获取文件并追踪

使用标签 ID 获取运单文件(GET /labels/{id})并追踪货件(GET /tracking/{id})。

按照快速入门指南操作

从身份验证到创建第一个标签的逐步指南。

集成流程

第一个请求示例

201 Created

生产环境支持范围

Flex Forward 目前支持通过 YunExpress 进行生产环境的配送,涵盖全球跨境电商物流。 可根据物流路线需求及账户设置来启用额外的物流商。如需了解物流商的可用性,请联系 Flex Forward 团队。

环境

所有 API 请求必须通过 HTTPS 发送。开发环境连接至物流商的沙盒服务,可安全进行测试。

环境详情

认证信息分离、环境行为与运维注意事项。
Flex Forward 可能在不事先通知的情况下在 API 响应中新增字段。请勿使用严格模式(schema)验证响应 — 请忽略未知字段,并妥善处理未知的枚举值。详见版本管理。

平台可靠性

身份验证

API 密钥与令牌头验证,以及认证信息管理最佳实践。

错误处理

HTTP 状态码、错误响应格式与故障排除指南。

幂等性与重试

防止重复创建标签并安全地重试请求。

版本管理

API 如何处理变更与向后兼容性。

OpenAPI 规格

下载 OpenAPI 规格

下载 OpenAPI 3.1 规格以用于代码生成、客户端 SDK 和 API 工具。

支持

如需部署协助、集成支持或物流商可用性咨询,请联系 Flex Forward 团队:[email protected]

支持与常见问题

技术支持、部署指南与常见问题。