VTEX · Schema

AdditionalInfoV2

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
dimension	string	Replacing tem's dimensions in the measure unit configured in the catalog.
brandName	string	Replacing item's brand name.
brandId	string	Replacing item's brand ID.
offeringInfo	string	Offering information.
offeringType	string	Offering type.
offeringTypeId	string	Offering type ID.
categoriesIds	string	ID of the replacing item product category.
productClusterId	string	All product clusters related to the replacing item.
commercialConditionId	string	Replacing item commercial conditions ID.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AdditionalInfoV2",
  "title": "AdditionalInfoV2",
  "required": [
    "dimension",
    "brandName",
    "brandId",
    "offeringInfo",
    "offeringType",
    "offeringTypeId",
    "categoriesIds",
    "productClusterId",
    "commercialConditionId"
  ],
  "type": "object",
  "properties": {
    "dimension": {
      "type": "string",
      "nullable": true,
      "description": "Replacing tem's dimensions in the measure unit configured in the catalog.",
      "example": null
    },
    "brandName": {
      "type": "string",
      "nullable": true,
      "description": "Replacing item's brand name.",
      "example": "Special coffee cup"
    },
    "brandId": {
      "type": "string",
      "nullable": true,
      "description": "Replacing item's brand ID.",
      "example": "2000001"
    },
    "offeringInfo": {
      "type": "string",
      "nullable": true,
      "description": "Offering information.",
      "example": null
    },
    "offeringType": {
      "type": "string",
      "nullable": true,
      "description": "Offering type.",
      "example": null
    },
    "offeringTypeId": {
      "type": "string",
      "nullable": true,
      "description": "Offering type ID.",
      "example": null
    },
    "categoriesIds": {
      "type": "string",
      "nullable": true,
      "description": "ID of the replacing item product category.",
      "example": null
    },
    "productClusterId": {
      "type": "string",
      "nullable": true,
      "description": "All product clusters related to the replacing item.",
      "example": "135,137,143,518,1272"
    },
    "commercialConditionId": {
      "type": "string",
      "nullable": true,
      "description": "Replacing item commercial conditions ID.",
      "example": "5"
    }
  },
  "example": {
    "dimension": null,
    "brandName": null,
    "brandId": null,
    "offeringInfo": null,
    "offeringType": null,
    "offeringTypeId": null,
    "categoriesIds": null,
    "productClusterId": null,
    "commercialConditionId": null
  }
}