Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Fix resolving a claim, and link post-sale records to their order

Damian Legawiec0177421df4bf
diff --git a/packages/dashboard/src/components/spree/order-post-sale-cards.tsx b/packages/dashboard/src/components/spree/order-post-sale-cards.tsx
index 016b9f53f8..9d2f96483b 100644
--- a/packages/dashboard/src/components/spree/order-post-sale-cards.tsx
+++ b/packages/dashboard/src/components/spree/order-post-sale-cards.tsx
@@ -57,14 +57,22 @@ export function OrderExchangesCard({ order }: { order: Order }) {
{t('admin.pages.orders.detail.section_exchanges')}
{exchanges.length > 0 && <Badge variant="outline">{exchanges.length}</Badge>}
</CardTitle>
- {canCreate && (
- <CardAction>
- <Button variant="outline" size="sm" onClick={() => setCreating(true)}>
- <PlusIcon className="size-4" />
- {t('admin.pages.orders.detail.exchanges.actions.create')}
- </Button>
- </CardAction>
- )}
+ <CardAction>
+ <Button
+ variant="outline"
+ size="sm"
+ disabled={!canCreate}
+ title={
+ canCreate
+ ? undefined
+ : t('admin.pages.orders.detail.returns.empty_nothing_fulfilled')
+ }
+ onClick={() => setCreating(true)}
+ >
+ <PlusIcon className="size-4" />
+ {t('admin.pages.orders.detail.exchanges.actions.create')}
+ </Button>
+ </CardAction>
</CardHeader>
<CardContent className="flex flex-col gap-4">
{exchanges.length === 0 && (
@@ -195,14 +203,17 @@ export function OrderClaimsCard({ order }: { order: Order }) {
{t('admin.pages.orders.detail.section_claims')}
{claims.length > 0 && <Badge variant="outline">{claims.length}</Badge>}
</CardTitle>
- {canCreate && (
- <CardAction>
- <Button variant="outline" size="sm" onClick={() => setCreatingClaim(true)}>
- <PlusIcon className="size-4" />
- {t('admin.pages.orders.detail.claims.actions.create')}
- </Button>
- </CardAction>
- )}
+ <CardAction>
+ <Button
+ variant="outline"
+ size="sm"
+ disabled={!canCreate}
+ onClick={() => setCreatingClaim(true)}
+ >
+ <PlusIcon className="size-4" />
+ {t('admin.pages.orders.detail.claims.actions.create')}
+ </Button>
+ </CardAction>
</CardHeader>
<CardContent className="flex flex-col gap-4">
{claims.length === 0 && (
diff --git a/packages/dashboard/src/components/spree/order-returns-card.tsx b/packages/dashboard/src/components/spree/order-returns-card.tsx
index c6fab09d54..2357cd5bc1 100644
--- a/packages/dashboard/src/components/spree/order-returns-card.tsx
+++ b/packages/dashboard/src/components/spree/order-returns-card.tsx
@@ -84,14 +84,22 @@ export function OrderReturnsCard({ order }: { order: Order }) {
{t('admin.pages.orders.detail.section_returns')}
{returns.length > 0 && <Badge variant="outline">{returns.length}</Badge>}
</CardTitle>
- {canCreate && (
- <CardAction>
- <Button variant="outline" size="sm" onClick={() => setCreating(true)}>
- <PlusIcon className="size-4" />
- {t('admin.pages.orders.detail.returns.actions.create')}
- </Button>
- </CardAction>
- )}
+ <CardAction>
+ <Button
+ variant="outline"
+ size="sm"
+ disabled={!canCreate}
+ title={
+ canCreate
+ ? undefined
+ : t('admin.pages.orders.detail.returns.empty_nothing_fulfilled')
+ }
+ onClick={() => setCreating(true)}
+ >
+ <PlusIcon className="size-4" />
+ {t('admin.pages.orders.detail.returns.actions.create')}
+ </Button>
+ </CardAction>
</CardHeader>
<CardContent className="flex flex-col gap-4">
{returns.length === 0 && (
diff --git a/packages/dashboard/src/components/spree/post-sale-create-dialogs.tsx b/packages/dashboard/src/components/spree/post-sale-create-dialogs.tsx
index a0d866396b..c757c974c2 100644
--- a/packages/dashboard/src/components/spree/post-sale-create-dialogs.tsx
+++ b/packages/dashboard/src/components/spree/post-sale-create-dialogs.tsx
@@ -261,7 +261,12 @@ export function CreateClaimDialog({
order: Order
onClose: () => void
onSubmit: (params: {
- items: Array<{ line_item_id: string; quantity: number; description?: string }>
+ items: Array<{
+ line_item_id: string
+ quantity: number
+ description?: string
+ refund_amount?: string
+ }>
claim_type: string
memo?: string
}) => void
@@ -269,6 +274,7 @@ export function CreateClaimDialog({
const { t } = useTranslation()
const items = order.items ?? []
const [selection, setSelection] = useState<Selection>({})
+ const [amounts, setAmounts] = useState<Record<string, string>>({})
const [claimType, setClaimType] = useState<string>('damaged')
const [memo, setMemo] = useState('')
@@ -303,15 +309,59 @@ export function CreateClaimDialog({
</Select>
</Field>
- <QuantityPicker
- units={items.map((item) => ({
- id: item.id,
- label: [item.name, item.options_text].filter(Boolean).join(' — ') || item.id,
- quantity: item.quantity,
- }))}
- selection={selection}
- onChange={setSelection}
- />
+ <div className="flex flex-col gap-2">
+ {items.map((item) => {
+ const label = [item.name, item.options_text].filter(Boolean).join(' — ') || item.id
+ const chosenQuantity = selection[item.id] ?? 0
+
+ return (
+ <div key={item.id} className="flex flex-col gap-2 rounded-lg border p-3">
+ <div className="flex items-center justify-between gap-4">
+ <span className="text-sm truncate">{label}</span>
+ <Input
+ type="number"
+ min={0}
+ max={item.quantity}
+ className="w-20"
+ value={chosenQuantity}
+ onChange={(event) => {
+ const quantity = Math.max(
+ 0,
+ Math.min(Number(event.target.value), item.quantity),
+ )
+ setSelection({ ...selection, [item.id]: quantity })
+ // Default the refund to what was paid for those units;
+ // the merchant can still overwrite it.
+ if (quantity > 0 && !amounts[item.id]) {
+ const unitPrice = Number(item.price)
+ if (Number.isFinite(unitPrice)) {
+ setAmounts((current) => ({
+ ...current,
+ [item.id]: (unitPrice * quantity).toFixed(2),
+ }))
+ }
+ }
+ }}
+ />
+ </div>
+ {chosenQuantity > 0 && (
+ <Field>
+ <FieldLabel htmlFor={`claim-amount-${item.id}`}>
+ {t('admin.pages.orders.detail.claims.refund_amount')}
+ </FieldLabel>
+ <Input
+ id={`claim-amount-${item.id}`}
+ value={amounts[item.id] ?? ''}
+ onChange={(event) =>
+ setAmounts({ ...amounts, [item.id]: event.target.value })
+ }
+ />
+ </Field>
+ )}
+ </div>
+ )
+ })}
+ </div>
<Field>
<FieldLabel htmlFor="claim-memo">
@@ -332,7 +382,11 @@ export function CreateClaimDialog({
disabled={chosen.length === 0}
onClick={() =>
onSubmit({
- items: chosen.map(([id, quantity]) => ({ line_item_id: id, quantity })),
+ items: chosen.map(([id, quantity]) => ({
+ line_item_id: id,
+ quantity,
+ refund_amount: amounts[id] || undefined,
+ })),
claim_type: claimType,
memo: memo || undefined,
})
diff --git a/packages/dashboard/src/hooks/use-post-sale.ts b/packages/dashboard/src/hooks/use-post-sale.ts
index 7f87e8ae46..79392ac29c 100644
--- a/packages/dashboard/src/hooks/use-post-sale.ts
+++ b/packages/dashboard/src/hooks/use-post-sale.ts
@@ -106,7 +106,12 @@ export function useClaimActions(orderId: string) {
orderId,
'order-claims',
(params: {
- items: Array<{ line_item_id: string; quantity: number; description?: string }>
+ items: Array<{
+ line_item_id: string
+ quantity: number
+ description?: string
+ refund_amount?: string
+ }>
claim_type: string
memo?: string
}) => adminClient.orders.claims.create(orderId, params),
diff --git a/packages/dashboard/src/locales/ar.json b/packages/dashboard/src/locales/ar.json
index bd2c3760e6..8dd9104c9b 100644
--- a/packages/dashboard/src/locales/ar.json
+++ b/packages/dashboard/src/locales/ar.json
@@ -1718,7 +1718,8 @@
},
"empty": "لا توجد مطالبات لهذا الطلب.",
"create_title": "مطالبة جديدة",
- "claim_type": "المشكلة"
+ "claim_type": "المشكلة",
+ "refund_amount": "مبلغ الاسترداد"
},
"dialogs": {
"approve_title": "الموافقة على الطلب؟",
diff --git a/packages/dashboard/src/locales/de.json b/packages/dashboard/src/locales/de.json
index 8c43d14c45..e9b4e4b5a3 100644
--- a/packages/dashboard/src/locales/de.json
+++ b/packages/dashboard/src/locales/de.json
@@ -1718,7 +1718,8 @@
},
"empty": "Keine Reklamationen für diese Bestellung.",
"create_title": "Neue Reklamation",
- "claim_type": "Problem"
+ "claim_type": "Problem",
+ "refund_amount": "Erstattungsbetrag"
},
"dialogs": {
"approve_title": "Bestellung genehmigen?",
diff --git a/packages/dashboard/src/locales/en.json b/packages/dashboard/src/locales/en.json
index df15df05bb..71bb8e05d4 100644
--- a/packages/dashboard/src/locales/en.json
+++ b/packages/dashboard/src/locales/en.json
@@ -1718,7 +1718,8 @@
},
"empty": "No claims for this order.",
"create_title": "New claim",
- "claim_type": "Problem"
+ "claim_type": "Problem",
+ "refund_amount": "Refund amount"
},
"dialogs": {
"approve_title": "Approve order?",
diff --git a/packages/dashboard/src/locales/fr.json b/packages/dashboard/src/locales/fr.json
index 1f133f27ff..58be35d542 100644
--- a/packages/dashboard/src/locales/fr.json
+++ b/packages/dashboard/src/locales/fr.json
@@ -1718,7 +1718,8 @@
},
"empty": "Aucune réclamation pour cette commande.",
"create_title": "Nouvelle réclamation",
- "claim_type": "Problème"
+ "claim_type": "Problème",
+ "refund_amount": "Montant du remboursement"
},
"dialogs": {
"approve_title": "Approuver la commande ?",
diff --git a/packages/dashboard/src/locales/pl.json b/packages/dashboard/src/locales/pl.json
index cd763adc62..9e9830e738 100644
--- a/packages/dashboard/src/locales/pl.json
+++ b/packages/dashboard/src/locales/pl.json
@@ -1726,7 +1726,8 @@
},
"empty": "Brak reklamacji dla tego zamówienia.",
"create_title": "Nowa reklamacja",
- "claim_type": "Problem"
+ "claim_type": "Problem",
+ "refund_amount": "Kwota zwrotu"
},
"dialogs": {
"approve_title": "Zatwierdzić zamówienie?",
diff --git a/packages/dashboard/src/locales/zh-CN.json b/packages/dashboard/src/locales/zh-CN.json
index 1a5a27a0cb..92d101286c 100644
--- a/packages/dashboard/src/locales/zh-CN.json
+++ b/packages/dashboard/src/locales/zh-CN.json
@@ -1718,7 +1718,8 @@
},
"empty": "此订单暂无索赔。",
"create_title": "新建索赔",
- "claim_type": "问题"
+ "claim_type": "问题",
+ "refund_amount": "退款金额"
},
"dialogs": {
"approve_title": "批准订单?",
diff --git a/packages/dashboard/src/tables/post-sale.tsx b/packages/dashboard/src/tables/post-sale.tsx
index a38d590055..0463c97214 100644
--- a/packages/dashboard/src/tables/post-sale.tsx
+++ b/packages/dashboard/src/tables/post-sale.tsx
@@ -1,6 +1,7 @@
import type { Claim, Exchange, Return } from '@spree/admin-sdk'
import { defineTable } from '@spree/dashboard-core'
-import { Badge, RelativeTime, ResourceNameCell } from '@spree/dashboard-ui'
+import { Badge, RelativeTime } from '@spree/dashboard-ui'
+import { Link } from '@tanstack/react-router'
import i18n from 'i18next'
import { RepeatIcon, RotateCcwIcon, ShieldAlertIcon } from 'lucide-react'
@@ -23,6 +24,24 @@ const STATUS_VARIANT: Record<
canceled: 'secondary',
}
+/**
+ * The record's own number, linking to the order it belongs to — that page is
+ * where it can actually be actioned, so there is nowhere else useful to go.
+ */
+function numberCell(record: { number: string; order_id?: string | null }) {
+ if (!record.order_id) return record.number
+
+ return (
+ <Link
+ to={'/$storeId/orders/$orderId' as string}
+ params={{ orderId: record.order_id }}
+ className="font-medium text-foreground no-underline"
+ >
+ {record.number}
+ </Link>
+ )
+}
+
function statusLabel(value: string): string {
const key = `admin.post_sale.statuses.${value}`
return i18n.exists(key)
@@ -80,7 +99,7 @@ defineTable<Return>('returns', {
sortable: true,
filterable: true,
default: true,
- render: (r) => <ResourceNameCell id={r.id} dataAttr="data-return-id" name={r.number} />,
+ render: (r) => numberCell(r),
},
statusColumn(['requested', 'approved', 'received', 'refunded', 'canceled']),
orderColumn<Return>(),
@@ -109,7 +128,7 @@ defineTable<Exchange>('exchanges', {
sortable: true,
filterable: true,
default: true,
- render: (e) => <ResourceNameCell id={e.id} dataAttr="data-exchange-id" name={e.number} />,
+ render: (e) => numberCell(e),
},
statusColumn(['requested', 'approved', 'received', 'fulfilled', 'canceled']),
orderColumn<Exchange>(),
@@ -138,7 +157,7 @@ defineTable<Claim>('claims', {
sortable: true,
filterable: true,
default: true,
- render: (c) => <ResourceNameCell id={c.id} dataAttr="data-claim-id" name={c.number} />,
+ render: (c) => numberCell(c),
},
statusColumn(['open', 'approved', 'resolved', 'denied', 'canceled']),
{
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/orders/claims_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/orders/claims_controller_spec.rb
index ed17bdfa6e..ba027f9fcb 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/orders/claims_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/orders/claims_controller_spec.rb
@@ -64,6 +64,22 @@ RSpec.describe Spree::Api::V3::Admin::Orders::ClaimsController, type: :controlle
expect(Spree::StoreCredit.find_by(originator: claim)).to be_present
end
+ # A claim opened without per-item amounts has nothing to refund; the
+ # dashboard collects them at creation, and the API says so plainly.
+ it 'refuses a refund when no amount was recorded on the claim' do
+ empty = create(:claim, store: store, order: order)
+ empty.claim_line_items.each { |line| line.update!(refund_amount: 0) }
+ Spree::Claims::Approve.call(claim: empty)
+
+ patch :resolve, params: {
+ order_id: order.prefixed_id,
+ id: empty.prefixed_id,
+ resolution: 'refund'
+ }, as: :json
+
+ expect(response).to have_http_status(:unprocessable_content)
+ end
+
it 'rejects an unknown resolution' do
patch :resolve, params: {
order_id: order.prefixed_id,