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

PUT /v1/items/{id}/images/order

scope

write_items

リクエストパラメーター

名前位置必須説明
idパスstring必須対象のリソース ID
Idempotency-Keyヘッダーstring必須冪等キー(必須)。UUID v4 を推奨します。同一キーの再送は最初の結果をそのまま再生し、応答に Idempotent-Replay: true が付きます。同一キーで異なるボディを送ると 422 になるため、リトライは必ず同一リクエストで行ってください
image_idsボディarray必須追加画像 ID を表示したい順に全件並べた配列(先頭が image_sort=1)

レスポンスの例

{
"item_id": "string",
"images": [
{
"id": "string",
"key": "string",
"url": "string",
"sort": 0
}
]
}

解説

追加画像の表示順を並び替えます。その商品の追加画像を全件、表示したい順に image_ids へ並べて送ります(先頭が最初に表示され、image_sort は 1 から振り直されます)。一部だけを送ると 422 になります(未指定分の順序が不定になり「並べ替えたのに戻る」事故を防ぐため)。メイン画像は対象外で、差し替えは画像登録 API(type: main)を使います。Idempotency-Key 必須。

エラーレスポンスの例

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

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