VTEX · Schema

Attachment

Object containing information about SKU attachments.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
Id	integer	Attachment ID.
Name	string	Attachment Name.
Keys	array	Attachment Keys.
Fields	array	Array containing Attachment fields.
IsActive	boolean	Defines if the Attachment is active or not.
IsRequired	boolean	Defines if the Attachment is required or not.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Attachment",
  "title": "Attachment",
  "required": [
    "Id",
    "Name",
    "Keys",
    "Fields",
    "IsActive",
    "IsRequired"
  ],
  "type": "object",
  "description": "Object containing information about SKU attachments.",
  "properties": {
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "Attachment ID."
    },
    "Name": {
      "type": "string",
      "description": "Attachment Name."
    },
    "Keys": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Attachment Keys."
    },
    "Fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Field"
      },
      "description": "Array containing Attachment fields."
    },
    "IsActive": {
      "type": "boolean",
      "description": "Defines if the Attachment is active or not."
    },
    "IsRequired": {
      "type": "boolean",
      "description": "Defines if the Attachment is required or not."
    }
  },
  "example": {
    "Id": 3,
    "Name": "Mensagem",
    "Keys": [
      "nome;20",
      "foto;40"
    ],
    "Fields": [
      {
        "FieldName": "nome",
        "MaxCaracters": "20",
        "DomainValues": "Adalberto,Pedro,Jo\u00e3o"
      },
      {
        "FieldName": "foto",
        "MaxCaracters": "40",
        "DomainValues": null
      }
    ],
    "IsActive": true,
    "IsRequired": false
  }
}