VTEX · Schema

SKUFileURL

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
IsMain	boolean	Defines if the image is the main image of the SKU.
Label	string	SKU image label.
Name	string	SKU image name.
Text	string	General text of the image.
Url	string	External image's URL. The URL must start with the protocol identifier (`http://` or `https://`) and end with the file extension (`.jpg`, `.png` or `.gif`).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SKUFileURL",
  "title": "SKUFileURL",
  "type": "object",
  "required": [
    "Name",
    "Url"
  ],
  "properties": {
    "IsMain": {
      "type": "boolean",
      "description": "Defines if the image is the main image of the SKU.",
      "example": true
    },
    "Label": {
      "type": "string",
      "description": "SKU image label.",
      "example": "Main"
    },
    "Name": {
      "type": "string",
      "description": "SKU image name.",
      "example": "Nike-Red-Janoski-1"
    },
    "Text": {
      "type": "string",
      "description": "General text of the image.",
      "example": "Nike-Red-Janoski",
      "nullable": true
    },
    "Url": {
      "type": "string",
      "description": "External image's URL.  The URL must start with the protocol identifier (`http://` or `https://`) and end with the file extension (`.jpg`, `.png` or `.gif`).",
      "example": "https://m.media-amazon.com/images/I/610G2-sJx5L._AC_UX695_.jpg"
    }
  }
}