VTEX · Schema

SKU

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
name	string
eans	array	SKU reference code.
refId	string	SKU reference code.
height	integer	Height of the SKU.
width	integer	Width of the SKU.
length	integer	Length of the SKU.
weight	integer	Weight of the SKU.
images	object
unitMultiplier	integer	Unit multiplier for this SKU. If this information doesn't apply, you should use the default value 1.
measurementUnit	string	Measurement unit that should be used for this SKU. If this information doesn't apply, you should use the default value un.
specifications	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Sku",
  "title": "SKU",
  "required": [
    "name",
    "eans",
    "refId",
    "height",
    "width",
    "length",
    "weight",
    "images",
    "unitMultiplier",
    "measurementUnit",
    "specifications"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "",
      "default": ""
    },
    "eans": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "SKU reference code.",
      "default": [
        "12345678901213"
      ],
      "nullable": true
    },
    "refId": {
      "type": "string",
      "description": "SKU reference code.",
      "default": "1234",
      "nullable": true
    },
    "height": {
      "type": "integer",
      "format": "int32",
      "description": "Height of the SKU.",
      "default": 10
    },
    "width": {
      "type": "integer",
      "format": "int32",
      "description": "Width of the SKU.",
      "default": 20
    },
    "length": {
      "type": "integer",
      "format": "int32",
      "description": "Length of the SKU.",
      "default": 10
    },
    "weight": {
      "type": "integer",
      "format": "int32",
      "description": "Weight of the SKU.",
      "default": 100
    },
    "images": {
      "$ref": "#/components/schemas/Images"
    },
    "unitMultiplier": {
      "type": "integer",
      "format": "int32",
      "description": "Unit multiplier for this SKU. If this information doesn't apply, you should use the default value 1.",
      "default": 1
    },
    "measurementUnit": {
      "type": "string",
      "description": "Measurement unit that should be used for this SKU. If this information doesn't apply, you should use the default value un.",
      "default": "un",
      "nullable": true
    },
    "specifications": {
      "$ref": "#/components/schemas/Specifications"
    }
  },
  "example": {
    "name": "Sku exemplo",
    "eans": [
      "12345678901213"
    ],
    "refId": null,
    "height": 1,
    "width": 1,
    "length": 1,
    "weight": 1,
    "images": [
      {
        "imagem1.jpg": "imageurl.example"
      }
    ],
    "unitMultiplier": 1,
    "measurementUnit": "un",
    "specifications": {
      "Embalagem": "3 kg"
    }
  }
}