VTEX · Schema

CustomApp

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string App's ID.
major integer Integer with the major version of the app. Optional, defaulting to one.
fields object
View JSON Schema on GitHub

JSON Schema

vtex-customapp-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomApp",
  "title": "CustomApp",
  "required": [
    "id",
    "major",
    "fields"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "id",
      "description": "App's ID.",
      "example": "ID"
    },
    "major": {
      "type": "integer",
      "title": "major",
      "description": "Integer with the major version of the app. Optional, defaulting to one.",
      "example": 1
    },
    "fields": {
      "$ref": "#/components/schemas/Fields"
    }
  },
  "example": {
    "id": "marketplace-integration",
    "major": 1,
    "fields": {
      "marketplacePaymentMethod": "credit card"
    }
  }
}