Skip to content

PUT /{product_key}/image

Replace Product Image

PUT
/product/{product_key}/image

Replace the product's primary image.

Writes the uploaded file to the product media folder as image.jpg and sets
image=true in the product document. Any previous image file is overwritten.

Emits: (direct file write — no event class)

Required scope: product:catalogue:update

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Parameters

Path Parameters

product_key*
Type
string
Required

Request Body

multipart/form-data
object

Responses

Successful Response

application/json
JSON
{
  
"status": 200,
  
"message": "string",
  
"detail": "string"
}

Samples

Powered by VitePress OpenAPI