Image

🔒

Requires product access scope.

Product Image Support

The system currently supports a variety of common image formats, including but not limited to the following types:

  • JPEG (.jpg)
  • JPEG 2000 (.jp2)
  • PNG (.png)
  • WebP (.webp)
  • GIF (.gif)

Precautions

  1. External Image Link Processing
    • If the image link provided is an external link, Shoplazza will automatically transcode and save the image to its library to ensure availability and loading speed.
    • Please ensure that the external links you provide are valid and that the image content complies with relevant laws, regulations, and platform policies.
  2. OpenAPI Upload Limitations
    • At present, OpenAPI does not support the direct upload of local files to the system when uploading images.
    • To upload images via OpenAPI, you will need to first upload the images to a publicly accessible online location and then provide the corresponding external link.
    • Please note that uploading images using external links may be subject to the stability and availability of third-party services.

Image Properties

FieldsTypeDesc
idstringThe ID of the image.
positionintegerThe position of the image.
srcstringThe relative URL of the image.
pathstringThe filename of the image.
widthnumberThe width of the image in pixels.
heightnumberThe height of the image in pixels.
altstringThe alt text of the image.
created_atstringCreation time, formatted as ISO-8601
updated_atstringLast modification time, formatted as ISO-8601

Example

{
  "id": "91d032e7-bbc8-47e4-8668-9ba6fe714de6",
  "position": 1,
  "src": "//cdn.shoplazza.com/efd33b921cacd5311a32dd03a9bc8740.png",
  "width": 1588,
  "height": 2246,
  "alt": "",
  "created_at": "2024-04-08T07:13:28Z",
  "updated_at": "2024-04-08T07:13:28Z"
}