VTEX · Schema

Field

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
FieldName string Attachment field name.
MaxCaracters string Maximum number of characters accepted in the attachment field.
DomainValues string Allowed key values.
View JSON Schema on GitHub

JSON Schema

vtex-field-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Field",
  "title": "Field",
  "required": [
    "FieldName",
    "MaxCaracters",
    "DomainValues"
  ],
  "type": "object",
  "properties": {
    "FieldName": {
      "type": "string",
      "description": "Attachment field name."
    },
    "MaxCaracters": {
      "type": "string",
      "description": "Maximum number of characters accepted in the attachment field."
    },
    "DomainValues": {
      "type": "string",
      "nullable": true,
      "description": "Allowed key values."
    }
  },
  "example": {
    "FieldName": "nome",
    "MaxCaracters": "20",
    "DomainValues": "Adalberto,Pedro,Jo\u00e3o"
  }
}