メインコンテンツまでスキップ

POST /v1/inflow_routes

scope​

write_inflow_routes

リクエストパラメーター​

名前位置型必須説明
Idempotency-Keyヘッダーstring必須冪等キー（必須）。UUID v4 を推奨します。同一キーの再送は最初の結果をそのまま再生し、応答に Idempotent-Replay: true が付きます。同一キーで異なるボディを送ると 422 になるため、リトライは必ず同一リクエストで行ってください
nameボディstring必須流入経路名（管理用）
linkボディstring任意遷移先 URL。クエリ文字列を含むこと（配布 URL は末尾に &tracking={code} を連結して作られるため）。省略時は店舗のトップに着地する
redirect_urlボディstring任意着地後のリダイレクト先。店舗ドメイン自身は指定できない
valid_fromボディstring任意日付のみ（有効期間は日単位で判定されるため時刻を持たない）
valid_toボディstring任意日付のみ（有効期間は日単位で判定されるため時刻を持たない）

レスポンスの例​

{
  "data": {
    "id": "42",
    "code": "a7Kq2mZ0xB",
    "name": "夏キャンペーン",
    "link": "string",
    "redirect_url": "string",
    "valid_from": "2026-09-01",
    "valid_to": "2026-12-31",
    "created_at": "2026-06-01T03:00:00Z"
  }
}

解説​

流入経路リンクを作成します。code はサーバー側で採番され、発行後の変更はできません。作成したリンク経由の注文には、その経路が記録されます。

エラーレスポンスの例​

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

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