eCommerce
Online store
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. There is no payment provider: an order starts as pending and the shop contacts the buyer. 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.
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 |
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. Orders do not reduce it: adjust it by hand |
published | bool | none | no | ecommerce.user | in clear | Whether the listing is visible to shoppers |
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 (kept up to date by hand) |
minimum_order | money | none | no | ecommerce.user | in clear | Smallest order total the code applies to (minor currency units) |
active | bool | none | no | ecommerce.user | in clear | Whether the code can be used |
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 |
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 (minor currency units, entered not computed) |
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 | Tax included in the total (minor currency units) |
total | money | none | no | ecommerce.user | in clear | Amount the shopper pays (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) |
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 |
Permission groups
Groups used by this app:
ecommerce.managerecommerce.user
Approval steps
Steps an agent can only propose:
ecommerce_order.refundecommerce_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_translation.delete, ecommerce_shipping_method.delete, ecommerce_discount_code.delete, ecommerce_order.delete, ecommerce_order_line.delete.
Personal data is masked as placeholder tokens: ecommerce_order.customer_email, ecommerce_order.customer_name, ecommerce_order.shipping_address, ecommerce_order.billing_address.
These fields are withheld from agents entirely: ecommerce_order.payment_reference, ecommerce_order.access_token.
Dependencies
baseproduct
Install
Install it from the Customize app (Marketplace), or from the command line:
obop modules install-from ecommerceNeeds a database and administrator rights.