Enterprise ecommerce for Umbraco v17+. a full-featured online store with an optional integrated Shopify-style checkout, backoffice management UI, and a pluggable provider architecture.
Full docs — installation, starter-site walkthrough, configuration reference, checkout flow, extending Merchello with custom providers, and the storefront/admin/webhook API references — live at YodasMyDad.github.io/Merchello.
The Merchello.Site project in this repo is a working example store (It's what is used for the .NET Template below) that allows you to see how to render products, collections/categories, add to cart etc...
Just create a fork of this project, and run the app (Make sure you have cleared any database connection strings) and install Umbraco, you can then install the content using usync, just watch the video below - Same applies to the .NET template
The fastest way to a complete, working store. Our .NET template scaffolds a brand-new Umbraco project with Merchello pre-installed and a full example storefront - product pages, categories, add-to-cart, checkout, order confirmations - the lot. It's a real end-to-end site you can run straight away, then restyle and rebuild around your brand.
dotnet new install Umbraco.Community.Merchello.StarterSite
dotnet new merchello-starter -n MyStoreThis will scaffold a project named MyStore.Web (it appends .Web automatically). You can override the project name with --projectName:
dotnet new merchello-starter -n MyStore --projectName MyCustomProjectNameSet your store defaults in appsettings.json before the first run:
{
"Merchello": {
"InstallSeedData": true,
"StoreCurrencyCode": "USD",
"DefaultShippingCountry": "US"
}
}Don't forget to watch the video about using uSync to get the starter content and doc types setup and running.
Or if you want to use the Nuget package directly and build out your own front end, just install the latest version of Umbraco and then install the Merchello nuget package. Remember, you are only installing Merchello and not the Starter Site (Front end).
dotnet add package Umbraco.Community.MerchelloThen you need to add merchello to the Umbraco builder
builder.CreateUmbracoBuilder()
.AddBackOffice()
.AddWebsite()
.AddComposers()
.AddMerchello() <<====
.Build();It's important you set some starting settings in your appSettings to your preference before starting up the project, these are the defaults (If you don't want seed data set that to false)
{
"Merchello": {
"InstallSeedData": true,
"StoreCurrencyCode": "USD",
"DefaultShippingCountry": "US"
}
}By all means change the StoreCurrencyCode (ISO 4217 code) and DefaultShippingCountry (ISO 3166-1 alpha-2 country code) to whatever you want.
Once installed, you need to enable the Merchello section in the Admin users group (Like you would do any new section).
If you left InstallSeedData = true and now click on the main Merchello root branch in the tree, you should see an Install Seed data panel. If you click install, that will install a lot of test data, it can take some time, the panel will disappear when it's done.
- Integrated checkout — single-page, Shopify-style flow: addresses, shipping, discounts, payment, guest/registered customers, express checkout
- Post-purchase upsells — rules engine with one-click add-to-order via saved payment method
- Abandoned cart recovery — automatic detection, email sequences, basket restoration
- Product routing — products render at root-level URLs without Umbraco content nodes
- Address lookup — pluggable providers (GetAddress.io built-in) for postcode lookup and autocomplete
- Stripe — cards, Apple Pay, Google Pay
- PayPal — PayPal Checkout
- Amazon Pay — Amazon Checkout
- Braintree — cards, PayPal, Venmo
- WorldPay — cards, Apple Pay
- Manual — offline / test payments
- Saved payment methods (vaulting), payment links, and invoice reminders
- Flat rate — configurable cost/weight tiers per warehouse
- UPS / FedEx — live carrier rates
- ShipBob — 3PL fulfilment: order submission, webhook status updates, product and inventory sync
- Supplier Direct — CSV-based fulfilment via SFTP/FTP/email to supplier warehouses
- Multi-warehouse inventory with priority-based warehouse selection, region restrictions, and pluggable order grouping strategies
- Manual — tax groups with country/state rate overrides
- Avalara AvaTax — real-time tax calculation
- Proportional shipping tax calculation for EU/UK VAT compliance
- Variants and non-variant add-ons with price/cost/SKU adjustments
- Digital products — secure HMAC-signed downloads, expiry, download limits
- Product feeds — Google Shopping / product feed generation
- Product import — CSV import and sync
- Customer segments — manual and automated (spend, order count, location, tags)
- Discount engine — percentage, fixed amount, buy X get Y, free shipping, segment targeting, usage limits
- Supplier / vendor management — supplier records with vendor-based order grouping
- Live exchange rates (Frankfurter built-in, pluggable providers)
- Automatic country-to-currency mapping with rate locking at checkout
Expose your store to AI agents. UCP is an open standard co-developed by Google, Shopify, Stripe, Visa, Mastercard and 25+ partners that lets AI agents browse products, build carts, and complete checkout on behalf of users. Merchello implements UCP as a protocol adapter — discovery manifest, checkout sessions, discount and shipping extensions, signed order webhooks (ES256), and agent authentication.
- Reporting — sales breakdown, best sellers, gross profit, dashboard KPIs, CSV export
- Email system — MJML templates, token replacement, configurable per notification topic
- Webhooks — outbound webhooks with HMAC signing, retry queue, 25+ event topics
- Invoice reminders — automated overdue invoice reminder sequences
- Health checks — built-in system health checks for store diagnostics
- Order source tracking — orders tagged by source (web, backoffice, API, POS, draft, UCP) for analytics
Build your own providers for payments, shipping, tax, fulfilment, exchange rates, address lookup.
Database tables are in place for these features — implementation is in progress.
- Gift cards — purchasable and redeemable gift card support
- Subscriptions — recurring billing and subscription management
- Returns / RMA — return requests and returns management
- Audit trail — activity logging and timeline tracking
- Customer account portal — self-service order history, saved addresses, profile management
- Product search — pluggable search with faceted filtering and autocomplete
- Rate limiting — enterprise API protection with configurable policies
See LICENSE for details.