VTEX · Schema

Image

Object containing SKU images details.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
ImageUrl string Image URL.
ImageName string Image label.
FileId integer SKU image ID.
View JSON Schema on GitHub

JSON Schema

vtex-image-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Image",
  "title": "Image",
  "required": [
    "ImageUrl",
    "ImageName",
    "FileId"
  ],
  "type": "object",
  "description": "Object containing SKU images details.",
  "properties": {
    "ImageUrl": {
      "type": "string",
      "description": "Image URL."
    },
    "ImageName": {
      "type": "string",
      "description": "Image label.",
      "nullable": true
    },
    "FileId": {
      "type": "integer",
      "format": "int32",
      "description": "SKU image ID."
    }
  },
  "example": {
    "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg",
    "ImageName": "",
    "FileId": 168952
  }
}