VTEX · Schema

AdditionalInfo

Additional information about the item.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
brandName	string	Item's brand name.
brandId	string	Item's brand ID.
categoriesIds	string	Item's category ID.
productClusterId	string	All product clusters related to the item.
commercialConditionId	string	Commercial conditions ID.
dimension	object
offeringInfo	string	Information about services related to the item. For example: guarantee or installation.
offeringType	string	Offering type.
offeringTypeId	string	Offering type ID.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AdditionalInfo",
  "title": "AdditionalInfo",
  "description": "Additional information about the item.",
  "required": [
    "brandName",
    "brandId",
    "categoriesIds",
    "productClusterId",
    "commercialConditionId",
    "dimension",
    "offeringInfo",
    "offeringType",
    "offeringTypeId"
  ],
  "type": "object",
  "properties": {
    "brandName": {
      "type": "string",
      "description": "Item's brand name."
    },
    "brandId": {
      "type": "string",
      "description": "Item's brand ID."
    },
    "categoriesIds": {
      "type": "string",
      "description": "Item's category ID."
    },
    "productClusterId": {
      "type": "string",
      "description": "All product clusters related to the item."
    },
    "commercialConditionId": {
      "type": "string",
      "description": "Commercial conditions ID."
    },
    "dimension": {
      "$ref": "#/components/schemas/Dimension"
    },
    "offeringInfo": {
      "type": "string",
      "nullable": true,
      "description": "Information about services related to the item. For example: guarantee or installation."
    },
    "offeringType": {
      "type": "string",
      "nullable": true,
      "description": "Offering type."
    },
    "offeringTypeId": {
      "type": "string",
      "nullable": true,
      "description": "Offering type ID."
    }
  },
  "example": {
    "brandName": "VTEX",
    "brandId": "2000023",
    "categoriesIds": "/1/",
    "productClusterId": "135,142",
    "commercialConditionId": "5",
    "dimension": {
      "cubicweight": 0.7031,
      "height": 15,
      "length": 15,
      "weight": 15,
      "width": 15
    },
    "offeringInfo": null,
    "offeringType": null,
    "offeringTypeId": null
  }
}