PATCH /v1/categories/{id}
scope
write_items
リクエストパラメーター
| 名前 | 位置 | 型 | 必須 | 説明 |
|---|---|---|---|---|
id | パス | string | 必須 | 対象のリソース ID |
Idempotency-Key | ヘッダー | string | 必須 | 冪等キー(必須)。UUID v4 を推奨します。同一キーの再送は最初の結果をそのまま再生し、応答に Idempotent-Replay: true が付きます。同一キーで異なるボディを送ると 422 になるため、リトライは必ず同一リクエストで行ってください |
parent_id | ボディ | object | 任意 | ⚠️ 変更できません。 親カテゴリーの付け替えは未対応で、送ると 400 を返します |
name | ボディ | string | 任意 | カテゴリー名。1〜40 文字 |
status | ボディ | enum(active | inactive) | 任意 |
sort | ボディ | integer | 任意 | 同じ階層内での表示順(小さいほど先)。作成時は末尾に自動採番されます |
レスポンスの例
{
"data": {
"id": "1",
"parent_id": "string",
"name": "string",
"status": "active",
"sort": 0
}
}
解説
カテゴリーを編集します(name / status / sort のみ)。親の付け替え(parent_id の変更)はできず 400。状態ロック中(status_locked)の公開状態変更は 422。Idempotency-Key 必須。
エラーレスポンスの例
{
"error": {
"code": "insufficient_scope",
"message": "requires scope 'write_items'",
"request_id": "req_01H..."
}
}
返しうるエラー: 400 / 401 / 403 / 404 / 422 / 503