Skip to main content

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

Scope

write_items

Request parameters

NameInTypeRequiredDescription
idpathstringrequiredID of the target resource.
Idempotency-KeyheaderstringrequiredIdempotency key (required). A UUID v4 is recommended. Resending the same key replays the original result, and the response carries Idempotent-Replay: true. Sending a different body with the same key returns 422, so always retry with the identical request.
image_idsbodyarrayrequiredEvery additional image ID, in the order you want them displayed. The first entry becomes the first image.

Response example

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

Description

Reorder the additional images. Pass every image ID; the first one is displayed first. (write_items)

Error response example

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

Possible errors: 400 / 401 / 403 / 404 / 409 / 422 / 503