VTEX · Schema

ProductSpecification

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
FieldId integer Specification field ID.
FieldName string Specification name. Limited to 100 characters.
FieldValueIds array Array with related specification values IDs.
FieldValues array Array with related specification values.
View JSON Schema on GitHub

JSON Schema

vtex-productspecification-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ProductSpecification",
  "title": "ProductSpecification",
  "required": [
    "FieldId",
    "FieldName",
    "FieldValueIds",
    "FieldValues"
  ],
  "type": "object",
  "properties": {
    "FieldId": {
      "type": "integer",
      "format": "int32",
      "description": "Specification field ID."
    },
    "FieldName": {
      "type": "string",
      "description": "Specification name. Limited to 100 characters."
    },
    "FieldValueIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32",
        "description": "Specification value ID."
      },
      "description": "Array with related specification values IDs."
    },
    "FieldValues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array with related specification values."
    }
  },
  "example": {
    "FieldId": 7,
    "FieldName": "Faixa Et\u00e1ria",
    "FieldValueIds": [
      58,
      56,
      55,
      52
    ],
    "FieldValues": [
      "5 a 6 anos",
      "7 a 8 anos",
      "9 a 10 anos",
      "Acima de 10 anos"
    ]
  }
}