[lightMode]

Attach Image

POST/products/{product}/images

[updatedIn] 2 months ago

This endpoint allows you to add up to 10 images to a specific product by passing the product as a path parameter.

:::tip[Note]

You can only send one image per request.
You can attach an image to a product either via URL link or by uploading an image.
:::

`products.read_write`- Products Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.pathParameter]

product

integer

required

The Product ID. List of Product ID can be found here.

[message.bodyParameter]multipart/form-data

photo

file

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

Request samples

[api.label.responses]

Attached Successfully(201)

Not Found(404)

Error Validation(422)

Attached Successfully

HTTP Code: 201

Content Type : JSONapplication/json

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

{
  "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"
  }
}

[updatedIn] 2 months ago