Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
import { ORDER_PAYMENT_STATUSES } from '@spree/core'
import {
defineTable,
FILTERABLE_ORDER_FULFILLMENT_STATUSES,
LocaleLabel,
Money,
} from '@spree/dashboard-core'
import { RelativeTime, StatusBadge, TagList } from '@spree/dashboard-ui'
import { ShoppingCartIcon } from '@spree/dashboard-ui/icons'
import { Link } from '@tanstack/react-router'
import i18n from 'i18next'
import { channelAutocompleteProps } from '../hooks/use-channels'
import { customerAutocompleteProps } from '../hooks/use-customers'
import { marketAutocompleteProps } from '../hooks/use-markets'
import { sellerAutocompleteProps } from '../hooks/use-sellers'
import { orderGroupSearch } from '../lib/order-group-search'
/**
* Localized label for an order status code, resolved from the given namespace
* (`payment_statuses`, `fulfillment_statuses`, `statuses`) with the humanized
* code as a fallback for any value without a translation.
*/
function statusLabel(namespace: string, status: string): string {
const key = `admin.orders.${namespace}.${status}`
return i18n.exists(key) ? i18n.t(key) : status.replace(/_/g, ' ')
}
defineTable('orders', {
title: i18n.t('admin.nav.orders'),
docsPath: 'orders/processing-orders',
description: i18n.t('admin.table_descriptions.orders'),
searchParam: 'search',
searchPlaceholder: i18n.t('admin.orders.table.search_placeholder'),
defaultSort: { field: 'completed_at', direction: 'desc' },
emptyIcon: <ShoppingCartIcon className="size-8 text-muted-foreground" />,
emptyMessage: i18n.t('admin.orders.table.empty'),
columns: [
{
key: 'number',
label: i18n.t('admin.orders.columns.number'),
sortable: true,
default: true,
render: (order) => (
<Link
to={'/$storeId/orders/$orderId' as string}
params={{ orderId: order.id }}
className="font-medium text-foreground no-underline"
>
#{order.number}
</Link>
),
},
{
key: 'completed_at',
label: i18n.t('admin.orders.columns.date'),
sortable: true,
filterable: true,
default: true,
filterType: 'date',
quickFilter: true,
className: 'text-sm text-muted-foreground whitespace-nowrap',
render: (order) => <RelativeTime iso={order.completed_at} />,
},
{
key: 'email',
label: i18n.t('admin.orders.columns.customer'),
sortable: true,
filterable: true,
// Picked from a list rather than typed: an operator looking for one
// customer's orders knows who they mean, not how their address is
// spelled. Filters through the `customer` association's id — `email` is
// what the column *shows*, but matching it as free text would also miss
// a guest order placed under a second address.
filterType: 'resource',
filterResource: customerAutocompleteProps('orders-table-customer-filter'),
ransackAttribute: 'customer_id',
default: true,
className: 'text-sm',
render: (order) => order.email ?? '—',
},
{
key: 'channel',
label: i18n.t('admin.fields.order.channel.label'),
filterable: true,
filterType: 'resource',
filterResource: channelAutocompleteProps(),
ransackAttribute: 'channel_id',
default: true,
className: 'text-sm text-muted-foreground',
render: (order) => order.channel?.name ?? '—',
},
{
key: 'payment_status',
label: i18n.t('admin.orders.columns.payment'),
sortable: true,
filterable: true,
default: true,
filterType: 'enum',
filterOptions: ORDER_PAYMENT_STATUSES.map((status) => ({
value: status,
label: i18n.t(`admin.orders.payment_statuses.${status}`),
})),
quickFilter: true,
render: (order) =>
order.payment_status ? (
<StatusBadge
status={order.payment_status}
label={statusLabel('payment_statuses', order.payment_status)}
/>
) : (
'—'
),
},
{
key: 'fulfillment_status',
label: i18n.t('admin.orders.columns.fulfillment'),
sortable: true,
filterable: true,
default: true,
filterType: 'enum',
filterOptions: FILTERABLE_ORDER_FULFILLMENT_STATUSES.map((status) => ({
value: status,
label: i18n.t(`admin.orders.fulfillment_statuses.${status}`),
})),
quickFilter: true,
render: (order) =>
order.fulfillment_status ? (
<StatusBadge
status={order.fulfillment_status}
label={statusLabel('fulfillment_statuses', order.fulfillment_status)}
/>
) : (
'—'
),
},
{
key: 'total_quantity',
label: i18n.t('admin.orders.columns.items'),
sortable: true,
default: true,
className: 'text-right tabular-nums text-sm text-muted-foreground',
render: (order) => {
const count = order.total_quantity ?? 0
return i18n.t('admin.orders.item_count', { count })
},
},
{
key: 'total',
label: i18n.t('admin.fields.total.label'),
sortable: true,
filterable: true,
default: true,
filterType: 'number',
className: 'text-right tabular-nums whitespace-nowrap font-medium',
render: (order) => <Money amount={order.total} currency={order.currency} />,
},
// Off by default — most stores never see one — but a B2B merchant turns it
// on and reconciles against the buyer's own reference.
{
key: 'po_number',
label: i18n.t('admin.orders.columns.po_number'),
sortable: true,
filterable: true,
default: false,
className: 'text-sm text-muted-foreground',
render: (order) => order.po_number ?? '—',
},
{
key: 'currency',
label: i18n.t('admin.fields.currency.label'),
sortable: true,
filterable: true,
filterType: 'currency',
default: false,
render: (order) => order.currency ?? '—',
},
{
key: 'market',
label: i18n.t('admin.fields.order.market.label'),
filterable: true,
filterType: 'resource',
filterResource: marketAutocompleteProps(),
ransackAttribute: 'market_id',
default: false,
className: 'text-sm text-muted-foreground',
render: (order) => order.market?.name ?? '—',
},
{
key: 'locale',
label: i18n.t('admin.fields.order.locale.label'),
sortable: true,
filterable: true,
filterType: 'locale',
default: false,
className: 'text-sm text-muted-foreground',
render: (order) => (order.locale ? <LocaleLabel code={order.locale} /> : '—'),
},
// On a marketplace this list holds the operator's own orders and every
// seller's together, so a row has to say which it is — shown by default
// for the same reason the products and stock-locations lists show it. A
// dash means the order is the marketplace's own, matching how the other
// columns render an absent value.
{
key: 'seller',
label: i18n.t('admin.fields.order.seller.label'),
filterable: true,
filterType: 'resource',
filterResource: sellerAutocompleteProps('orders-table-seller-filter'),
ransackAttribute: 'seller_id',
// Requested only while the column is on — ResourceTable unions the
// expands of visible columns into the list request.
expand: 'seller',
default: true,
render: (order) =>
order.seller_id ? (
<Link
to={'/$storeId/sellers/$sellerId' as string}
params={{ sellerId: order.seller_id }}
className="no-underline"
>
{order.seller?.name ?? order.seller_id}
</Link>
) : (
'—'
),
},
// Which purchase this order was part of, when a basket spanning several
// sellers became several orders. Clicking it narrows the list to that
// purchase's orders.
{
key: 'order_group',
label: i18n.t('admin.fields.order.order_group.label'),
// Not filterable by hand: the value is an opaque id, so the panel's text
// operators ("contains", "starts with") match it by substring and find
// nothing useful. The column is reached by clicking through from an
// order, which builds the `eq` rule this actually needs.
ransackAttribute: 'order_group_id',
default: false,
className: 'text-sm text-muted-foreground',
render: (order) =>
order.order_group_id ? (
<Link
to={'/$storeId/orders' as string}
search={orderGroupSearch(order.order_group_id)}
className="no-underline"
>
{i18n.t('admin.fields.order.order_group.view')}
</Link>
) : (
'—'
),
},
// No `status` column: its three values are already answered elsewhere.
// Draft orders have their own page (scoped server-side by `incomplete`),
// and cancellation reads off `fulfillment_status`. A filter offering
// "draft" on a list that has already been split by that distinction only
// invites the operator to wonder which of the two they are looking at.
{
key: 'tags',
label: i18n.t('admin.orders.columns.tags'),
sortable: false,
filterable: true,
filterType: 'tags',
taggableType: 'order',
default: false,
render: (order) => <TagList tags={order.tags} />,
},
// Filter-only columns
{
key: 'first_name',
label: i18n.t('admin.fields.first_name.label'),
filterable: true,
displayable: false,
ransackAttribute: 'bill_address_first_name',
},
{
key: 'last_name',
label: i18n.t('admin.fields.last_name.label'),
filterable: true,
displayable: false,
ransackAttribute: 'bill_address_last_name',
},
{
key: 'sku',
label: i18n.t('admin.orders.columns.sku'),
filterable: true,
displayable: false,
ransackAttribute: 'line_items_variant_sku',
},
],
})