Next Commerce
Products

Products Image Update

Update details of an existing product image.

PATCH
/products/{id}/images/{imageId}/

Authorization

oauth2 catalogue:write
AuthorizationBearer <token>

Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123

In: header

Scope: catalogue:write

Path Parameters

id*integer

A unique integer value identifying this Product.

imageId*string
Match^\d+$

Header Parameters

X-29next-API-Version*string
Default"2023-02-10"
Value in"2023-02-10"

Request Body

caption?string
Lengthlength <= 200
display_order?integer

An image with a display order of zero will be the primary image for a product

Range0 <= value <= 2147483647
variants?array<>

Response Body

application/json

curl -X PATCH "https://example.29next.store/api/admin/products/0/images/string/" \
  -H "X-29next-API-Version: 2023-02-10" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "attachment": "string",
  "caption": "string",
  "display_order": 2147483647,
  "file_name": "string",
  "id": 0,
  "src": "http://example.com"
}