> For the complete documentation index, see [llms.txt](https://vettvangur.gitbook.io/ekom/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vettvangur.gitbook.io/ekom/readme.md).

# Ekom documentation

Ekom is an e-commerce package for Umbraco. It adds stores, a product catalog, baskets, checkout, payments, shipping, discounts and an order manager to an Umbraco site.

These docs cover Ekom on Umbraco 17, 18 and 19. Umbraco 19 is a release candidate. For a product overview, visit [ekomcommerce.com](https://www.ekomcommerce.com/).

Ekom is open source. The code, the releases and the issue tracker are on GitHub: [github.com/Vettvangur/Ekom](https://github.com/Vettvangur/Ekom). The payment gateways are in [github.com/Vettvangur/Ekom.Payments](https://github.com/Vettvangur/Ekom.Payments).

## Find what you need

| You want to                                              | Go to                                                                    |
| -------------------------------------------------------- | ------------------------------------------------------------------------ |
| Install Ekom on a site for the first time                | [Getting started](https://vettvangur.gitbook.io/ekom/getting-started.md) |
| Build one part of a store, such as checkout or discounts | [Guides](https://vettvangur.gitbook.io/ekom/guides.md)                   |
| Set up Stripe, PayPal or another payment gateway         | [Payment gateways](https://vettvangur.gitbook.io/ekom/payments.md)       |
| Copy working code for a common task                      | [Examples](https://vettvangur.gitbook.io/ekom/examples.md)               |
| Look up a setting, method, event or endpoint             | [Reference](https://vettvangur.gitbook.io/ekom/reference.md)             |
| Work with orders and customers in the backoffice         | [Manager](https://vettvangur.gitbook.io/ekom/manager.md)                 |
| Move a site to a newer Umbraco or Ekom version           | [Upgrading](https://vettvangur.gitbook.io/ekom/upgrading.md)             |
| Understand how Ekom is put together                      | [Architecture](https://vettvangur.gitbook.io/ekom/architecture.md)       |
| Connect Algolia, Klaviyo or Mailchimp                    | [Integrations](https://vettvangur.gitbook.io/ekom/integrations.md)       |
| See a working example site                               | [Samples](https://vettvangur.gitbook.io/ekom/overview.md)                |
| Work on Ekom itself                                      | [Contributing](https://vettvangur.gitbook.io/ekom/contributing.md)       |

## New to Ekom

Follow these in order. The first four take you from an empty Umbraco site to a working basket.

1. [Compatibility](https://vettvangur.gitbook.io/ekom/getting-started/compatibility.md): pick the packages that match your Umbraco version.
2. [Installation](https://vettvangur.gitbook.io/ekom/getting-started/installation.md): install Ekom and check that it starts.
3. [Configuration](https://vettvangur.gitbook.io/ekom/getting-started/configuration.md): set the main options.
4. [Quick start](https://vettvangur.gitbook.io/ekom/getting-started/quick-start.md): create a small catalog and add a product to a basket.
5. [Guides](https://vettvangur.gitbook.io/ekom/guides.md): build the rest of the store, one part at a time.
6. [Examples](https://vettvangur.gitbook.io/ekom/examples.md): copy working code for common tasks.

## Sections

### [Getting started](https://vettvangur.gitbook.io/ekom/getting-started.md)

Install and configure Ekom, and get a first basket working.

### [Guides](https://vettvangur.gitbook.io/ekom/guides.md)

One guide for each part of a store. Each explains what the feature does, how to set it up and how to use it from your code.

* **Stores and catalog:** [Stores](https://vettvangur.gitbook.io/ekom/guides/stores.md), [Catalog and products](https://vettvangur.gitbook.io/ekom/guides/catalog-and-products.md), [Variant App](https://vettvangur.gitbook.io/ekom/guides/variant-app.md), [Stock](https://vettvangur.gitbook.io/ekom/guides/stock.md), [Database price storage](https://vettvangur.gitbook.io/ekom/guides/database-price-storage.md), [Catalog imports](https://vettvangur.gitbook.io/ekom/guides/imports.md)
* **Baskets and orders:** [Orders and baskets](https://vettvangur.gitbook.io/ekom/guides/orders-and-baskets.md), [Linked order lines](https://vettvangur.gitbook.io/ekom/guides/linked-order-lines.md), [Order custom data](https://vettvangur.gitbook.io/ekom/guides/order-custom-data.md), [Order statuses](https://vettvangur.gitbook.io/ekom/guides/order-statuses.md), [Order reviews](https://vettvangur.gitbook.io/ekom/guides/order-reviews.md)
* **Checkout, payment and shipping:** [Checkout](https://vettvangur.gitbook.io/ekom/guides/checkout.md), [Providers](https://vettvangur.gitbook.io/ekom/guides/providers.md), [Payments](https://vettvangur.gitbook.io/ekom/guides/payments.md), [Shipping](https://vettvangur.gitbook.io/ekom/guides/shipping.md), [Stock reservations](https://vettvangur.gitbook.io/ekom/guides/reservations.md), [Gift-card recovery](https://vettvangur.gitbook.io/ekom/guides/giftcard-recovery.md)
* **Discounts:** [Discounts and coupons](https://vettvangur.gitbook.io/ekom/guides/discounts.md)
* **Storefront integration:** [Headless storefronts](https://vettvangur.gitbook.io/ekom/guides/headless.md), [Tracking and consent](https://vettvangur.gitbook.io/ekom/guides/tracking-and-consent.md)

### [Payment gateways](https://vettvangur.gitbook.io/ekom/payments.md)

One page for each payment gateway: what to install, which settings to fill in, and what Ekom records. Also how to write your own.

### [Examples](https://vettvangur.gitbook.io/ekom/examples.md)

Working code you can copy: event handlers, your own product classes, imports with images and variants, storefront pages, Manager actions and background jobs.

### [Reference](https://vettvangur.gitbook.io/ekom/reference.md)

Exact names, types and defaults, for looking something up.

* [.NET API](https://vettvangur.gitbook.io/ekom/reference/dotnet-api.md)
* [Services and dependency injection](https://vettvangur.gitbook.io/ekom/reference/services-and-dependency-injection.md)
* [Events](https://vettvangur.gitbook.io/ekom/reference/events.md)
* [HTTP API](https://vettvangur.gitbook.io/ekom/reference/http-api.md)
* [Configuration reference](https://vettvangur.gitbook.io/ekom/reference/configuration-reference.md)
* [Models and behavior](https://vettvangur.gitbook.io/ekom/reference/models-and-behavior.md)

### [Manager](https://vettvangur.gitbook.io/ekom/manager.md)

The Ekom area of the Umbraco backoffice: orders, customers, analytics and who can access them.

### [Upgrading](https://vettvangur.gitbook.io/ekom/upgrading.md)

Step-by-step guides for moving between Umbraco versions and for changes inside Ekom that need action from you.

### [Architecture](https://vettvangur.gitbook.io/ekom/architecture.md)

How the packages fit together, what happens at startup, and where Ekom keeps its data.

### [Integrations](https://vettvangur.gitbook.io/ekom/integrations.md)

The optional Algolia, Klaviyo and Mailchimp packages.

### [Samples](https://vettvangur.gitbook.io/ekom/overview.md)

The example sites in this repository and what they show.

### [Contributing](https://vettvangur.gitbook.io/ekom/contributing.md)

Set up, build, test and release Ekom itself.

## About these docs

* They describe the current `Ekom` branch. A page says so when something differs between Umbraco 17, 18 and 19.
* Every page has a path back to its section and to this page under its title, and ends with related pages.
* Each plugin keeps its own setup instructions in its README. These docs link to them and do not repeat them.
* The release history is in [`Ekom/CHANGELOG.md`](https://github.com/Vettvangur/Ekom/blob/Ekom/Ekom/CHANGELOG.md).
