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

POST /v1/categories

scope​

write_items

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

名前位置型必須説明
Idempotency-Keyヘッダーstring必須冪等キー（必須）。UUID v4 を推奨します。同一キーの再送は最初の結果をそのまま再生し、応答に Idempotent-Replay: true が付きます。同一キーで異なるボディを送ると 422 になるため、リトライは必ず同一リクエストで行ってください
nameボディstring必須カテゴリー名。1〜40 文字
parent_idボディstring任意親カテゴリー ID（省略=親カテゴリーとして作成）。2 階層まで
statusボディenum(activeinactive)任意

レスポンスの例​

{
  "data": {
    "id": "1",
    "parent_id": "string",
    "name": "string",
    "status": "active",
    "sort": 0
  }
}

解説​

カテゴリーを作成します。parent_id を指定すると子カテゴリー（階層は 2 段まで・孫は 422）。並び順 sort は同一階層の末尾に自動採番されます。プラン上限（カテゴリー数・公開数）を超える作成は 422。Idempotency-Key 必須。

エラーレスポンスの例​

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

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