Update Image

This endpoint allows you to update a specific product's image by passing the image_id as a path parameter. The updating of the image can be done either via providing a URL link to the image or uploading an image via multipart/form-data media type.

Note

You can only update one image per request.

Scopes

products.read_write- Products Read & Write

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

image-id

string

required

Body Params multipart/form-data

photo

string

required

A specific location or directory on a computer's file system that indicates the file's location.

Example:

@"Users/Images/profile.png"

default

integer

optional

Set the image as default

Example:

sort

number

optional

Sorting order of the image

Example:

alt

string

optional

Alternative text to appear when the image doesn't load properly.

Example:

Alt Text

Responses

🟢201Updated Successfully

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (ProductImagesVideos)

optional

number

required

A unique identifier associated with the product image.

Example:

1908361139

image

object

required

sort

number

required

Sort Order

Example:

default

boolean

required

Whether or not the image the default picture

Default:

false

alt_seo

string | null

required

Alternative SEO Text for the image

video_url

string

required

Video web address.

type

string

required

Attachment Type

Example:

image

Examples

ExampleExample 2

{
    "status": 201,
    "success": true,
    "data": {
        "id": 713368802,
        "image": {
            "original": {
                "url": "https://cdn.salla.sa/bYQEn/9oJoUzXfR8zzXAwAlTRHNIl1xBsuFpgcXdPnkAXd.png",
                "width": 0,
                "height": 0
            },
            "standard_resolution": {
                "url": "https://cdn.salla.sa/bYQEn/9oJoUzXfR8zzXAwAlTRHNIl1xBsuFpgcXdPnkAXd.png",
                "width": 0,
                "height": 0
            },
            "low_resolution": {
                "url": "https://cdn.salla.sa/bYQEn/9oJoUzXfR8zzXAwAlTRHNIl1xBsuFpgcXdPnkAXd.png",
                "width": 0,
                "height": 0
            },
            "thumbnail": {
                "url": "https://cdn.salla.sa/bYQEn/9oJoUzXfR8zzXAwAlTRHNIl1xBsuFpgcXdPnkAXd.png",
                "width": 0,
                "height": 0
            }
        },
        "sort": 5,
        "default": true,
        "alt_seo": "image",
        "video_url": "",
        "type": "image"
    }
}

🟠404Record Not Found

🟠401Unauthorized

Request

Request samples

Responses