Update image information

Requires write_products access scope.

For more info, refer to:

PUT https://{handle}.myshopline.com/admin/openapi/v20260301/products/:product_id/images/:image_id.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Update image information.

Path Parameters

product_id string required

The unique identifier for a product.
Maximum length：64

Example: 16057039432335099907370282
image_id string required

The unique identifier for an image.
Maximum length：64

Example: 5785060242375689228

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

imageobject

Image information.
alt string

The alternative textual description of a product image, usually a word or phrase with the characteristics or content of the image.
Maximum length: 512
Example: This is an image alt.
position integer

Image position.
Example: 1
sku_id string

The unique identifier for a variant.
Maximum length：64
Example: 18057850264851626133510282

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

imageobject

Image information.
alt string

The alternative textual description of a product image, usually a word or phrase with the characteristics or content of the image.
Example: This is an image alt
create_time string

The date and time when the product image was created. Format: ISO 8601.
Example: 2023-01-31T13:22:37+08:00
height integer

Image height, in pixels.
Example: 1280
id string

The unique identifier for a product image.
Example: 5785060242375689228
position integer

Image location.
Example: 1
product_id string

The unique identifier for a product.
Example: 16057850264845250791280282
sku_id string

The unique identifier for a variant.
Example: 18057850264851626133510282
src string

The link to a product image, represented as a URL.
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
update_time string

The date and time when the product image was last updated. Format: ISO 8601.
Example: 2023-01-31T13:22:37+08:00
width integer

Image width, in pixels.
Example: 1280

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

product_id — path required

image_id — path required

Authorization — header required

Body

Body required

{
  "image": {
    "alt": "This is an image alt.",
    "position": 1,
    "sku_id": "18057850264851626133510282"
  }
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/products/product_id/images/image_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal