Configuration

Cart Validators

The cart validator posts a cart to a provided endpoint and adds any validation errors to the GUI or API when the cart is validated. The validation process involves all configured IValidator instances and is executed before an order is created from a cart. The endpoint is used to show warnings or ensure the cart is valid before attempting to create an order.

Omnium provides built-in validators, and you can also implement custom validators using webhooks. These validators ensure carts are valid when orders are created from any sales channel (e.g., your website, Omnium UI, etc.).

Configuration

Adding a Validator

To add a new validator (either built-in or webhook), navigate to Connections in settings.

Required Properties

Property	Sample Value	Description
Name	Webhook	Name of Omnium connector provider. For webhooks, this must be set to "Webhook".
Host	https://acme.com	Endpoint host (URL is added to the workflow step).
Implementations	"IValidator"	Connector capabilities. For validators, this must include `IValidator`.

Sample Configuration

{
    "connectors": [
        {
            "name": "activeProductsValidator",
            "isAuthenticatedManually": false,
            "timeOut": "00:00:00",
            "implementations": [
                "IValidator"
            ],
            "disableStandardErrorPolicy": false
        },
        {
            "name": "WebhookValidator",
            "host": "https://acme.com/api/ValidatorEndpoint",
            "isAuthenticatedManually": false,
            "timeOut": "00:00:00",
            "implementations": [
                "IValidator"
            ],
            "disableStandardErrorPolicy": false
        }
    ]
}

Validation Service

The validation service is triggered by the cart service in Omnium. It runs in the following scenarios:

When the cart is modified in the GUI.
When the user accesses the cart in the GUI.
When the cart is modified via the API.

Additionally, Omnium provides a ValidateCart endpoint that triggers the same validation logic:

If OmniumCartOmniumValidationResult is null, the cart will not be updated.
Items in ValidationErrors or ValidationWarning will be displayed in the GUI.

Highlighted error messages come from the Message property in OmniumValidationError.

Built-In Validators

Validator Overview

Name	Description	Use Case
InventoryValidator	Validates that each item in the cart has sufficient stock across the relevant warehouses. It calculates availability per SKU based on actual inventory, reserved quantities, and calculated quantities. Inventory validation is skipped for virtual products (`IsVirtual = true`).	Prevents overselling by checking stock availability across relevant warehouses before order placement.
ActiveProductsValidator	Checks that all products in the cart are active (`IsActive = true`) before allowing the cart to proceed. If any products are inactive, the validator returns a list of validation errors—one for each inactive SKU. Each error includes a message and a reference to the specific product that caused the issue.
InactiveCustomerValidator	Validates whether the associated customer is marked as inactive. If the customer has `IsInactive = true`, the cart is blocked from proceeding.	Prevents checkout for inactive customers to ensure only valid, active customers can place orders.
DiscountValidator	Ensures applied discounts are valid.
NullPriceValidator	Checks if any items in the order have a price of zero.	Prevents submission of carts with products that are missing price information.
PaymentsValidator	Validates that the total amount paid matches the order total. Fails if there are no payments, or if the total paid is too low or too high.	Prevents submission of carts with missing, insufficient, or excessive payments.
CreditLimitValidator	Validates that the customer's credit is sufficient to cover the cart total for credit-based payments. Includes checks for credit denial, remaining credit, and credit limit.	Prevents orders from being placed if the customer lacks sufficient credit or is not allowed to purchase on credit.
PromotionCouponValidator	Validates that all promotion coupon codes in the cart are valid. Invalid codes are removed and trigger a validation error.	Prevents the use of expired or invalid coupon codes by validating them and removing any that fail.
RequiredFieldsValidator	Validates that all required fields are present in the order. The fields to check are defined in tenant settings and optionally filtered by order type.	Prevents submission of incomplete cart by ensuring that configured fields are not empty or missing.
SalesLimitationValidator	Checks for sales limitations on specific products.
ShipmentValidator	Ensures that at least one shipment is selected in the cart before submission. It checks whether the cart’s order form contains any shipments, and returns a validation error if none are found.	Prevents carts from being submitted without a selected delivery method by ensuring that a shipment is present.
PriCatIdValidator	Validates that the cart has a Pricat ID and that all products in the cart share consistent Pricat IDs. If the cart is a pre-order and missing a Pricat ID, it adds a blank value and returns a warning. It also checks if product Pricat IDs match the cart’s, and fails if mismatched or inconsistent.

Each validator provides tailored validation logic to meet specific business requirements. Custom validators can also be implemented for additional flexibility.

Configuration

Cart Validators

Configuration

Adding a Validator

Required Properties

Sample Configuration

Validation Service

Endpoint

Request

Expected Response

Response Handling

Built-In Validators

Validator Overview

On this page