---
title: "eCommerce"
description: "Online store. Store the data of an online shop: listings, shipping methods, discount codes and web orders with a fulfilment flow."
canonical: "https://obop.dev/apps/ecommerce/"
lang: "en"
---

# eCommerce

## What it is for

Store the data of an online shop: listings, shipping methods, discount codes and web orders with a fulfilment flow. Refunds need a manager and an approval. A storefront or other client reads and writes this data through the API.

## What the package does and does not do

An online shop: categories, product listings with translations, shipping methods, discount codes, web orders with lines and a fulfilment flow of pending, paid, shipped, delivered, cancelled and refunded. When the instance runs with the public site enabled, visitors browse the published listings and place orders without an account; the server prices every order from the published listing and never trusts the browser. Orders take stock off the listing at checkout, apply discount codes and tax rates on the server, and are paid by bank transfer, by card through Stripe Checkout or in a local demo mode; the payment record, the provider reference and refunds are kept with the order. Refunds need a human approval from a manager; agents may only propose them. Customer name, email and addresses are personal data and are never public. Needs the Products package.

## Module details

- **Version:** `0.5.0`
- **Author:** SpaceCorps
- **Licence:** [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html)
- **Needs core:** `^0.2` (core 0.2.0 is current)
- **Maturity:** Beta
- **Categories:** Sales

## Models

### `ecommerce_category`

A group of listings shown together in the shop

Read group: `ecommerce.user`. Write group: `ecommerce.manager`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `name` | text | `none` | no | `ecommerce.user` | in clear | Category name shown in the shop |
| `slug` | text | `none` | no | `ecommerce.user` | in clear | URL part of the category, lowercase with dashes |
| `description` | text | `none` | no | `ecommerce.user` | in clear | Short text about the category |
| `sequence` | number | `none` | no | `ecommerce.user` | in clear | Order among categories, lowest first |
| `published` | bool | `none` | no | `ecommerce.user` | in clear | Whether the category is visible to shoppers |

### `ecommerce_listing`

A product as it appears in the online shop

Read group: `ecommerce.user`. Write group: `ecommerce.manager`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `product_id` | ref → product | `none` | no | `ecommerce.user` | in clear | The product being sold online |
| `title` | text | `none` | no | `ecommerce.user` | in clear | Title shown in the shop |
| `slug` | text | `none` | no | `ecommerce.user` | in clear | URL part of the product page, lowercase with dashes |
| `summary` | text | `none` | no | `ecommerce.user` | in clear | One or two sentences shown on product cards |
| `description` | longtext | `none` | no | `ecommerce.user` | in clear | Description shown on the product page, in Markdown |
| `image` | image | `none` | no | `ecommerce.user` | in clear | Main picture of the product (PNG, JPEG, WebP or GIF, up to 5 MiB; it is re-encoded and its metadata removed on upload) |
| `image_alt` | text | `none` | no | `ecommerce.user` | in clear | Text that describes the main picture for people who cannot see it |
| `category_id` | ref → ecommerce_category | `none` | no | `ecommerce.user` | in clear | The category the listing is shown under |
| `price` | money | `none` | no | `ecommerce.user` | in clear | Shop price including tax (minor currency units, e.g. cents) |
| `compare_at_price` | money | `none` | no | `ecommerce.user` | in clear | Previous price shown crossed out (minor currency units) |
| `currency` | text | `none` | no | `ecommerce.user` | in clear | ISO 4217 currency code of the prices, for example EUR; empty means the shop currency from the instance settings |
| `sku` | text | `none` | no | `ecommerce.user` | in clear | Stock keeping unit shown on the product page |
| `stock_policy` | select (always_available, block_when_out, allow_backorder) | `none` | no | `ecommerce.user` | in clear | What happens when stock runs out: always_available, block_when_out, allow_backorder |
| `stock_quantity` | number | `none` | no | `ecommerce.user` | in clear | Units on hand, used with the stock policy. Every order takes its units off at checkout, and a cancelled, expired or refunded order puts them back; correct it by hand after a stock count |
| `published` | bool | `none` | no | `ecommerce.user` | in clear | Whether the listing is visible to shoppers |

### `ecommerce_listing_image`

An extra picture of a listing for its gallery

Read group: `ecommerce.user`. Write group: `ecommerce.manager`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `listing_id` | ref → ecommerce_listing | `none` | no | `ecommerce.user` | in clear | The listing the picture belongs to; it is shown only while the listing is published |
| `image` | image | `none` | no | `ecommerce.user` | in clear | The picture (PNG, JPEG, WebP or GIF, up to 5 MiB) |
| `alt` | text | `none` | no | `ecommerce.user` | in clear | Text that describes the picture for people who cannot see it |
| `sequence` | number | `none` | no | `ecommerce.user` | in clear | Order in the gallery, lowest first |
| `published` | bool | `none` | no | `ecommerce.user` | in clear | Whether the picture is shown in the shop |

### `ecommerce_listing_translation`

A listing translated into another language

Read group: `ecommerce.user`. Write group: `ecommerce.manager`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `listing_id` | ref → ecommerce_listing | `none` | no | `ecommerce.user` | in clear | The listing this translates |
| `lang` | select (en, de, fr, pl, fi, sv, es) | `none` | no | `ecommerce.user` | in clear | Language of the translation: en, de, fr, pl, fi, sv or es |
| `title` | text | `none` | no | `ecommerce.user` | in clear | Translated title |
| `summary` | text | `none` | no | `ecommerce.user` | in clear | Translated card text |
| `description` | longtext | `none` | no | `ecommerce.user` | in clear | Translated description in Markdown |
| `published` | bool | `none` | no | `ecommerce.user` | in clear | Whether the translation is shown; it is only reachable while its listing is published |

### `ecommerce_shipping_method`

A way of delivering orders with its price

Read group: `ecommerce.user`. Write group: `ecommerce.manager`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `name` | text | `none` | no | `ecommerce.user` | in clear | Name shown at checkout, for example Standard delivery |
| `carrier` | text | `none` | no | `ecommerce.user` | in clear | Carrier that delivers, for example DHL |
| `price` | money | `none` | no | `ecommerce.user` | in clear | Delivery price (minor currency units) |
| `free_over` | money | `none` | no | `ecommerce.user` | in clear | Order total above which delivery is free (minor currency units); empty means never |
| `delivery_days` | number | `none` | no | `ecommerce.user` | in clear | Usual number of days until delivery |
| `active` | bool | `none` | no | `ecommerce.user` | in clear | Whether shoppers can choose it |

### `ecommerce_discount_code`

A code a shopper enters at checkout for a reduction

Read group: `ecommerce.user`. Write group: `ecommerce.manager`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `code` | text | `none` | no | `ecommerce.user` | in clear | The code shoppers type, for example SPRING10 |
| `kind` | select (percent, fixed) | `none` | no | `ecommerce.user` | in clear | Type of reduction: percent or fixed |
| `value` | number | `none` | no | `ecommerce.user` | in clear | Reduction: basis points for percent (1000 is 10.00 percent), minor currency units for fixed |
| `starts_on` | date | `none` | no | `ecommerce.user` | in clear | First day the code works (YYYY-MM-DD) |
| `ends_on` | date | `none` | no | `ecommerce.user` | in clear | Last day the code works (YYYY-MM-DD) |
| `max_uses` | number | `none` | no | `ecommerce.user` | in clear | How many times the code may be used in total; empty means unlimited |
| `used_count` | number | `none` | no | `ecommerce.user` | in clear | How many times it has been used. The shop counts a use when the order is placed and gives it back when the order is cancelled or never paid |
| `minimum_order` | money | `none` | no | `ecommerce.user` | in clear | Smallest order total the code applies to (minor currency units) |
| `per_customer_limit` | number | `none` | no | `ecommerce.user` | in clear | How many times one customer (by email address) may use the code; empty means no limit |
| `category_id` | ref → ecommerce_category | `none` | no | `ecommerce.user` | in clear | Only listings of this category get the reduction; empty means the whole order |
| `active` | bool | `none` | no | `ecommerce.user` | in clear | Whether the code can be used |

### `ecommerce_discount_use`

How many times one customer has used one discount code (the customer is kept as a hash, never as an email address)

Read group: `ecommerce.manager`. Write group: `ecommerce.manager`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `code_id` | ref → ecommerce_discount_code | `none` | no | `ecommerce.manager` | in clear | The discount code |
| `customer_hash` | text | `internal` | yes | `ecommerce.manager` | masked | Hash of the customer's email address, so the per-customer limit can be checked without keeping the address here |
| `count` | number | `none` | no | `ecommerce.manager` | in clear | Uses so far |

### `ecommerce_tax_rate`

A tax rate the shop applies to listings, computed on the server

Read group: `ecommerce.user`. Write group: `ecommerce.manager`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `name` | text | `none` | no | `ecommerce.user` | in clear | Name shown on the order, for example VAT |
| `rate_bp` | number | `none` | no | `ecommerce.user` | in clear | Rate in basis points: 1900 is 19.00 percent |
| `country` | text | `none` | no | `ecommerce.user` | in clear | Two-letter country code (for example DE) of the delivery address this rate is for; empty means every country that has no rate of its own |
| `category_id` | ref → ecommerce_category | `none` | no | `ecommerce.user` | in clear | Only listings of this category; empty means every listing (and delivery) |
| `included` | bool | `none` | no | `ecommerce.user` | in clear | Whether listing prices already include this tax (the usual way in the EU). If not, the tax is added on top at checkout |
| `active` | bool | `none` | no | `ecommerce.user` | in clear | Whether the rate is applied |

### `ecommerce_order`

An order placed online

Read group: `ecommerce.user`. Write group: `ecommerce.user`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `number` | text | `none` | no | `ecommerce.user` | in clear | Order number shown to the shopper. Free text: packages cannot generate sequences; the public checkout makes a random one |
| `customer_email` | text | `internal` | yes | `ecommerce.user` | masked | Email address of the shopper |
| `customer_name` | text | `internal` | yes | `ecommerce.user` | masked | Name of the shopper |
| `customer_id` | ref → party | `none` | no | `ecommerce.user` | in clear | The matching contact, once the shopper is known |
| `shipping_address` | longtext | `internal` | yes | `ecommerce.user` | masked | Delivery address |
| `billing_address` | longtext | `internal` | yes | `ecommerce.user` | masked | Billing address when different from delivery |
| `shipping_method_id` | ref → ecommerce_shipping_method | `none` | no | `ecommerce.user` | in clear | The chosen way of delivery |
| `discount_code_id` | ref → ecommerce_discount_code | `none` | no | `ecommerce.user` | in clear | The discount code used, if any |
| `discount_code` | text | `none` | no | `ecommerce.user` | in clear | The code the shopper entered, as it is shown on the order |
| `discount_use_id` | text | `internal` | yes | `ecommerce.user` | masked | Which per-customer use counter this order counted against, so it can be given back |
| `country` | text | `internal` | yes | `ecommerce.user` | masked | Two-letter country code of the delivery address, which decides the tax rate |
| `tax_summary` | longtext | `none` | no | `ecommerce.user` | in clear | The tax lines of the order as JSON: name, rate in basis points, whether included in the prices, amount |
| `stock_returned` | bool | `none` | no | `ecommerce.user` | in clear | Set when the units of a cancelled, expired or refunded order were put back on the listings, so it happens once |
| `reserved_until` | number | `none` | no | `ecommerce.user` | in clear | Unix time until which an unpaid order holds its stock; after that it is cancelled and the stock goes back |
| `payment_method` | select (manual, stripe, fake) | `none` | no | `ecommerce.user` | in clear | How the shopper chose to pay: manual (bank transfer or invoice), stripe (card) or fake (demo) |
| `placed_on` | date | `none` | no | `ecommerce.user` | in clear | Day the order was placed (YYYY-MM-DD) |
| `currency` | text | `none` | no | `ecommerce.user` | in clear | ISO 4217 currency code, for example EUR |
| `subtotal` | money | `none` | no | `ecommerce.user` | in clear | Sum of the lines at listing prices (minor currency units, computed by the shop at checkout) |
| `discount_total` | money | `none` | no | `ecommerce.user` | in clear | Reduction from the discount code (minor currency units) |
| `shipping_total` | money | `none` | no | `ecommerce.user` | in clear | Delivery charge (minor currency units) |
| `tax_total` | money | `none` | no | `ecommerce.user` | in clear | All tax on the order, both the part included in the prices and the part added on top (minor currency units) |
| `total` | money | `none` | no | `ecommerce.user` | in clear | Amount the shopper pays: lines, minus the discount, plus delivery, plus tax that was added on top (minor currency units) |
| `payment_reference` | text | `financial` | yes | `ecommerce.user` | withheld | Reference from the payment provider; never a card number |
| `tracking_reference` | text | `none` | no | `ecommerce.user` | in clear | Carrier tracking number |
| `access_token` | text | `secret` | no | `ecommerce.user` | withheld | Secret link token that lets the shopper who placed a public order see its confirmation page. Nobody can read it back |
| `state` | select (pending, paid, shipped, delivered, cancelled, refunded) | `none` | no | `ecommerce.user` | in clear | Fulfilment status: pending, paid, shipped, delivered, cancelled, refunded |

### `ecommerce_order_line`

One product line of a web order

Read group: `ecommerce.user`. Write group: `ecommerce.user`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `order_id` | ref → ecommerce_order | `none` | no | `ecommerce.user` | in clear | The order the line belongs to |
| `product_id` | ref → product | `none` | no | `ecommerce.user` | in clear | The product ordered |
| `listing_id` | ref → ecommerce_listing | `none` | no | `ecommerce.user` | in clear | The shop listing the line was ordered from |
| `description` | text | `none` | no | `ecommerce.user` | in clear | Product text as it was when ordered |
| `quantity` | number | `none` | no | `ecommerce.user` | in clear | Units ordered |
| `unit_price` | money | `none` | no | `ecommerce.user` | in clear | Price per unit including tax (minor currency units) |
| `subtotal` | money | `none` | no | `ecommerce.user` | in clear | Line total (minor currency units, entered not computed) |
| `discount_amount` | money | `none` | no | `ecommerce.user` | in clear | Part of the order discount that falls on this line (minor currency units) |
| `tax_name` | text | `none` | no | `ecommerce.user` | in clear | Name of the tax applied to this line |
| `tax_rate_bp` | number | `none` | no | `ecommerce.user` | in clear | Tax rate of this line in basis points |
| `tax_amount` | money | `none` | no | `ecommerce.user` | in clear | Tax on this line, included in the prices or added on top (minor currency units) |

### `ecommerce_payment`

A payment for a web order: which provider, its reference, the amount and what became of it. The shop never sees card data

Read group: `ecommerce.user`. Write group: `ecommerce.manager`.

| Field | Kind | Data class | Personal data | Group | Agents see | Description |
|---|---|---|---|---|---|---|
| `order_id` | ref → ecommerce_order | `none` | no | `ecommerce.user` | in clear | The order being paid |
| `provider` | select (manual, stripe, fake) | `none` | no | `ecommerce.user` | in clear | Who takes the payment: manual (bank transfer or invoice), stripe (Stripe Checkout) or fake (local demo) |
| `external_id` | text | `financial` | no | `ecommerce.user` | withheld | The provider's reference for this payment, for example a Stripe Checkout Session id. Never a card number |
| `checkout_url` | text | `financial` | no | `ecommerce.user` | withheld | Where the shopper pays, kept so the payment page can send them back to it while the payment is open |
| `state` | select (open, succeeded, failed, expired, cancelled, refunded) | `none` | no | `ecommerce.user` | in clear | Payment status: open (waiting for the shopper), succeeded, failed, expired, cancelled, refunded |
| `amount` | money | `none` | no | `ecommerce.user` | in clear | Amount to pay, set by the server from the order (minor currency units) |
| `currency` | text | `none` | no | `ecommerce.user` | in clear | ISO 4217 currency code of the amount |
| `refund_id` | text | `financial` | no | `ecommerce.user` | withheld | The provider's reference for the refund, once the payment was refunded |
| `refunded_amount` | money | `none` | no | `ecommerce.user` | in clear | Amount returned to the shopper (minor currency units) |
| `event_ids` | longtext | `none` | no | `ecommerce.user` | in clear | Ids of the provider events already applied, as JSON, so a repeated notification changes nothing |

## Workflows

### `ecommerce_order`

| Action | Moves | Who may run it | Approval |
|---|---|---|---|
| `ecommerce_order.mark_paid` | state: pending → paid | `ecommerce.user` | no |
| `ecommerce_order.ship` | state: paid → shipped | `ecommerce.user` | no |
| `ecommerce_order.deliver` | state: shipped → delivered | `ecommerce.user` | no |
| `ecommerce_order.cancel` | state: pending → cancelled | `ecommerce.user` | no |
| `ecommerce_order.refund` | state: paid → refunded | `ecommerce.manager` | yes |
| `ecommerce_order.refund_delivered` | state: delivered → refunded | `ecommerce.manager` | yes |

### `ecommerce_payment`

| Action | Moves | Who may run it | Approval |
|---|---|---|---|
| `ecommerce_payment.mark_failed` | state: open → failed | `ecommerce.manager` | no |
| `ecommerce_payment.cancel` | state: open → cancelled | `ecommerce.manager` | no |

## Permission groups

Groups used by this app:

- `ecommerce.manager`
- `ecommerce.user`

## Approval steps

Steps an agent can only propose:

- `ecommerce_order.refund`
- `ecommerce_order.refund_delivered`

## What agents can and cannot do

An agent can read, search, create and update records of this app, and run the actions that need no approval, within the permission groups of its token.

It can only propose these steps, and a person must approve them: `ecommerce_order.refund`, `ecommerce_order.refund_delivered`, `ecommerce_category.delete`, `ecommerce_listing.delete`, `ecommerce_listing_image.delete`, `ecommerce_listing_translation.delete`, `ecommerce_shipping_method.delete`, `ecommerce_discount_code.delete`, `ecommerce_discount_use.delete`, `ecommerce_tax_rate.delete`, `ecommerce_order.delete`, `ecommerce_order_line.delete`, `ecommerce_payment.delete`.

Personal data is masked as placeholder tokens: `ecommerce_discount_use.customer_hash`, `ecommerce_order.customer_email`, `ecommerce_order.customer_name`, `ecommerce_order.shipping_address`, `ecommerce_order.billing_address`, `ecommerce_order.discount_use_id`, `ecommerce_order.country`.

These fields are withheld from agents entirely: `ecommerce_order.payment_reference`, `ecommerce_order.access_token`, `ecommerce_payment.external_id`, `ecommerce_payment.checkout_url`, `ecommerce_payment.refund_id`.

## Dependencies

Each dependency states the versions it accepts. Built-in apps version with the core, so a requirement on one is checked against the core version.

- [Contacts](/apps/contacts/): `^0.2` (built in)
- [Products](/apps/products/): `^0.2` (built in)

Installing this app from the marketplace also installs the dependencies it is missing, in one plan that you confirm once.

## Install

Install it from the Customize app (Marketplace), or from the command line:

```bash
obop modules install-from ecommerce
```

Needs a database and administrator rights.

## Build your own

[The module guide shows how apps like this one are written](/docs/reference/module-manifest/)