メインコンテンツへスキップ
POST
/
labels
配送ラベルを作成する
curl --request POST \
  --url https://api.flexforwardship.com/labels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "unique-key-per-request",
  "courier": "yunexpress",
  "service": {
    "productCode": "HKMUZXR"
  },
  "label": {
    "format": "PDF"
  },
  "units": {
    "weight": "KG",
    "dimension": "CM"
  },
  "order": {
    "customerOrderNumber": "N-2026-05-27-TEST-03",
    "orderNumbers": {
      "platformOrderNumber": "platform-order-number",
      "referenceNumbers": [
        "ref-number-1",
        "ref-number-2"
      ]
    }
  },
  "shipment": {
    "shipTo": {
      "contact": {
        "firstName": "Alex",
        "lastName": "Smith",
        "phone": 8554377467,
        "email": "[email protected]"
      },
      "address": {
        "streetLines": [
          "18 Distribution Blvd"
        ],
        "city": "Edison",
        "state": "New jersey",
        "postalCode": 8817,
        "countryCode": "US"
      }
    },
    "shipFrom": {
      "contact": {
        "firstName": "John",
        "lastName": "Doe",
        "phone": 886900676877,
        "email": "[email protected]"
      },
      "address": {
        "streetLines": [
          "Habucho"
        ],
        "city": "Kishiwada-Shi",
        "state": "Osaka",
        "postalCode": "596-0825",
        "countryCode": "JP"
      }
    },
    "parcels": [
      {
        "weight": 0.5,
        "dimension": {
          "length": 30,
          "width": 20,
          "height": 10
        },
        "items": [
          {
            "descriptionEn": "Muji Ink pen",
            "descriptionLocal": "文具",
            "quantity": 1,
            "unitPrice": {
              "amount": 29.99,
              "currency": "USD"
            },
            "unitWeight": 0.5
          }
        ]
      }
    ]
  },
  "serviceOptions": [
    {
      "code": "V1",
      "value": "云途预缴"
    }
  ],
  "courierOptions": {
    "yunexpress": {
      "sourceCode": "YT",
      "sensitiveType": "D"
    }
  }
}
'
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "created",
  "courier": "yunexpress",
  "customerOrderNumber": "N-2026-05-27-TEST-03",
  "courierOrderNumber": "YT2503010001",
  "courierTrackingNumber": "YT2503010001CN",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

承認

Authorization
string
header
必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ボディ

application/json

配送ラベル作成リクエストのペイロード。

配送ラベル作成リクエストのペイロード。

idempotencyKey
string
必須

冪等なラベル作成を保証するためのクライアント生成の一意キー。同じキーでリクエストを再送すると元の結果が返されます。

Required string length: 1 - 100
:

"unique-key-per-request"

courier
string
必須

使用する配送業者コード。GET /couriers を呼び出してアカウントで利用可能な有効な配送業者コードを一覧し、返された code 値のいずれかを指定してください。

Minimum string length: 1
:

"yunexpress"

service
object
必須

配送業者サービスの設定。

shipment
object
必須

発送元、配送先、荷物を含む出荷の詳細。

label
object

ラベル出力の設定。

units
object

重量と寸法の計測単位。

order
object

注文参照情報。

customs
object

国際輸送のための税関申告情報。

serviceOptions
object[]

コードと値のペアによる追加サービスオプション。

dangerousGoods
object

危険物申告。

pickup
object

集荷ポイントの設定。

courierOptions
object

配送業者固有のオプション。

レスポンス

ラベル作成リクエストの結果。

ラベル作成リクエストの結果。

id
string<uuid>
必須

一意のラベル識別子。

:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

status
必須

ラベル作成結果 — created または failed。

利用可能なオプション:
created
:

"created"

courier
string
必須

使用した配送業者。

:

"yunexpress"

customerOrderNumber
string
必須

このラベルに関連付けられた顧客注文番号。

:

"N-2026-05-27-TEST-03"

courierOrderNumber
string | null
必須

配送業者が付与した注文番号。失敗時は null。

:

"YT2503010001"

courierTrackingNumber
string | null
必須

配送業者が付与した追跡番号。未取得の場合は null。

:

"YT2503010001CN"

error
object | null
必須

ラベル作成が失敗した場合のエラー詳細。それ以外は null。