[lightMode]

Attach Image by SKU

POST/products/sku/{sku}/images

[updatedIn] 2 months ago

This endpoint allows you to attach an image by passing the sku as a path parameter.

:::check[Note]
Make sure that you upload a file of image format by sending the body data as multipart/form-data

:::

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]

sku

string

required

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

[message.bodyParameter]multipart/form-data

photo

string

optional

Upload an image as file

Example:

@/home/user/Pictures/sku-image.png

Request samples

[api.label.responses]

Success(200)

Not Found(404)

Error Validation(422)

HTTP Code: 200

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": 1908361139,
    "image": {
      "original": {
        "url": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
        "width": 0,
        "height": 0
      },
      "standard_resolution": {
        "url": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
        "width": 1000,
        "height": 424.597364568082
      },
      "low_resolution": {
        "url": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
        "width": 500,
        "height": 212.298682284041
      },
      "thumbnail": {
        "url": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
        "width": 120,
        "height": 50.95168374816984
      }
    },
    "sort": 0,
    "default": false,
    "alt_seo": null,
    "video_url": "",
    "type": "image"
  }
}

[updatedIn] 2 months ago