POST /v1/categories
scope
write_items
リクエストパラメーター
| 名前 | 位置 | 型 | 必須 | 説明 |
|---|---|---|---|---|
Idempotency-Key | ヘッダー | string | 必須 | 冪等キー(必須・ADR-010)。UUID v4 推奨 |
name | ボディ | string | 必須 | |
parent_id | ボディ | string | 任意 | 親カテゴリー ID(省略=親カテゴリーとして作成)。2 階層まで |
status | ボディ | enum(active | inactive) | 任意 |
レスポンスの例
{
"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 'read_orders'",
"request_id": "req_01H..."
}
}
返しうるエラー: 400 / 401 / 403 / 422 / 503