Settings
Every system setting the shop installs, with its default. They live in the MODX system settings under namespace areas, and all of them carry the pbshop_ prefix.
Updating the package does not overwrite your settings
So a default described here is what a fresh install gets. A shop that has been running since an earlier version keeps whatever it had, including the empty value a setting used to have before it got a default.
Main
| Setting | Default | What it does |
|---|---|---|
pbshop_currency | EUR | the shop's default currency. A product with no price in it is printed without a price, which is not the same as zero |
pbshop_currencies | EUR,USD,RUB | the currencies offered in the switcher |
pbshop_test_mode | on | the payment gateways' sandbox. The register has its own switch |
pbshop_order_number | {year}/{seq:3} | the order-number pattern. {year} {yy} {month} {day} {seq}, with leading zeros as {seq:3}. The counter resets within whatever stands before {seq} |
pbshop_return_url | / | where the gateway returns the buyer |
pbshop_return_url_fail | empty | an interrupted payment. Empty means use pbshop_return_url |
pbshop_return_url_pending | empty | a payment awaiting confirmation. Same fallback |
pbshop_test_mode ships on
Which is the right default — an acquirer taking real money the moment it is enabled would be worse — but it does mean a live shop needs it switched off deliberately. See Payments for what each driver does with it.
Catalogue and storefront
| Setting | Default | What it does |
|---|---|---|
pbshop_route_prefix | shop | the storefront prefix. An empty value switches the storefront off entirely |
pbshop_catalog_limit | 12 | products per catalogue or category page. 0 means all at once. Does not affect snippets — they have their own &limit |
pbshop_sitemap_route | empty | the catalogue sitemap address. Off by default — see SEO |
pbshop_compare_limit | 4 | how many products fit in a comparison. 0 means "as many as we think", not unlimited |
pbshop_stock_alerts | on | the "notify me when it is back" subscription. The button only appears where a product tracks stock and has run out, so a shop without a warehouse never sees it |
pbshop_consent | on | the data-processing checkbox in both checkout forms |
pbshop_consent_url | empty | the policy address: a MODX resource id or a URL. Empty leaves the text without a link |
pbshop_quick_method | empty | the payment method key for one-click purchase. Empty means the first offline one; a gateway method does not work in this role at all, and then there is no button |
pbshop_login_url | empty | the "Log in" address. Empty asks pbAuth's named routes; with neither, no link is shown |
pbshop_logout_url | empty | as above |
pbshop_register_url | empty | as above |
An empty pbshop_route_prefix switches the storefront off
Every storefront route goes with it — the catalogue, the cart, the account, the order page, search and comparison. That is what the empty value is for: a shop that only outputs through snippets on the site's own pages.
The reverse case is worth knowing on a fresh install: if the site already has a page at /shop, the storefront shadows it. Change the prefix.
Page templates
Each takes a site chunk in place of the built-in template. All understand the same four forms as &tpl: a chunk name, file:, @FILE and @INLINE.
| Setting | Replaces |
|---|---|
pbshop_catalog_tpl | the catalogue page |
pbshop_category_tpl | a category page |
pbshop_product_tpl | the product page |
pbshop_cart_tpl | the cart |
pbshop_account_tpl | the buyer's account |
pbshop_order_tpl | the order page |
pbshop_search_tpl | search results |
pbshop_compare_tpl | the comparison page |
pbshop_notice_tpl | the single-message page people arrive at from an email |
pbshop_layout_tpl | the wrapper the built-in templates sit in. Your own chunk gets no wrapper — there the site builds the page |
There is deliberately no "enable search" setting: search is part of the catalogue, like filtering and pagination, and the field is in the header of every storefront page. A disabled search would be a form leading to a 404.
Receipts
The register's settings, unlike a payment driver's, are system settings — one fiscal-operator contract per legal entity, one register across all methods. Full explanation in Receipts.
| Setting | Default | What it does |
|---|---|---|
pbshop_fiscal_driver | empty | atol or checkbox. Empty means no fiscalisation, and that is the default |
pbshop_fiscal_login | empty | ATOL: cabinet login. Checkbox: the cashier's login |
pbshop_fiscal_password | empty | the password for the above |
pbshop_fiscal_currency | RUB | the currency receipts are issued in. Checkbox requires UAH — set it explicitly |
pbshop_fiscal_test_mode | off | the register's test circuit. Separate from pbshop_test_mode on purpose |
pbshop_fiscal_group | empty | ATOL: the group code |
pbshop_fiscal_inn | empty | ATOL: the seller's registration number |
pbshop_fiscal_address | empty | ATOL: the address of settlement. Empty falls back to the site URL, but it is printed on the receipt — name it |
pbshop_fiscal_sno | usn_income | ATOL: the tax system |
pbshop_fiscal_email | empty | ATOL: the seller's email, printed on the receipt |
pbshop_fiscal_vat_code | 1 | the default rate; 1 is "no VAT". A product's own rate is a constructor field and wins |
pbshop_fiscal_licence_key | empty | Checkbox: the register's licence key. Required — no key, no shift, no receipts |
pbshop_fiscal_pin | empty | Checkbox: sign in by PIN instead of a login. Needs the licence key |
pbshop_fiscal_cashier_name | empty | Checkbox: printed on the receipt; empty and the register fills it |
pbshop_fiscal_departament | empty | Checkbox: the department. Spelled with the register's own typo |
pbshop_fiscal_shift_hours | 23 | Checkbox: when the register closes the shift itself. Must stay under 24 |
pbshop_fiscal_tax_codes | empty | Checkbox: a JSON map from pbShop's rate codes to the register's. Empty means the rate is not sent at all |
pbshop_fiscal_sms | off | Checkbox: send the receipt by SMS. A paid extra at the register |
Mail
| Setting | Default | What it does |
|---|---|---|
pbshop_order_mails | on | the three order emails to the buyer |
pbshop_mail_from | empty | the sender. Empty uses the site's own, which is what it uses without us |
pbshop_mail_from_name | empty | as above |
pbshop_invoice_copy_email | empty | a copy of each invoice to your bookkeeping. One letter per new file, not per download |
pbshop_mail_order_created_tpl | empty | a site chunk for the "order placed" email |
pbshop_mail_order_paid_tpl | empty | the "order paid" email |
pbshop_mail_order_status_tpl | empty | the "status changed" email |
pbshop_mail_invoice_copy_tpl | empty | the bookkeeping copy |
pbshop_mail_stock_confirm_tpl | empty | the "confirm your back-in-stock subscription" email |
pbshop_mail_stock_ready_tpl | empty | the "it is back" email |
Which statuses deserve an email is decided by the notify checkbox on the status, not by pbshop_order_mails — that one is about all three emails at once.
Printed documents
| Setting | Default | What it does |
|---|---|---|
pbshop_picking_tpl | empty | a site chunk for the picking list |
pbshop_packing_tpl | empty | a site chunk for the packing slip |
pbshop_shop_phone | empty | the phone in the packing slip header. MODX holds no phone number, and an email is not a substitute: a box needs the channel that answers immediately |
These sit in their own area rather than next to the invoice under "mail", because an invoice is issued to the buyer and sent, while these two are printed for yourself and never sent to anyone.
Marketplace feeds
| Setting | Default | What it does |
|---|---|---|
pbshop_feed_currency | empty | the feed's currency. Empty means pbshop_currency |
pbshop_feed_company | empty | the legal entity in the header. Empty means the tag is not printed — an empty one is read as an error |
pbshop_feed_vendor | empty | the manufacturer for products without their own |
pbshop_feed_ttl | 60 | minutes the built file lives. 0 disables the cache, for debugging |
pbshop_feed_key | empty | non-empty requires ?key= in the feed address |
Details in SEO and feeds.
Subscriptions
| Setting | Default | What it does |
|---|---|---|
pbshop_renew_days_before | 3 | nothing reads this |
pbshop_grace_days | 0 | nothing reads this |
These two settings do nothing
They are installed, they have labels and descriptions in four languages, and no code reads either of them. Verified on 2026-10-24.
The renewal window really is three days, and changing the setting will not move it — pass the number to dueForRenewal($days) instead. There really is no grace period; implement one in your pbShopOrderExpire listener by deferring the revocation.
They are listed here rather than omitted because a setting with a translated description looks exactly like a working feature, and finding out otherwise from a buyer whose access was cut a day early is expensive. Both are recorded as a defect. See Subscriptions and cron.
Settings owned by PageBlocks
Two of the platform's own settings change how the shop behaves, and they are worth knowing about because the symptoms look like shop bugs:
| Setting | Why it matters here |
|---|---|
pageblocks_http_cache | with it on, the cart and order snippets refuse out loud rather than risk printing one buyer's contents into another's cached page |
static_elements_allowed_extensions | must allow tpl before MODX will write a static file for a chunk you tick the "static" box on. An empty value means "no static elements at all" |
Next
- What ships where — package boundaries and the status table
- For developers — the service, events and routes