> 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/guides.md).

# Guides

[Ekom docs](https://vettvangur.gitbook.io/ekom/readme.md) / Guides

Each guide covers one part of Ekom: what it does, how to set it up, and how to use it from your code. Read a guide when you are about to build that part of a store.

The guides assume that Ekom is installed and running. If it is not, start with [Getting started](https://vettvangur.gitbook.io/ekom/getting-started.md). To look up one setting, method, event or endpoint, use the [Reference](https://vettvangur.gitbook.io/ekom/reference.md) pages.

## Where to start

Building a first storefront? Read these four in order. Together they cover the path from a product page to a paid order.

1. [Stores](https://vettvangur.gitbook.io/ekom/guides/stores.md)
2. [Catalog and products](https://vettvangur.gitbook.io/ekom/guides/catalog-and-products.md)
3. [Orders and baskets](https://vettvangur.gitbook.io/ekom/guides/orders-and-baskets.md)
4. [Checkout](https://vettvangur.gitbook.io/ekom/guides/checkout.md)

## Stores and catalog

| Guide                                                                                         | Read it when you want to                                                      |
| --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| [Stores](https://vettvangur.gitbook.io/ekom/guides/stores.md)                                 | Set up stores, and work with the right store in requests and background jobs. |
| [Catalog and products](https://vettvangur.gitbook.io/ekom/guides/catalog-and-products.md)     | Read categories, products and variants, and show them on a storefront.        |
| [Variant App](https://vettvangur.gitbook.io/ekom/guides/variant-app.md)                       | Let editors manage the variants of a product in one view.                     |
| [Stock](https://vettvangur.gitbook.io/ekom/guides/stock.md)                                   | Read and change stock, and control when a product is available.               |
| [Database price storage](https://vettvangur.gitbook.io/ekom/guides/database-price-storage.md) | Update prices often from an ERP system without publishing products.           |
| [Catalog imports](https://vettvangur.gitbook.io/ekom/guides/imports.md)                       | Bring products, categories, media and stock in from another system.           |

## Baskets and orders

| Guide                                                                                                   | Read it when you want to                                                      |
| ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| [Orders and baskets](https://vettvangur.gitbook.io/ekom/guides/orders-and-baskets.md)                   | Add, change and remove lines, and read the current basket or a saved order.   |
| [Linked order lines](https://vettvangur.gitbook.io/ekom/guides/linked-order-lines.md)                   | Sell add-ons that belong to another line, such as engraving or gift wrapping. |
| [Order custom data](https://vettvangur.gitbook.io/ekom/guides/order-custom-data.md)                     | Save your own values on an order, such as a gift message.                     |
| [Order, payment, and fulfillment statuses](https://vettvangur.gitbook.io/ekom/guides/order-statuses.md) | Understand what state an order is in and how it moves on.                     |
| [Order reviews](https://vettvangur.gitbook.io/ekom/guides/order-reviews.md)                             | Flag an order that a person needs to look at.                                 |

## Checkout, payment and shipping

| Guide                                                                                                   | Read it when you want to                                              |
| ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| [Checkout](https://vettvangur.gitbook.io/ekom/guides/checkout.md)                                       | Take a basket through payment to a completed order.                   |
| [Payment and shipping providers](https://vettvangur.gitbook.io/ekom/guides/providers.md)                | Set up the payment and shipping options a customer can choose.        |
| [Payments](https://vettvangur.gitbook.io/ekom/guides/payments.md)                                       | Add a payment gateway and follow what happened to each payment.       |
| [Shipping and shipments](https://vettvangur.gitbook.io/ekom/guides/shipping.md)                         | Add a carrier and record shipments and tracking numbers.              |
| [Stock reservations](https://vettvangur.gitbook.io/ekom/guides/reservations.md)                         | Hold stock for a customer while they pay.                             |
| [Failed gift-card preparation recovery](https://vettvangur.gitbook.io/ekom/guides/giftcard-recovery.md) | Recover when a gift-card hold succeeded but the checkout step failed. |

## Discounts

| Guide                                                                                            | Read it when you want to                                              |
| ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- |
| [Discounts and coupons](https://vettvangur.gitbook.io/ekom/guides/discounts.md)                  | See how discounts work and find the right discount guide. Start here. |
| [Configure discounts in Umbraco](https://vettvangur.gitbook.io/ekom/guides/discounts/editors.md) | Set up an offer as a store editor.                                    |
| [Product discounts](https://vettvangur.gitbook.io/ekom/guides/discounts/product-discounts.md)    | Put products or categories on sale.                                   |
| [Order discounts](https://vettvangur.gitbook.io/ekom/guides/discounts/order-discounts.md)        | Give an offer on the basket, with or without a coupon code.           |
| [Coupons](https://vettvangur.gitbook.io/ekom/guides/discounts/coupons.md)                        | Create coupon codes and limit how often they are used.                |
| [Discount APIs and behavior](https://vettvangur.gitbook.io/ekom/guides/discounts/developers.md)  | Apply coupons from code and add your own rules.                       |

## Storefront integration

| Guide                                                                                     | Read it when you want to                                                  |
| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| [Headless storefronts](https://vettvangur.gitbook.io/ekom/guides/headless.md)             | Build a storefront that talks to Ekom over HTTP.                          |
| [Tracking and consent](https://vettvangur.gitbook.io/ekom/guides/tracking-and-consent.md) | Send purchase events to GA4 and Meta in line with the customer's consent. |

## Other sections

* [Getting started](https://vettvangur.gitbook.io/ekom/getting-started.md): install and configure Ekom.
* [Payment gateways](https://vettvangur.gitbook.io/ekom/payments.md): set up Stripe, PayPal and the other gateways, one page each.
* [Examples](https://vettvangur.gitbook.io/ekom/examples.md): working code you can copy for common tasks.
* [Reference](https://vettvangur.gitbook.io/ekom/reference.md): the .NET API, HTTP API, events and settings.
* [Manager](https://vettvangur.gitbook.io/ekom/manager.md): the backoffice area for orders, customers and analytics.
* [Upgrading](https://vettvangur.gitbook.io/ekom/upgrading.md): move a site to a newer Umbraco or Ekom version.

[Back to the documentation home](https://vettvangur.gitbook.io/ekom/readme.md)
