VTEX · Schema

ConfigExternalPriceSourceRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
active boolean Defines if the external price source is active (`true`) or not (`false`). If not set, the default value will be `false`.
appName string Name of the app that communicates with the external pricing source.
View JSON Schema on GitHub

JSON Schema

vtex-configexternalpricesourcerequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConfigExternalPriceSourceRequest",
  "title": "ConfigExternalPriceSourceRequest",
  "required": [
    "appName"
  ],
  "type": "object",
  "properties": {
    "active": {
      "type": "boolean",
      "example": false,
      "description": "Defines if the external price source is active (`true`) or not (`false`). If not set, the default value will be `false`."
    },
    "appName": {
      "type": "string",
      "description": "Name of the app that communicates with the external pricing source.",
      "example": "apiexamples_app_name"
    }
  }
}