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

画像の並び替え

指定した商品の画像を並び替えます。

`image_ids` に、その商品のすべての画像 ID を並べた順序が表示順になります。
一部だけの指定や、同じ ID の重複はできません。

指定した ID が現在の画像の一覧と一致しない場合は `invalid-image-order`、存在しない画像 ID を含む場合は `image-not-found` を返します。
変更後の画像一覧を、指定した表示順で返します。

## 要求スコープ

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

## パラメータ

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

## リクエストボディ

`application/json`

- `image_ids` integer[]（必須）: 画像 ID を表示順に並べた配列（1〜20 件）。先頭が 1 番目です。その商品に現存するすべての画像を過不足なく一度ずつ含める必要があります。全置換のため、部分指定はできません。ID の重複は指定できません。

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

`application/json`

- `images` ItemImage[]（必須）: 商品画像の一覧（最大 20 件）。表示順に並びます。
  - `id` integer（必須 / ≥ 0）: 画像 ID
  - `url` string (uri)（必須）: 画像の公開 URL。アップロードされたままのサイズで返します。
  - `scaled_url` string (uri)（必須）: 縦横比を保ったまま幅を変えた画像の URL。幅 640px を指定した例です。URL に含まれる幅の値を変えると、任意の幅で取得できます。
  - `square_url` string (uri)（必須）: 中央を切り抜いて正方形にした画像の URL。一辺 900px を指定した例です。URL に含まれる寸法の値を変えると、任意の大きさで取得できます。

## リクエスト例

```sh
curl -X PUT "https://apiv2.thebase.com/api/items/123/images" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "image_ids": [
    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/image-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/invalid-image-order` | 画像の並び替えで指定した画像 ID の集合が、その商品の現存する画像集合と一致しない場合に返します。現存するすべての画像を過不足なく一度ずつ、表示順に並べて指定してください。 |
| `422` | `/errors/items/write-rejected` | 商品の作成・編集・削除を業務ルールにより実行できない場合に返します (型整合性違反、種別不可変、ドメイン制約違反など)。細分化された Problem type に対応しない理由のときに返します。 |
| `502` | `/errors/internal/bad-gateway` | BASE API が処理を完了するために必要な内部処理で不整合が発生した場合に返します。 |
| `504` | `/errors/internal/gateway-timeout` | BASE API が処理を完了するために必要な内部処理が制限時間内に完了しなかった場合に返します。 |