跳轉到主要內容

Flex Forward API

Flex Forward 提供單一 API 來建立配送標籤、取得提單文件,以及追蹤貨件。透過統一的請求格式、正規化的追蹤資料與內建冪等性,一次整合即可對接多個物流業者。

核心工作流程

建立標籤

透過支援的物流業者建立配送標籤,支援冪等請求。

取得標籤文件

取得已建立標籤的提單 PDF 或 PNG。

貨件追蹤

以統一格式取得所有物流業者的即時追蹤資訊。

三步驟開始

1

取得 API 存取權限

聯繫 Flex Forward 團隊 [email protected] 申請 API 認證資訊。您將收到用於身份驗證的 Bearer 令牌。
2

建立您的第一個標籤

發送包含配送資訊的 POST /labels 請求。API 將回傳標籤 ID 和追蹤號碼。
3

取得文件並追蹤

使用標籤 ID 取得提單文件(GET /labels/{id})並追蹤貨件(GET /tracking/{id})。

按照快速入門指南操作

從身份驗證到建立第一個標籤的逐步指南。

整合流程

第一個請求範例

curl -X POST https://api.flexforward.com/labels \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "idempotencyKey": "ord-20250301-abc123",
    "courier": "yunexpress",
    "service": {
      "shipperAccountId": "your-account-id",
      "productCode": "YEXP01"
    },
    "shipment": {
      "shipFrom": {
        "contact": { "firstName": "Sender", "lastName": "Name", "phone": "+81-90-1234-5678" },
        "address": { "countryCode": "JP", "city": "Tokyo", "postalCode": "100-0001", "streetLines": ["1-1 Marunouchi"] }
      },
      "shipTo": {
        "contact": { "firstName": "Recipient", "lastName": "Name", "phone": "+1-555-0100" },
        "address": { "countryCode": "US", "city": "Los Angeles", "state": "CA", "postalCode": "90001", "streetLines": ["123 Main St"] }
      },
      "parcels": [{
        "weight": 0.5,
        "items": [{
          "descriptionEn": "T-Shirt",
          "descriptionLocal": "T恤",
          "quantity": 2,
          "unitPrice": { "amount": 25.00, "currency": "USD" },
          "unitWeight": 0.25
        }]
      }]
    }
  }'
201 Created
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "created",
  "courier": "yunexpress",
  "courierOrderNumber": "YT2503010001",
  "courierTrackingNumber": "YT2503010001CN",
  "error": null
}

正式環境支援範圍

Flex Forward 目前支援透過 YunExpress 進行正式環境的配送,涵蓋全球跨境電商物流。
物流業者代碼服務區域
YunExpressyunexpress全球跨境電商
可根據物流路線需求及帳戶建置來啟用額外的物流業者。如需了解物流業者的可用性,請聯繫 Flex Forward 團隊。

環境

環境基礎 URL
正式https://api.flexforward.com
開發https://sandbox.flexforward.com
所有 API 請求必須透過 HTTPS 發送。開發環境連接至物流業者的沙盒服務,可安全進行測試。

環境詳情

認證資訊分離、環境行為與營運注意事項。

平台可靠性

身份驗證

Bearer 令牌驗證與認證資訊管理最佳實踐。

錯誤處理

HTTP 狀態碼、錯誤回應格式與疑難排解指南。

冪等性與重試

防止重複建立標籤並安全地重試請求。

版本管理

API 如何處理變更與向後相容性。

OpenAPI 規格

下載 OpenAPI 規格

下載 OpenAPI 3.1 規格以用於程式碼生成、客戶端 SDK 和 API 工具。

支援

如需建置協助、整合支援或物流業者可用性諮詢,請聯繫 Flex Forward 團隊:[email protected]

支援與常見問題

技術支援、建置指南與常見問題。