POST /v1/orders/{id}/trackings

scope

write_shipping

リクエストパラメーター

名前	位置	型	必須	説明
id	パス	string	必須	order_id
Idempotency-Key	ヘッダー	string	必須	冪等キー（必須）。UUID v4 を推奨します。同一キーの再送は最初の結果をそのまま再生し、応答に Idempotent-Replay: true が付きます。同一キーで異なるボディを送ると 422 になるため、リトライは必ず同一リクエストで行ってください
order_shipping_id	ボディ	string	必須	配送先（order_shipping）の ID。注文詳細 EP の shippings から取得
carrier_id	ボディ	string	必須	配送業者 ID（GET /v1/delivery_companies）
tracking_number	ボディ	string	必須	送り状番号
delivery_date	ボディ	string	任意	配達（予定）日 YYYY-MM-DD

レスポンスの例

{
  "tracking_id": "1",
  "order_id": "1",
  "order_shipping_id": "1",
  "carrier_id": "1",
  "tracking_number": "string",
  "delivery_date": "string"
}

解説

送り状（配送業者・追跡番号・配達予定日）を登録します。order_shipping_id は GET /v1/orders/{id}/shipments で取得してください。登録はマーチャントの修正ログに記録されます。Idempotency-Key 必須。

エラーレスポンスの例

{
  "error": {
    "code": "insufficient_scope",
    "message": "requires scope 'write_shipping'",
    "request_id": "req_01H..."
  }
}

返しうるエラー: 401 / 403 / 404 / 503