Skip to main content
This page describes the available services for validating user input as well as the rule-based checks for payment and shipping methods. The services are not classic configuration nodes with their own structure, but are referenced in the respective form or rule definitions (e.g. in account, checkout or payment / shipping configurations).

addressCheck.* - Address validations

addressCheck.* contains checks for address fields (e.g. name, street, postal code). The checks are stored in the respective field definitions under validations. The frontend shows the fields as configured and checks during input whether the entries are valid. This way, incorrect or invalid values are detected early. [Link]

addressCheck.minLength - Minimum length

Checks the minimum length of the input for address fields.

Example configuration for (accounts.addressField.firstName)

{
  "label": "",
  "name": "firstName",
  "validations": [
    {
      "options": {
        "len": 1
      },
      "service": "addressCheck.minLength"
    }
  ]
}

Parameter overview

ParameterDescription
lenDesired minimum length as a number.

addressCheck.maxLength - Maximum length

Checks the maximum length of the input for address fields.

Example configuration for (accounts.addressField.firstName)

{
  "label": "",
  "name": "firstName",
  "validations": [
    {
      "options": {
        "len": 255
      },
      "service": "addressCheck.maxLength"
    }
  ]
}

Parameter overview

ParameterDescription
lenDesired maximum length as a number.

addressCheck.numeric - Digits only

Checks whether the input for address fields consists only of digits.

Example configuration for (accounts.addressField.phone)

{
  "label": "",
  "name": "phone",
  "validations": [
    {
      "service": "addressCheck.numeric"
    }
  ]
}

Parameter overview

ParameterDescription
No additional parameters.

addressCheck.country - Country code (ISO)

Checks whether the input or selection in country lists of address fields is a country code configured in the shop (ISO code: 2-letter, 3-letter or ISO number). The official ISO-3166-1 codes (alpha-2, alpha-3 and numeric) can be found on the website of the International Organization for Standardization (ISO): https://www.iso.org/iso-3166-country-codes.html

Example configuration for (accounts.addressField.country)

{
  "label": "",
  "name": "country",
  "validations": [
    {
      "service": "addressCheck.country"
    }
  ]
}

Parameter overview

ParameterDescription
No additional parameters.

addressCheck.zip - Postal code

Checks whether the input is a valid postal code for the specified country. The postal code rules come from the configuration. The corresponding country must be supplied in the country field.

Example configuration for (accounts.addressField.country)

{
  "label": "",
  "name": "zip",
  "validations": [
    {
      "service": "addressCheck.zip"
    }
  ]
}

Parameter overview

ParameterDescription
No additional parameters.

addressCheck.salutation - Salutation (code)

Checks whether the input is a valid salutation (code according to the configuration).

Example configuration for (accounts.addressField.salutationCode)

{
  "label": "",
  "name": "salutationCode",
  "validations": [
    {
      "service": "addressCheck.salutation"
    }
  ]
}

Parameter overview

ParameterDescription
No additional parameters.

addressCheck.regex - Regular expression

Checks whether the input matches a regular expression.

Example configuration for (accounts.addressField.additionalInfo)

{
  "label": "",
  "name": "additionalInfo",
  "validations": [
    {
      "options": {
        "expression": "^((?i)(?!Postfach).)*$"
      },
      "service": "addressCheck.regex"
    }
  ]
}

Parameter overview

ParameterDescription
expressionRegular expression (string).

addressCheck.phone - Phone number

Checks whether the input is a valid phone number. A valid number consists of digits (without length restriction) and optionally an international dialling code. The + in the dialling code is replaced by 00 after successful validation.

Example configuration for (accounts.addressField.phone)

{
  "label": "",
  "name": "phone",
  "validations": [
    {
      "service": "addressCheck.phone"
    }
  ]
}

Parameter overview

ParameterDescription
No additional parameters.

addressCheck.alpha - Letters only (A–Z)

Checks whether the input consists only of Latin letters (case-insensitive).

Example configuration for (accounts.addressField.additionalInfo)

{
  "label": "",
  "name": "additionalInfo",
  "validations": [
    { "service": "addressCheck.alpha" }
  ]
}

Parameter overview

ParameterDescription
No additional parameters.

addressCheck.alphanum - Letters / digits (A–Z / 0–9)

Checks whether the input consists only of Latin letters or digits (case-insensitive).

Example configuration for (accounts.addressField.additionalInfo)

{
  "label": "",
  "name": "additionalInfo",
  "validations": [
    { "service": "addressCheck.alphanum" }
  ]
}

Parameter overview

ParameterDescription
No additional parameters.

addressCheck.legalSigns - Allowed characters

Checks whether all characters of the input are contained in the allowed character set (case-sensitive).

Example configuration for (accounts.addressField.additionalInfo)

{
  "label": "",
  "name": "additionalInfo",
  "validations": [
    { 
      "options": {
        "signs": "123456ABCSDEF"
      },
      "service": "addressCheck.legalSigns" 
    }
  ]
}

Parameter overview

ParameterDescription
signsAllowed characters (string).

addressCheck.illegalSigns - Forbidden characters

Opposite of legalSigns: the input must not contain any of the specified characters.

Example configuration for (accounts.addressField.phone)

{
  "label": "",
  "name": "phone",
  "validations": [
    { 
      "options": {
        "signs": ""*|~%${};"<>§@ \t()/-_" #*|~%${}\t;"<>@§"
      },
      "service": "addressCheck.illegalSigns" 
    }
  ]
}

Parameter overview

ParameterDescription
signsForbidden characters (string).

addressCheck.date - Date

Checks whether the input is a valid date and formats the input if necessary.

Example configuration for (accounts.addressField.additionalInfo)

{
  "label": "",
  "name": "additionalInfo",
  "validations": [
    { 
      "options": {
        "delimeter": -
        "dateformat": DMY
        "formatleadingzero": false
      },
      "service": "addressCheck.legalSigns" 
    }
  ]
}

Parameter overview

ParameterDescription
delimiterSeparator between day / month / year (e.g. - for 15-10-2025).
dateformatAny combination of D, M, Y (e.g. DMY for 15-10-2025).
formatleadingzeroIf active (true), days/months are formatted with two digits (5 → 05).
If disabled (false), leading zeros are removed (05 → 5). (Boolean)

addressCheck.allowedSelection - Selection (list element)

Validates whether the input matches a predefined selection value. To do so, the dataId of a configuration from general.addressListElements is supplied. Typical use: checking whether an address is, for example, “packing station” or “private address”.

Example configuration for (accounts.addressField.additionalInfo)

{
  "label": "",
  "name": "addressType"
  "validations": [
    {
      "options": {
        "listElements": "general.addressListElements.addressType"
      },
      "service": "addressCheck.allowedSelection"
    }
  ]
}

Parameter overview

ParameterDescription
listElementsdataId of a definition from general.addressListElements.

dataChecker.* - General field validations

dataChecker.* contains checks for general form fields that do not specifically belong to an address. The checks are integrated in the respective field definition under validations. The frontend takes over the specifications from the field definition and checks during input whether the entry is correct (e.g. length, format or forbidden characters). [Link]

dataChecker.minLength - Minimum length

Checks the minimum length of the input for form fields.

Example configuration for (inquiry.form.catalogue.fields.firstName)

  {
    "label": "Vorname",
    "name": "firstName",
    "required": true,
    "validations": [
    { "options": { "len": 3 }, "service": "dataChecker.minLength" }
    ]
  }

Parameter overview

ParameterDescription
lenDesired minimum length as a number.

dataChecker.maxLength - Maximum length

Checks the maximum length of the input for form fields.

Example configuration for (inquiry.form.catalogue.fields.firstName)

{
    "label": "Vorname",
    "name": "firstName",
    "required": true,
    "validations": [
    { "options": { "len": 255 }, "service": "dataChecker.maxLength" }
    ]
}

Parameter overview

ParameterDescription
lenDesired maximum length as a number.

dataChecker.numeric - Digits only

Checks whether the input in form fields consists only of digits.

Example configuration for (inquiry.form.catalogue.fields.phone)

  {
    "label": "Telefon",
    "name": "phone",
    "validations": [
    { "service": "dataChecker.numeric" }
    ]
  }

Parameter overview

ParameterDescription
No additional parameters.

dataChecker.country - Country code (ISO)

Checks whether the input or selection in country lists of form fields is a country code configured in the shop (ISO code: 2-letter, 3-letter or ISO number). The official ISO-3166-1 codes (alpha-2, alpha-3 and numeric) can be found on the website of the International Organization for Standardization (ISO): https://www.iso.org/iso-3166-country-codes.html

Example configuration for (inquiry.form.catalogue.fields.country)

  {
    "label": "Land",
    "name": "country",
    "validations": [
    { "service": "dataChecker.country" }
    ]
  }

Parameter overview

ParameterDescription
No additional parameters.

dataChecker.zip - Postal code

Checks whether the input is a valid postal code for the specified country. The postal code rules come from the configuration. The corresponding country must be supplied in the country field.

Example configuration for (inquiry.form.catalogue.fields.zip)

  {
    "label": "Postleitzahl",
    "name": "zip",
    "validations": [
    { "service": "dataChecker.zip" }
    ]
  }

Parameter overview

ParameterDescription
No additional parameters.
(For country-specific check, the country field must be available in the context.)

dataChecker.salutation - Salutation (code)

Checks whether the input is a valid salutation (code according to the configuration).

Example configuration for (inquiry.form.catalogue.fields.salutation)

  {
    "label": "Anrede",
    "name": "salutation",
    "validations": [
    { "service": "dataChecker.salutation" }
    ]
  }

Parameter overview

ParameterDescription
No additional parameters.

dataChecker.regex - Regular expression

Checks whether the input matches a regular expression.

Example configuration for (inquiry.form.catalogue.fields.additionalInfo)

  {
    "label": "Zusatzinformation",
    "name": "additionalInfo",
    "validations": [
    {
      "options": {
        "expression": "^((?i)(?!Postfach).)*$"
      },
      "service": "dataChecker.regex"
    }
  ]
  }

Parameter overview

ParameterDescription
expressionRegular expression (string).

dataChecker.email - Email address

Checks whether the input is a valid email address.

Example configuration for (inquiry.form.catalogue.fields.mail)

  {
    "label": "E-Mail-Adresse",
    "name": "mail",
    "validations": [
    { "service": "dataChecker.email" }
  ]
  }

Parameter overview

ParameterDescription
No additional parameters.

dataChecker.alphaClass - Letters (min / distinct)

Ensures that the input contains at least minChars Latin letters (case-insensitive); optionally a minimum number of distinct letters.

Example configuration for (inquiry.form.catalogue.fields.additionalInfo)

{
    "label": "Zusatzinformation",
    "name": "additionalInfo",
    "required": true,
    "validations": [
      { "options": 
        { 
          "minChars": 8,
          "minDifferentChars": 2
          
        },
        "service": "dataChecker.alphaClass" 
      }
    ]
}

Parameter overview

ParameterDescription
minCharsMinimum number of letters (number ≥ 0).
minDifferentCharsMinimum number of distinct letters (number ≥ 0).

dataChecker.lowerAlphaClass - Lowercase letters

Like alphaClass, but only lowercase letters.

Example configuration for (inquiry.form.catalogue.fields.additionalInfo)

{
    "label": "Zusatzinformation",
    "name": "additionalInfo",
    "required": true,
    "validations": [
      { "options": 
        { 
          "minChars": 8,
          "minDifferentChars": 2
          
        },
        "service": "dataChecker.lowerAlphaClass" 
      }
    ]
}

Parameter overview

ParameterDescription
minCharsMinimum number of lowercase letters (number ≥ 0).
minDifferentCharsMinimum number of distinct lowercase letters (number ≥ 0).

dataChecker.upperAlphaClass - Uppercase letters

Like alphaClass, but only uppercase letters.

Example configuration for (inquiry.form.catalogue.fields.additionalInfo)

{
    "label": "Zusatzinformation",
    "name": "additionalInfo",
    "required": true,
    "validations": [
      { "options": 
        { 
          "minChars": 8,
          "minDifferentChars": 2
          
        },
        "service": "dataChecker.upperAlphaClass" 
      }
    ]
}

Parameter overview

ParameterDescription
minCharsMinimum number of uppercase letters (number ≥ 0).
minDifferentCharsMinimum number of distinct uppercase letters (number ≥ 0).

dataChecker.digitClass - Digits

Like alphaClass, but for digits.

Example configuration for (inquiry.form.catalogue.fields.additionalInfo)

{
    "label": "Zusatzinformation",
    "name": "additionalInfo",
    "required": true,
    "validations": [
      { "options": 
        { 
          "minChars": 4,
          "minDifferentChars": 2
          
        },
        "service": "dataChecker.digitClass" 
      }
    ]
}

Parameter overview

ParameterDescription
minCharsMinimum number of digits (number ≥ 0).
minDifferentCharsMinimum number of distinct digits (number ≥ 0).

dataChecker.specialClass - Special characters

Like alphaClass, but for special characters.

Example configuration for (inquiry.form.catalogue.fields.additionalInfo)

{
    "label": "Zusatzinformation",
    "name": "additionalInfo",
    "required": true,
    "validations": [
      { "options": 
        { 
          "minChars": 2,
          "minDifferentChars": 1
          
        },
        "service": "dataChecker.specialClass" 
      }
    ]
}

Parameter overview

ParameterDescription
minCharsMinimum number of special characters (number ≥ 0).
minDifferentCharsMinimum number of distinct special characters (number ≥ 0).

dataChecker.sequenceOfIdenticalCharacters - Repeated characters (sequence)

Checks whether the same character appears too often in a row.

Example configuration for (inquiry.form.catalogue.fields.additionalInfo)

{
    "label": "Zusatzinformation",
    "name": "additionalInfo",
    "required": true,
    "validations": [
      { "options": 
        { 
          "caseInsensitive": false,
          "maxSequence": 2
          
        },
        "service": "dataChecker.sequenceOfIdenticalCharacters" 
      }
    ]
}

Parameter overview

ParameterDescription
caseInsensitiveIgnore case (boolean).
maxSequenceMaximum allowed repetition of a character (number ≥ 0).

dataChecker.consecutiveNumbers - Consecutive numbers

Checks for ascending or descending number chains (e.g. 12345 or 54321).

Example configuration for (inquiry.form.catalogue.fields.additionalInfo)

{
    "label": "Zusatzinformation",
    "name": "additionalInfo",
    "required": true,
    "validations": [
      { "options": 
        { 
          "maxConsecutive": 2
        },
        "service": "dataChecker.consecutiveNumbers" 
      }
    ]
}

Parameter overview

ParameterDescription
maxConsecutiveMaximum length of the number chain (number ≥ 0).

dataChecker.consecutiveLetters - Consecutive letters

Checks for ascending or descending letter combinations (e.g. abcd or dcba).

Example configuration for (inquiry.form.catalogue.fields.additionalInfo)

{
    "label": "Zusatzinformation",
    "name": "additionalInfo",
    "required": true,
    "validations": [
      { "options": 
        { 
          "maxConsecutive": 2,
          "caseInsensitive": false
        },
        "service": "dataChecker.consecutiveLetters" 
      }
    ]
}

Parameter overview

ParameterDescription
maxConsecutiveMaximum length of the letter chain (number ≥ 0).
caseInsensitiveIgnore case (boolean).

dataChecker.palindrome - Palindrome

Checks whether the input is a palindrome (identical forwards / backwards, e.g. “Otto”).

Example configuration for (inquiry.form.catalogue.fields.additionalInfo)

{
    "label": "Zusatzinformation",
    "name": "additionalInfo",
    "required": true,
    "validations": [
      { "options": 
        { 
          "caseInsensitive": false
        },
        "service": "dataChecker.palindrome" 
      }
    ]
}

Parameter overview

ParameterDescription
caseInsensitiveIgnore case (boolean).

paymentValidation.* - Payment method validation

paymentValidation.* contains rules that define whether a payment method is allowed in the checkout. The check can depend, for example, on the country of the billing or delivery address, on the customer type, on the basket or on the order value. These rules can be entered in the configuration of the respective payment method under validations. The frontend then only shows matching payment methods or prevents the selection if the conditions are not met. The associated configuration node is payment: payment - Payment methods

paymentValidation.billCountry - Validation of the country (billing address) for payment methods

Checks whether the country of the billing address is permitted according to an “allow/deny” list for a payment method. The options define which countries the rule applies to and whether this list allows or forbids countries. Example configuration
"validations": [
  {
    "options": {
      "countryList": [
        "general.country.de",
        "general.country.at",
        "general.country.ch"
      ],
      "rule": "allow"
    },
    "service": "paymentValidation.billCountry"
  }
]
Parameter overview
ParameterDescription
countryListList of countries to which this rule should be applied.
(ISO country identifiers, e.g. “DE”, “AT”, “CH”.)
ruleRule control.
Possible values:
- allow — countries in countryList are allowed.
- deny — countries in countryList are not allowed.

paymentValidation.billPhone - Phone number validation

Checks whether a phone number is supplied for the billing address (the field must not be empty). Example configuration:
"validations": [
  {
    "service": "paymentValidation.billPhone"
  }
]
There are no parameters for this service.

paymentValidation.billDateOfBirth - Date of birth validation

Checks whether a date of birth is supplied for the billing address (the field must not be empty). Example configuration
"validations": [
  {
    "service": "paymentValidation.billDateOfBirth"
  }
]
There are no parameters for this service.

paymentValidation.shippingCountry - Validation of the country (delivery address)

Checks whether the country of the delivery address is permitted according to an “allow/deny” list. The options define which countries the rule applies to and whether this list allows or forbids countries. Example configuration
"validations": [
  {
    "options": {
      "countryList": [
        "general.country.gb"
      ],
      "rule": "deny"
    },
    "service": "paymentValidation.shippingCountry"
  }
]
Parameter overview
ParameterDescription
countryListList of countries to which this rule should be applied.
(ISO country identifiers, e.g. “DE”, “AT”, “CH”.)
ruleRule control.
Possible values:
- allow — countries in countryList are allowed.
- deny — countries in countryList are not allowed.

paymentValidation.shippingMethod - Validation of the shipping method for payment methods

Checks whether the chosen payment method may only be used with certain shipping methods. Example configuration
"validations": [
  {
    "options": {
      "shippingMethods": [
        "shipping.method.dhl",
        "shipping.method.pickup"
      ],
      "rule": "allow"
    },
    "service": "paymentValidation.shippingMethod"
  }
]
Parameter overview
ParameterDescription
shippingMethodsList of shipping method IDs to which this rule should be applied.
The IDs correspond to the internal names of the shipping methods (e.g. shipping.method.dhl).
ruleRule control.
Possible values:
- allow — shipping methods in shippingMethods are allowed.
- deny — shipping methods in shippingMethods are not allowed.

paymentValidation.accountType - Validation of the customer type for payment methods

Checks whether the chosen payment method may only be used for certain customer types (guest, new customer or existing customer). Example configuration
"validations": [
  {
    "options": {
      "deny": [
        "guest",
        "newCustomer"
      ]
    },
    "service": "paymentValidation.accountType"
  }
]
Parameter overview
ParameterDescription
denyList of customer types for which the payment method is blocked.
Possible values:
- “guest” — guest orderer.
- “newCustomer” — new customer.
- “customer” — existing customer.

paymentValidation.denyDifferingShippingAddress - Validation of differing delivery addresses for payment methods

Checks whether the billing address and delivery address are identical.
The payment method is only allowed if no differing delivery address is used.
Example configuration
"validations": [
  {
    "service": "paymentValidation.denyDifferingShippingAddress"
  }
]
Parameter overview
ParameterDescription
No additional parameters.

paymentValidation.voucherDeny - Validation of voucher products for payment methods

Checks whether voucher products are in the basket. If voucher products are in the basket, this payment method is not allowed. Example configuration
"validations": [
  {
    "service": "paymentValidation.voucherDeny"
  }
]
Parameter overview
ParameterDescription
No additional parameters.

paymentValidation.total - Validation of minimum / maximum order value for payment methods

Checks whether the payment method may only be used if a certain minimum or maximum order value is reached or exceeded. Example configuration
"validations": [
  {
    "options": {
      "total": 600,
      "type": "max"
    },
    "service": "paymentValidation.total"
  }
]
Parameter overview
ParameterDescription
totalThreshold of the total (goods value) from / up to which the payment method is allowed.
typeType of check.
Possible values:
- “min” — the payment method is only allowed if the order value reaches at least total.
- “max” — the payment method is only allowed if the order value does not exceed total.
If a minimum and maximum order value should be checked at the same time, this check must be configured twice with different options.

paymentValidation.inventoryState - Validation of the stock state for payment methods

Checks whether products with a specific stock state are in the basket. If a product in the basket has a status configured in deny, the payment method is not allowed. Example configuration
"validations": [
  {
    "options": {
      "deny": [
        "red",
        "yellow"
      ]
    },
    "service": "paymentValidation.inventoryState"
  }
]
Parameter overview:
ParameterDescription
denyList of stock states for which the payment method is forbidden.
Possible values:
- “red” — sold out.
- “yellow” — only a few available.
- “green” — many available.
The thresholds of the individual stock states are defined in content.inventory: content - Catalogue (categories & products)

paymentValidation.productDependency - Validation of product dependencies for payment methods

Checks the products in the basket based on the configuration checkout.productDependency.
A payment method is only offered if all referenced product dependencies are met.
This way, you tie a payment method to basket characteristics without duplicating the check logic. The actual conditions (product fields, free fields, value comparisons) are maintained centrally in checkout.productDependency. Example configuration
The option “Buy on invoice” should be blocked as soon as a personalised product (e.g. with engraving) is in the basket. Because personalised items cannot be returned, they carry a higher payment default risk. You define the condition “no engraving in the basket” in checkout.productDependency and then reference it here.
"validations": [
  {
    "options": {
      "list": [
        "checkout.productDependency.noEngraving"
      ]
    },
    "service": "paymentValidation.productDependency"
  }
]
Parameter overview
ParameterDescription
listList of IDs of the configurations from checkout.productDependency to be checked.
For the validation to succeed and the payment method to be offered, all values specified here must be satisfied.

paymentValidation.userAgent - Validation of the user agent for payment methods

Checks whether a payment method is shown depending on the customer’s device or browser. Devices and browsers automatically transmit a technical identifier when a page is requested — the so-called user agent. Based on this identifier you can, for example, detect whether someone is using an iPhone, an iPad or a Mac. The terms entered in userAgents are checked against this identifier; a single match is sufficient. This way, a payment method can be specifically enabled or blocked for certain devices or browsers, for example if Apple Pay should only be shown to customers using an Apple device or a compatible browser. Example configuration
"validations": [
  {
    "options": {
      "userAgents": [
        "Macintosh",
        "Mac OS X",
        "iPhone",
        "iPad"
      ],
      "rule": "allow"
    },
    "service": "paymentValidation.userAgent"
  }
]
Parameter overview
ParameterDescription
userAgentsList of terms that are searched for in the customer’s device / browser identifier.
A single match is sufficient.
The values are not predefined by WEBSALE but correspond to the actual strings transmitted by the device or browser.
The correct values must be determined on the respective device, for example via the browser console.
ruleRule control.
Possible values:
- allow — the payment method is shown only if at least one term from userAgents is detected.
- deny — the payment method is hidden if a match is found.

shippingMethodValidation.* - Shipping method validation

shippingMethodValidation.* contains rules that define whether a shipping method is allowed in the checkout. The check can depend, for example, on the delivery country, the goods value, product types or the chosen payment method. These rules can be entered in the configuration of the respective shipping method under validations. The frontend then only provides shipping methods that match the current conditions.

shippingMethodValidation.shippingCountry - Validation of the country (billing address)

Checks whether the country of the billing address is permitted according to an “allow/deny” list. The options define which countries the rule applies to and whether this list allows or forbids countries. Example configuration
"validations": [
  {
    "options": {
      "countryList": [
        "general.country.de",
        "general.country.at"
      ],
      "rule": "allow"
    },
    "service": "shippingMethodValidation.shippingCountry"
  }
]
Parameter overview
ParameterDescription
countryListList of countries to which this rule should be applied.
(ISO country identifiers, e.g. “DE”, “AT”, “CH”.)
ruleRule control.
Possible values:
- allow — countries in countryList are allowed.
- deny — countries in countryList are not allowed.

shippingMethodValidation.paymentMethod - Validation of the shipping method for payment methods

Checks whether a shipping method may only be used with certain payment methods. Example configuration
"validations": [
  {
    "options": {
      "paymentMethods": [
        "payment.method.invoice",
        "payment.method.prepayment"
      ],
      "rule": "allow"
    },
    "service": "shippingMethodValidation.paymentMethod"
  }
]
Parameter overview
ParameterDescription
paymentMethodsList of payment method IDs to which this rule should be applied.
The IDs correspond to the internal names of the payment methods (e.g. payment.method.invoice).
ruleRule control.
Possible values:
- allow — payment methods in paymentMethods are allowed.
- deny — payment methods in paymentMethods are not allowed.

shippingMethodValidation.valueOfGoods - Validation of minimum / maximum order value for shipping methods

Checks whether the shipping method may only be used if a certain minimum or maximum order value is reached or exceeded. Example configuration
"validations": [
  {
    "options": {
      "valueOfGoods": 100,
      "type": "min"
    },
    "service": "shippingMethodValidation.valueOfGoods"
  }
]
Parameter overview
ParameterDescription
valueOfGoodsThreshold of the total (goods value) from / up to which the shipping method is allowed.
typeType of check.
Possible values:
- “min” — the payment method is only allowed if the order value reaches at least total.
- “max” — the payment method is only allowed if the order value does not exceed total.

shippingMethodValidation.productType - Validation of the product type for shipping methods

Checks whether all products in the basket have a matching product type. Example configuration
"validations": [
  {
    "options": {
      "rule": "allow",
      "ruleList": [
        "productType.digital"
      ],
      "includeList": [
        "productType.service"
      ]
    },
    "service": "shippingMethodValidation.productType"
  }
]
Parameter overview
ParameterDescription
ruleType of check.
Possible values:
- “allow” — only product types from ruleList and includeList are allowed.
- “deny” — product types from ruleList are not allowed. Exception: product types from includeList are always allowed.
ruleListList of product types that — depending on rule — are allowed or not allowed.
includeListList of product types that are always allowed.

shippingMethodValidation.productDependency - Validation of product dependencies for shipping methods

Checks the products in the basket based on the configuration checkout.productDependency. Example configuration
"validations": [
  {
    "options": {
      "list": [
        "checkout.productDependency.digitalOnly",
        "checkout.productDependency.noBulkyGoods"
      ]
    },
    "service": "shippingMethodValidation.productDependency"
  }
]
Parameter overview
ParameterDescription
listList of IDs of the configurations from checkout.productDependency to be checked.
For the validation to succeed, all values specified here must be satisfied.

shippingMethodValidation.expressCheckout - Validation of the express checkout for shipping methods

Checks whether a shipping method is allowed in the express checkout depending on the chosen payment method. If the express checkout is not active, the shipping method is always allowed. Example configuration
"validations": [
  {
    "options": {
      "rule": "allow",
      "ruleList": [
        "payment.method.paypal",
        "payment.method.creditcard"
      ]
    },
    "service": "shippingMethodValidation.expressCheckout"
  }
]
Parameter overview
ParameterDescription
ruleType of check.
Possible values:
- “allow” — only payment methods from ruleList are allowed in the express checkout.
- “deny” — payment methods from ruleList are not allowed in the express checkout.
ruleListList of payment method IDs that — depending on rule — are allowed or forbidden in the express checkout.
The IDs correspond to the internal names of the payment methods (e.g. payment.method.paypal).