Skip to content

Main Navigation Extras

Getting Started

Mermaid diagrams

VitePress Features

Spell checking (cspell)

❤️ Become a sponsor!

English

English

Appearance

Sidebar Navigation

ABTest

Ace

Quick start

System settings

Integration

Keyboard shortcuts

Troubleshooting

AjaxForm

AjaxFormItLogin

System settings

Scripts and styles

System events

Snippets

AjaxFormitLogin

aflActivateUser

Custom snippets

Hooks

AjaxIdentification

Validators

aflCheckPassLength

aflPasswordConfirm

aflRequiredIf

aflUserExists

aflUserNotExists

ajaxLogin

AjaxSnippet

allGifts

Quick start

Problem solving

amoConnector

Installation and setup

Submitting form data

Field mapping

Status mapping

Webhook

Scheduler

Events

Common mistakes

autoRedirector

BannerPro

Getting started

Quick start

System settings

Site integration

Integration and scenarios

Snippets overview

BannerPro snippet

Manager

Integrations

MiniShop3

Analytics

Developers

MODX events

REST API

FAQ

BannerY

Interface

Banners

Positions

Cabinet

CallBack

cityFields

Cities and data management

Using domains, subdomains and subdirectories

Product price management

Component settings

cfCities snippet

cfField snippet

Sitemap generation

CitySelect

ClickToCall

Compare for MODX 3 - Documentation

Comparison

addComparison

CompareList

getComparison

CrawlerDetect

Quick start

System settings

Snippets

isCrawler

crawlerDetectBlock

Integration

Troubleshooting

CronTabManager

Settings

Interface

Commands

Background jobs

CurrencyRate

customExtra

DebugParser

DigitalSignage

easyComm

Description

Interface

Settings

Snippets

Plugins and customization

Multiple rating fields

Rating in pdoResources, msProducts snippets

Common solutions and FAQ

easyRedirects

ePochta

FetchIt

Quick start

FetchIt snippet

Component settings

Selectors

Migration from AjaxForm

Custom snippet handling

JS API

FetchIt class

FetchIt instance

Events

Form markup

Bootstrap form

Bulma form

UIkit form

Fomantic-UI form

Pico.css form

Cirrus CSS form

turretcss form

Vanilla form

Popup notifications

Notyf

SweetAlert2

iziToast

Notiflix.Notify

Notie

Awesome Notifications

Toastify JS

AlertifyJS

PNotify

toastr

jGrowl

NOTY

Modals

Bootstrap modals

tingle.js modals

Micromodal.js modals

Validation

Validation with Iodine

Validation with yup

FileAttach

FileMan

Interface

Snippets

Settings

FlatFilters

Getting started

Snippets

Chunks

Events

Development

Formalicious

Setup

Media sources

Categories

Field types

Creating a form

FAQs

Frontend Editor

frontTabs

GoogleSheets

Authorization

Import

Resources

Products

Categories

Vendors

msOptionsPrice2

msProductRemains

Export

Resources

Categories

Products

Orders

Vendors

Users

Clients

msOptionsPrice2

msProductRemains

MIGX

Snippets

GoogleSheets

GoogleSheetsSaveForm

GoogleSheetsFront

Development

Events

HybridAuth

Snippets

HybridAuth

haProfile

Providers

Disqus

Facebook

Foursquare

GitHub

Goodreads

Google

LastFM

Live

Mailru

Instagram

Yandex

Twitter

Vkontakte

Odnoklassniki

idimage

Quick start

Product indexing

Indexing types

Category settings

System requirements

Snippets

Background jobs

Localizator

Quick start

System settings

Snippet Localizator

Language switching

Events

Sitemap formation

Import in localization

seoTemplates

hreflang attribute

LxQuiz

Snippet LxQuiz

Snippet LxQuizList

MagicThemes

Themes

handyShop

Setup

Example: Things

Mapex2

mdDocs

mFilter

Quick start

System settings

Caching

Snippets

mFilter

mFilterForm

Manager interface

Filter sets

Slugs

URL patterns

SEO templates

Word forms

Maintenance

Front-end

Templates

Placeholders

Development

JavaScript

JS API

Headless API

Services

Filter types

Events

Models and DB

Integrations

MiniShop3

mSearch

Cookbook

Filter values sorting

External filters

Custom filter type

MigxPageConfigurator

Getting started

Working with chunks

Working with snippets

Working with forms

Working with contacts

Working with images

Creating and updating elements

Region-specific data

MinifyX

miniShop2

Quick start

System requirements and dependencies

Interface

Category

Product

Orders

Settings

Gallery

Task manager

Utilities

Gallery

Import

Snippets

msProducts

msCart

msOrder

msMiniCart

msGetOrder

msGallery

msOptions

msProductOptions

Development

Product plugins

Scripts and styles

Events

Services

Cart

Order

Delivery

Payment

Connection

Payment modules

Other add-ons

Useful queries

Count products in category

Get MS2 product vendors

Get product IDs by MS2 option

Resource tree

Get all product categories

Get products by options

Get links to product extra categories

MiniShop3

Quick start

Differences from miniShop2

System settings

Snippets

msProducts

msCart

msOrder

msGetOrder

msGallery

msOptions

msProductOptions

msCustomer

msOrderTotal

Manager interface

Category

Product

Gallery

Notification center

Settings

Deliveries

Payments

Vendors

Links

Options

Utilities

Gallery

Import

Product fields

Extra fields

Grid columns

Model fields

Frontend interface

Catalog

Product page

Cart

Checkout

Thank you for your order

Customer account

Customer profile

Shipping addresses

Order history

Development

Events

Plugin guide

Cart

Order

Order model

Order item

Cost

Status

Customer

Product

Vendor

Notifications

Import

Manager

REST API

API Router

JavaScript API

Frontend JavaScript

Scheduler

Models and database schema

Service layer

Backend API

Product API

Order API

Options API

Customer API

mixedImage

MobileDetect

Quick start

System settings

Snippets

MobileDetect

Integration

Troubleshooting

modDevTools

modRetailCRM

Presetup

Upload products

Upload users

Upload orders

API examples

Create new contact

Quick order product

Search order in RetailCRM

Search product in RetailCRM

Triggers

Order status change

Modules and class extension

Example class extension

ModTree

modVkMarket

Modx3ProfilerToolbar

Quick start

System settings

Frontend Dev Toolbar

pdoTools limitations

Troubleshooting

ms_CDEK2

Getting started

Snippets

Events

Development

ms2form

ms2Gallery

Snippets

ms2Gallery

ms2GalleryResources

Preview generation

Integration

Images on page

Examples

Console import

Bootstrap3 slider

MS3 Demo Data

ms3Favorites

Quick start

System settings

Snippets

ms3Favorites

ms3FavoritesBtn

ms3FavoritesCounter

ms3FavoritesIds

ms3FavoritesPage

ms3FavoritesLists

ms3FavoritesPopularity

ms3FavoritesShare

ms3fLexiconScript

Frontend setup

Integration and customization

ms3FirstTimeBuyerDiscount

Quick start

System settings

API and events

MiniShop3 integration

Extension

ms3ProductSets

Quick start

System settings

Set types

Snippets

ms3ProductSets

mspsLexiconScript

Frontend setup

Integration and customization

Manager interface

Interface overview

Product sets

Manager guide

Permissions

For developers

Contracts and parameters (API)

Flows and scenarios

Architecture

ms3Pulse

Quick start

System settings

Interface

Dashboard

Chart builder

Tops and flops

Settings

Metrics and charts

Metrics and indicators

Filters and period

Chart types

Data sources

Export

Scheduled reports

Permissions

Troubleshooting

ms3RecentlyViewed

Quick start

System settings

Snippets

ms3recentlyviewed

ms3recentlyviewedSimilar

ms3rvLexiconScript

Manager interface

Dashboard

View history

Frontend setup

Permissions

ms3Variants

System settings

Snippets

Manager interface

Variants tab on product

Variants in order

Frontend

Product page

Product catalog

msAddLinked

msAltCart

Getting started

Snippets

JavaScript

Events

Number input field

msBonus2

Quick start

Snippets

msBonus2Form

msBonus2Logs

msBonus2ProductBonus

jQuery events

Plugin events

msb2OnBeforeSetBonus

msb2OnSetBonus

msb2OnUnsetBonus

Examples

Programmatic API

Cases

Email notice about bonuses spent on order

Extra bonuses for first order

Use either msPromoCode2 or msBonus2

msBuyNow

mscAddress

msCategoryOptions

mscDistance

mscZone

msDaData

msDellin

msDiscount

Promotions

Discounts

Coupons

Snippets

msdBuyNow

msdGetDiscount

mSearch

Snippets

mSearch

mSearchForm

Interface

Search

Indexing

Queries

Aliases

Dictionaries

Extending the component

mSearch2

Snippets

mSearch2

mFilter2

mSearchForm

Administration

Search

Indexing

Queries

Synonyms

Dictionaries

Extension

Filtration methods

Product filtration example

Solutions

Dependent filters

Category filtration

msEMS

msExtraFields

Features

Installation

Interface

Settings

Snippets

Plugins

msFavorites

Quick start

Update

msGallerySearch

Load from link

Find in Google

Find in images

System settings

msGoodsLinks

msImportExport

msImportExport 1.0

msImportExport 2.0

msLiveInform

msManagerOrderMap

msMarketingStatuses

msMCD

msMerchant

msNewPrice

mSocial

mSocialVK

mSocialFB

msOneClick

msOptionsPrice

msp3YooKassa

Quick start

System settings

Integration

mspAssistBelarus

mspBePaid

msPointsIssue

Snippets

msPointsIssue.Order

Interface

Orders

Settings

mspPayAnyWay

mspPayPal

mspPaySelectionWidget

mspPayU

msPre

Features

Interface

COMBO

Product and Prices

miniShop2 options

TV parameters

List field settings

List editing

Transactions

msProductDiscounts

Javascript

Cases

msProductRemains

Component settings

Remains tab

Remains page

getRemains snippet

Examples

msProfile

Interface

Snippets

msProfile

msProfileCharge

Plugin

msPromoCode

Functionality

Promotions

Application conditions

Referral promo codes

Fixed cart discount

Installation and setup

Snippets

mspcForm

mspcRefCoupon

jQuery events

Plugin events

mspcOnBeforeSetCoupon

mspcOnSetCoupon

mspcOnBeforeSetProductDiscount

mspcOnSetProductDiscount

mspcOnBindCouponToOrder

Cases

Output promo code info in email

Personalized promo codes for user

Cancel promo code when cart contains prohibited products

msPromoCode2

Quick start

Snippets

msPromoCode2

mspc2Generate

mspc2CartKey

jQuery events

Plugin events

mspc2OnBeforeGetCoupon

mspc2OnGetCoupon

mspc2OnBeforeSetCoupon

mspc2OnSetCoupon

mspc2OnUnsetCoupon

mspc2OnSetProductDiscountPrice

Examples

Programmatic API

Cases

Output promo code info in email

Set promo code programmatically on site visit

Generate promo code in email for next order

Apply either msPromoCode2 promo code or msBonus2 bonuses

mspTBank

Быстрый старт

Системные настройки

Интеграция и сценарии

FAQ

mspUP

mspWebPay

mspYaCassa

msQuickView

msSalePrice

msSetInCart

msSMS

msWallpapers

Installation and setup

Snippets

mswp.form

Plugin events

mswpOnGetProductPrice

mswpOnGetProductCost

Examples

Cases

Form in modal with texture pre-selection

msYmarket

mSync

Installation

Interface

Settings

Events and plugins

multiLingual

Translation principle

Problem solving

Interface

Adding languages

Adding translations to fields

Snippets

mlLanguagesLinks

mxEditorJs

Getting started

Quick start

System settings

Editor guide

Integration

TVs, migration, frontend

FAQ

For developers

API and interfaces

Flows

Architecture

Troubleshooting

mxQuickView

Getting started

Quick start

System settings

Render types

Site integration

Integration

Frontend setup

Snippets overview

Snippet mxQuickView.initialize

Administration

Manager guide

Permissions

For developers

Contracts and parameters (API)

Flows and scenarios

Architecture

MyFavorites

NotFoundParamAlert

Office

Quick start

Logic

Additional functionality

Controllers

Auth

Profile

Orders history MS2

Remote auth

orderPrint

Settings

Templates

ordersUnformed

OrphoMan

PageBreaker

Settings

Support for TinyMCE

PageSpeed

PayAndSee

Interface

Resource

Orders

Content

Rates

Clients

Subscriptions

Statuses

Notifications

Settings

Snippets

pas.content

pas.order

pas.get.order

pas.subscription

Development

Scripts and styles

Events

Extensions

Services

Cart

Order

Delivery

Payment

Other extras

msDiscount

msPromoCode

pdoTools

Snippets

pdoResources

pdoMenu

pdoPage

pdoCrumbs

pdoUsers

pdoSitemap

pdoNeighbors

pdoField

pdoTitle

pdoArchive

Classes

pdoTools

pdoFetch

pdoParser

General properties

File elements

Parser

plAffiliates

Platron

PromoDs

Quiz

Snippets

Quiz

QuizData

QuizSteps

QuizResult

SeoImg

Events

Methods

Examples

RBK Money

Choosing payment method on site

ReachGoal

Reactions

Getting started

Quick start

System settings

Snippets

Overview

Reactions

ReactionsCount

TopLiked

TopRated

Trending

ReactionsSchema

Integrations

pdoTools

miniShop3

Tickets

Collections

SEO / Schema.org

JavaScript widget

REST API

CLI

MODX events

Webhooks

resComments

ResourceGrabber

Interface

Data

Snippets

Settings

Development

Services

Getter

Grabber

Setter

Events

ResVideoGallery

Snippets

ResVideoGallery

ResVideoGalleryTags

ResVideoGalleryUpload

Adding custom video parser

Events

Settings

VKontakte

Save2Page

Scheduler

Installation

Creating a task

Scheduling a task

Task development

scxcaptchaAjaxForm

Sendex

Quick start

Snippets

Sendex

Interface

Subscriptions

Email queue

System settings

Events

PHP API

FAQ

SendIt

Getting started

Sending data

Pagination

Identification

Quiz forms

File upload

Saving form data

Notifications

Snippets

Events

Development

SEO Domains

SEO Suite

SeoFilter

Quick start with mFilter2

Quick start without mFilter2 and miniShop2

Additional features

Snippets

sfWord

sfLink

sfMenu

sfSitemap

Substitutions in SEO texts

Component objects

Field

Rule

Dictionary

URL table

SEOtabs

seoTabs snippet

ShoppingCart

simpleFilters

simpleQueue

smartSessions

SocialTools

Snippets

socDialogForm

socDialogList

socDialogReceive

StaticSaver

SVRegions

SVResolution

textAdvs

How to add a tag

Tickets

Quick start

Interface

Creating a ticket section

Creating a ticket

User permissions setup

Policies and permissions

System settings

Chunks

Frontend and AJAX

Snippets

getTickets

getTicketsSections

getComments

getStars

TicketComments

TicketForm

TicketLatest

TicketMeta

subscribeAuthor

TicketFormit

FAQ

TVTable

UserAuthHash

Development

Events

Extensions

UserEvents

Interface

Orders

Events

Statuses

Notifications

Settings

Snippets

ue.order

ue.get.order

Development

Scripts and styles

Events

Extensions

Services

Order

Delivery

Payment

UserLocation

Development

Events

userMarker

UsersOnline

ViewsOnline

VoteForms

VueTools

Integration

API Composables

WebDAV

WebMoney

xCalc

Snippets

xCalc

Field types

jQuery events

Cases

Windowsill calculator

AjaxForm for results output

xParser

RSS feed parser

HTML content parser + combined tasks

Working with miniShop2 products

Working with galleries

Pagination

Regular expressions

Plugin events

xParserOnFilterSourceItems

xParserOnBeforeTaskParse

xParserOnTaskItemParse

xParserOnBeforeTaskActions

xParserOnTaskParseDone

Examples

Cron task runner script

Node JS daemon

YandexMaps

YandexMaps2

Snippets

YandexMaps2

Quick start

Working with mFilter2

jQuery events

Map constructor

Plugin events

ymOnLoadObjects

Examples

Cases

Points from MIGX with custom icons on frontend

Disable all map controls

Output parent resource data in balloons

ZoomX

On this page

Banner management for MODX 3: positions, rotation, clicks, impressions, and Vue manager UI

modstore.pro

Dependencies

pdoTools
VueTools

Extras
BannerPro
FAQ

FAQ

Author:Ivan Bochkarev

Component menu

Getting started
- Quick start
- System settings
Site integration
Manager
Integrations
- MiniShop3
- Analytics
Developers
- MODX events
- REST API
FAQ

Suggest changes to this page

Last updated:

Previous pageREST API