# PUT /api/items/{id}/stock

在庫設定

指定した商品または種類の在庫数を設定します。

`count` は変更後の在庫数を表し、増減させる数ではありません。
種類の在庫を設定する場合は、`variation_id` の指定も必要です。
種類を持たない商品の在庫を設定する場合は、`variation_id` を省略します。

1 回のリクエストで設定できるのは、商品本体または 1 つの種類の在庫です。

## 要求スコープ

- `items.read`
- `items.update`

## パラメータ

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | `string` | 必須 | 商品 ID（1 以上の整数を文字列で表したもの） |

## リクエストボディ

`application/json`

- `variation_id` integer（任意 / ≥ 0）: 対象の種類の ID。省略時は商品本体（種類を持たない商品）の在庫を指します。
- `count` integer（必須 / ≥ 0 / ≤ 100000）: 在庫数（絶対値、個、0 以上 100000 以下）

## レスポンスボディ（200）

`application/json`

- `variation_id` integer（任意 / ≥ 0）: 対象の種類の ID。商品本体の在庫の場合はキーごと省略されます。
- `count` integer（必須 / ≥ 0 / ≤ 100000）: 在庫数（絶対値、個、0 以上 100000 以下）

## リクエスト例

```sh
curl -X PUT "https://apiv2.thebase.com/api/items/123/stock" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "variation_id": 0,
  "count": 0
}'
```

## レスポンス

| Status | Description |
| --- | --- |
| `200` | 設定成功。 |

## エラー

エラーは `application/problem+json` の Problem 形式で返します。認証・スコープ・予期しない内部エラーなど、すべてのエンドポイントに共通のエラーと構造・判別方法は [エラーレスポンス](/docs/errors.md) を参照してください。

このエンドポイントが返すその他のエラーは次のとおりです。

| Status | Type | Description |
| --- | --- | --- |
| `400` | `/errors/request/malformed-body` | リクエストボディをこのエンドポイントが要求する形式として解釈できない場合に返します。 |
| `400` | `/errors/request/invalid-params` | 1 つ以上のパスパラメータがエンドポイントのスキーマを満たさない場合に返します。 |
| `400` | `/errors/items/invalid-body` | リクエストボディがエンドポイントのスキーマを満たさない場合に返します。 |
| `404` | `/errors/items/not-found` | 指定した商品が存在しない、または呼び出し元から参照できない場合に返します。1 リクエストで複数の商品を指定するエンドポイント（並び順の変更など）では、そのいずれかが参照できない場合に返します。 |
| `404` | `/errors/items/variation-not-found` | 指定した種類が存在しない、対象の商品に属していない、または呼び出し元から参照できない場合に返します。 |
| `413` | `/errors/request/body-too-large` | JSON リクエストボディが 1 MiB の上限を超える場合に返します。 |
| `415` | `/errors/request/unsupported-media-type` | JSON 形式のリクエストボディを要求するエンドポイントに、対応していない Content-Type が指定された、または Content-Type が指定されていない場合に返します。 |
| `422` | `/errors/items/variation-id-required` | 種類を持つ商品の在庫を更新する際に variation_id を指定しなかった場合に返します。対象の種類を variation_id で指定してください。 |
| `422` | `/errors/items/write-rejected` | 商品の作成・編集・削除を業務ルールにより実行できない場合に返します (型整合性違反、種別不可変、ドメイン制約違反など)。細分化された Problem type に対応しない理由のときに返します。 |
| `502` | `/errors/internal/bad-gateway` | BASE API が処理を完了するために必要な内部処理で不整合が発生した場合に返します。 |
| `504` | `/errors/internal/gateway-timeout` | BASE API が処理を完了するために必要な内部処理が制限時間内に完了しなかった場合に返します。 |