VTEX · Schema

CustomData

Structure with the order's customizable fields. To insert custom fields in the order, you must first go through the process of [Creating an app](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-app-template), and then adding the app, as well as the desired fields, within the seller's `orderForm`. More information on [Creating customizable fields in the cart with Checkout API](https://developers.vtex.com/vtex-rest-api/docs/customizable-fields-with-checkout-api).

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
customApps array Array of objects with information about custom apps.
View JSON Schema on GitHub

JSON Schema

vtex-customdata-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomData",
  "title": "CustomData",
  "description": "Structure with the order's customizable fields. To insert custom fields in the order, you must first go through the process of [Creating an app](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-app-template), and then adding the app, as well as the desired fields, within the seller's `orderForm`. More information on [Creating customizable fields in the cart with Checkout API](https://developers.vtex.com/vtex-rest-api/docs/customizable-fields-with-checkout-api).",
  "required": [
    "customApps"
  ],
  "type": "object",
  "properties": {
    "customApps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomApp"
      },
      "description": "Array of objects with information about custom apps."
    }
  },
  "example": {
    "customApps": [
      {
        "id": "marketplace-integration",
        "major": 1,
        "fields": {
          "marketplacePaymentMethod": "credit card"
        }
      }
    ]
  }
}