VTEX · Schema

MainImage

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
ImageId	string	Code identifying the image's file.
ImageLabel	string	Image's label.
ImageTag	string	HTML tag for the selected image.
ImagePath	string	Path for the image's file.
IsMain	boolean	Whether the image is the main one or not.
IsZoomSize	boolean	If zoom can be applied to the image.
ImageText	string	Alt text for the image.
LastModified	string	Date of the last changed made to the offer.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MainImage",
  "title": "MainImage",
  "required": [
    "ImageId",
    "ImageLabel",
    "ImageTag",
    "ImagePath",
    "IsMain",
    "IsZoomSize",
    "ImageText",
    "LastModified"
  ],
  "type": "object",
  "properties": {
    "ImageId": {
      "type": "string",
      "description": "Code identifying the image's file.",
      "default": "53878805"
    },
    "ImageLabel": {
      "type": "string",
      "nullable": true,
      "description": "Image's label.",
      "default": "Image 1"
    },
    "ImageTag": {
      "type": "string",
      "description": "HTML tag for the selected image.",
      "default": "<img src=\"~/archives/ids/155411-#width#-#height#/Webp.net-resizeimage.jpg\" width=\"#width#\" height=\"#height#\" alt=\"Image name and description\" id=\"\" />"
    },
    "ImagePath": {
      "type": "string",
      "description": "Path for the image's file.",
      "default": "~/archives/ids/155411-#width#-#height#/Webp.net-resizeimage.jpg"
    },
    "IsMain": {
      "type": "boolean",
      "description": "Whether the image is the main one or not.",
      "default": true
    },
    "IsZoomSize": {
      "type": "boolean",
      "description": "If zoom can be applied to the image.",
      "default": true
    },
    "ImageText": {
      "type": "string",
      "description": "Alt text for the image.",
      "default": "Image name and description"
    },
    "LastModified": {
      "type": "string",
      "description": "Date of the last changed made to the offer.",
      "default": "2021-05-06T21:37:24.262529"
    }
  },
  "example": {
    "ImageId": "53878805",
    "ImageLabel": null,
    "ImageTag": "<img src=\"~/arquivos/ids/53878805-#width#-#height#/image-8b4364782e664d76a6ebc8702008e478.jpg\" width=\"#width#\" height=\"#height#\" alt=\"image-8b4364782e664d76a6ebc8702008e478\" id=\"\" />",
    "ImagePath": "~/arquivos/ids/53878805-#width#-#height#/image-8b4364782e664d76a6ebc8702008e478.jpg",
    "IsMain": true,
    "IsZoomSize": true,
    "ImageText": "image-8b4364782e664d76a6ebc8702008e478",
    "LastModified": "2021-04-06T03:01:30.747"
  }
}