orders — module reference

Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.

Module id	orders
Name	Orders
Version	1.3.0
Ships from	@endora-commerce/mod-orders
Licence	MIT

Activation

This module cannot be switched off. The order is the transaction this platform exists to record.

Dependencies

Module	Binding	What it means
addresses	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
admin_roles	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
admin_users	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
api_keys	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
assets_library	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
catalog	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
customer_accounts	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
organizations	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
price_lists	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
sales_channels	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
settings	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
taxes	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
transactional_emails	yes	installs and migrates after it, and an operator cannot switch it off underneath this module
carts	gating only	resolves cartPlacementApplyPort; withheld from dependencies because the install order cannot carry the edge
carts	gating only	resolves cartReadPort; withheld from dependencies because the install order cannot carry the edge
carts	gating only	resolves cartWritePort; withheld from dependencies because the install order cannot carry the edge
credit_limits	no	refuses-without creditLimitService — no order can be placed against a credit limit, and an order that drew one can be neither cancelled nor marked paid, because its reservation cannot be released; every other order is unaffected
delivery_methods	no	degrades-without deliveryMethodReadPort — the admin create-order preview quotes no delivery cost, because there is no method catalogue to quote one from
delivery_methods	no	degrades-without shippingAdapterRegistry — checkout offers no delivery method to choose from
inventory	no	degrades-without inventoryFulfilmentPlanningPort — orders are placed without reserving stock
inventory	no	degrades-without inventoryReservationApplyPort — orders are placed without reserving stock, and a cancelled order releases none until the module is switched back on
inventory	no	degrades-without inventoryStockReadPort — orders are placed without reserving stock
invoices	no	degrades-without invoicePdfPort — an order’s invoice PDF is no longer offered; nothing else about an order changes
invoices	no	degrades-without invoicePlacementApplyPort — an order is placed without a proforma document; nothing else about the order changes
invoices	no	degrades-without invoiceReadPort — an order’s invoice PDF is no longer offered; nothing else about an order changes
payment_methods	no	degrades-without paymentAdapterRegistry — checkout offers no payment method to choose from
payment_methods	no	degrades-without paymentMethodReadPort — the admin create-order preview quotes no payment surcharge, because there is no method catalogue to quote one from
payment_methods	no	degrades-without paymentOrderStatusRegistry — checkout offers no payment method to choose from
payments	no	degrades-without paymentEmailRendererPort — the order confirmation still goes out, with the payment line written from the method snapshot instead of a gateway’s own wording
payments	no	refuses-without paymentPlacementApplyPort — the shop takes no orders at all: no payment method is left to choose, and a placement reaching checkout anyway is refused rather than recorded unpaid
promotions	no	refuses-without promotionService — no order can be placed or previewed at all — the discount total is recomputed through the promotion engine on every checkout, not only on a discounted basket
promotions	no	refuses-without promotionUsageFinalizer — a basket carrying a discount cannot become an order — the redemption row is written inside the placement transaction, so the order rolls back with it
prompt_actions	no	contributes-to promptActionToolRegistry
quote_requests	no	refuses-without rfqService — an order cannot be turned back into a quote — the reorder-as-quote action on the order screen refuses, and every other order surface keeps serving
shipments	no	degrades-without shippingEmailRendererPort — the order confirmation still goes out, with the delivery line written from the method snapshot instead of a carrier’s own wording

Permissions

None.

Command palette

Action	Opens	Permission
open-orders	/orders	orders:read
order-statuses	/orders/statuses	orders:read

Settings

Code	Name	Type
orders.business_id.prefix	Business Order ID prefix	string
orders.business_id.suffix	Business Order ID suffix	string
orders.confirmation_recipients	Order confirmation recipients	string_list
orders.min_order_value	Minimum order value	number
orders.reorder_enabled	Reordering enabled	boolean

Translations

Bundles at i18n inside the module, one file per shipped language.

Operator commands

None.