VTEX · Schema

Sku

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
SkuId string SKU's unique identifier number
EanId string EAN's unique identifier number
RefId string SKU's Reference ID
NameComplete string Complete name of the SKU
Name string Summarized name of the SKU
IsActive boolean Whether the SKU is active in the sales channel (true), or not (false).
MainImage object Main image's information.
Offers array Array with offers
View JSON Schema on GitHub

JSON Schema

vtex-sku2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Sku2",
  "title": "Sku",
  "required": [
    "SkuId",
    "EanId",
    "RefId",
    "NameComplete",
    "Name",
    "IsActive",
    "MainImage",
    "Offers"
  ],
  "type": "object",
  "properties": {
    "SkuId": {
      "type": "string",
      "description": "SKU's unique identifier number",
      "default": "1070268"
    },
    "EanId": {
      "type": "string",
      "nullable": true,
      "description": "EAN's unique identifier number",
      "default": "768655"
    },
    "RefId": {
      "type": "string",
      "nullable": true,
      "description": "SKU's Reference ID",
      "default": "1234"
    },
    "NameComplete": {
      "type": "string",
      "description": "Complete name of the SKU",
      "default": "Name of the Product - 123 Color: Black"
    },
    "Name": {
      "type": "string",
      "description": "Summarized name of the SKU",
      "default": "Color: Black"
    },
    "IsActive": {
      "type": "boolean",
      "description": "Whether the SKU is active in the sales channel (true), or not (false).",
      "default": true
    },
    "MainImage": {
      "type": "object",
      "items": {
        "$ref": "#/components/schemas/MainImage"
      },
      "description": "Main image's information."
    },
    "Offers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Offer"
      },
      "description": "Array with offers"
    }
  },
  "example": {
    "SkuId": "1070268",
    "EanId": null,
    "RefId": null,
    "NameComplete": "Produto Teste 04 - Preto - 40 Cor:Preto",
    "Name": "Cor:Preto",
    "IsActive": true,
    "MainImage": {
      "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"
    },
    "Offers": [
      {
        "SellerId": "1",
        "SellerSkuId": "1070268",
        "OffersPerSalesChannel": [
          {
            "SaleChannel": 1,
            "Price": 0,
            "ListPrice": 0,
            "PriceWithoutDiscount": 0,
            "AvailableQuantity": 0
          }
        ],
        "AvailableSalesChannels": null
      },
      {
        "SellerId": "madesacms",
        "SellerSkuId": "3298",
        "OffersPerSalesChannel": [
          {
            "SaleChannel": 0,
            "Price": 1200,
            "ListPrice": 1200,
            "PriceWithoutDiscount": 1200,
            "AvailableQuantity": 10000000
          }
        ],
        "AvailableSalesChannels": null
      }
    ]
  }
}