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
Reorganise the settings nav, and give payouts a page
Damian Legawiecdf40ca2df798
diff --git a/packages/dashboard-core/src/lib/permissions.ts b/packages/dashboard-core/src/lib/permissions.tsindex 100fc4fe04..91e55be768 100644--- a/packages/dashboard-core/src/lib/permissions.ts+++ b/packages/dashboard-core/src/lib/permissions.ts@@ -69,6 +69,8 @@ export const Subject = {CommissionRate: 'Spree::CommissionRate',CommissionRule: 'Spree::CommissionRule',CommissionLine: 'Spree::CommissionLine',+ SellerPayout: 'Spree::SellerPayout',+ SellerTransfer: 'Spree::SellerTransfer',} as constexport type SubjectName = (typeof Subject)[keyof typeof Subject] | stringdiff --git a/packages/dashboard-starter/src/routeTree.gen.ts b/packages/dashboard-starter/src/routeTree.gen.tsindex 33643c4c77..d49ab3583f 100644--- a/packages/dashboard-starter/src/routeTree.gen.ts+++ b/packages/dashboard-starter/src/routeTree.gen.ts@@ -41,6 +41,7 @@ import { Route as SettingsSellerRequirementsRouteImport } from './../../dashboarimport { Route as SettingsRolesRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/roles'import { Route as SettingsReasonsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/reasons'import { Route as SettingsProductTypesRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/product-types'+import { Route as SettingsPayoutsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/payouts'import { Route as SettingsPaymentMethodsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/payment-methods'import { Route as SettingsMarketsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/markets'import { Route as SettingsIntegrationsRouteImport } from './../../dashboard/src/routes/_authenticated/$storeId/settings/integrations'@@ -247,6 +248,11 @@ const SettingsProductTypesRoute = SettingsProductTypesRouteImport.update({path: '/product-types',getParentRoute: () => SettingsRoute,} as any)+const SettingsPayoutsRoute = SettingsPayoutsRouteImport.update({+ id: '/payouts',+ path: '/payouts',+ getParentRoute: () => SettingsRoute,+} as any)const SettingsPaymentMethodsRoute = SettingsPaymentMethodsRouteImport.update({id: '/payment-methods',path: '/payment-methods',@@ -518,6 +524,7 @@ export interface FileRoutesByFullPath {'/$storeId/settings/integrations': typeof SettingsIntegrationsRoute'/$storeId/settings/markets': typeof SettingsMarketsRoute'/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute+ '/$storeId/settings/payouts': typeof SettingsPayoutsRoute'/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/$storeId/settings/reasons': typeof SettingsReasonsRoute'/$storeId/settings/roles': typeof SettingsRolesRoute@@ -593,6 +600,7 @@ export interface FileRoutesByTo {'/$storeId/settings/integrations': typeof SettingsIntegrationsRoute'/$storeId/settings/markets': typeof SettingsMarketsRoute'/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute+ '/$storeId/settings/payouts': typeof SettingsPayoutsRoute'/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/$storeId/settings/reasons': typeof SettingsReasonsRoute'/$storeId/settings/roles': typeof SettingsRolesRoute@@ -672,6 +680,7 @@ export interface FileRoutesById {'/_authenticated/$storeId/settings/integrations': typeof SettingsIntegrationsRoute'/_authenticated/$storeId/settings/markets': typeof SettingsMarketsRoute'/_authenticated/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute+ '/_authenticated/$storeId/settings/payouts': typeof SettingsPayoutsRoute'/_authenticated/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/_authenticated/$storeId/settings/reasons': typeof SettingsReasonsRoute'/_authenticated/$storeId/settings/roles': typeof SettingsRolesRoute@@ -751,6 +760,7 @@ export interface FileRouteTypes {| '/$storeId/settings/integrations'| '/$storeId/settings/markets'| '/$storeId/settings/payment-methods'+ | '/$storeId/settings/payouts'| '/$storeId/settings/product-types'| '/$storeId/settings/reasons'| '/$storeId/settings/roles'@@ -826,6 +836,7 @@ export interface FileRouteTypes {| '/$storeId/settings/integrations'| '/$storeId/settings/markets'| '/$storeId/settings/payment-methods'+ | '/$storeId/settings/payouts'| '/$storeId/settings/product-types'| '/$storeId/settings/reasons'| '/$storeId/settings/roles'@@ -904,6 +915,7 @@ export interface FileRouteTypes {| '/_authenticated/$storeId/settings/integrations'| '/_authenticated/$storeId/settings/markets'| '/_authenticated/$storeId/settings/payment-methods'+ | '/_authenticated/$storeId/settings/payouts'| '/_authenticated/$storeId/settings/product-types'| '/_authenticated/$storeId/settings/reasons'| '/_authenticated/$storeId/settings/roles'@@ -1178,6 +1190,13 @@ declare module '@tanstack/react-router' {preLoaderRoute: typeof SettingsProductTypesRouteImportparentRoute: typeof SettingsRoute}+ '/_authenticated/$storeId/settings/payouts': {+ id: '/_authenticated/$storeId/settings/payouts'+ path: '/payouts'+ fullPath: '/$storeId/settings/payouts'+ preLoaderRoute: typeof SettingsPayoutsRouteImport+ parentRoute: typeof SettingsRoute+ }'/_authenticated/$storeId/settings/payment-methods': {id: '/_authenticated/$storeId/settings/payment-methods'path: '/payment-methods'@@ -1499,6 +1518,7 @@ interface SettingsRouteChildren {SettingsIntegrationsRoute: typeof SettingsIntegrationsRouteSettingsMarketsRoute: typeof SettingsMarketsRouteSettingsPaymentMethodsRoute: typeof SettingsPaymentMethodsRoute+ SettingsPayoutsRoute: typeof SettingsPayoutsRouteSettingsProductTypesRoute: typeof SettingsProductTypesRouteSettingsReasonsRoute: typeof SettingsReasonsRouteSettingsRolesRoute: typeof SettingsRolesRoute@@ -1528,6 +1548,7 @@ const SettingsRouteChildren: SettingsRouteChildren = {SettingsIntegrationsRoute: SettingsIntegrationsRoute,SettingsMarketsRoute: SettingsMarketsRoute,SettingsPaymentMethodsRoute: SettingsPaymentMethodsRoute,+ SettingsPayoutsRoute: SettingsPayoutsRoute,SettingsProductTypesRoute: SettingsProductTypesRoute,SettingsReasonsRoute: SettingsReasonsRoute,SettingsRolesRoute: SettingsRolesRoute,diff --git a/packages/dashboard/src/hooks/use-store-settings.ts b/packages/dashboard/src/hooks/use-store-settings.tsindex cfa2f8aba5..40883a2a64 100644--- a/packages/dashboard/src/hooks/use-store-settings.ts+++ b/packages/dashboard/src/hooks/use-store-settings.ts@@ -29,6 +29,21 @@ export function useStoreDataSources() {})}+/**+ * How this marketplace can pay its sellers.+ *+ * Its own query rather than part of the data sources: a payout provider is+ * not a source of catalog data, and choosing one changes what sellers must+ * do before they can be paid.+ */+export function usePayoutProviders() {+ return useQuery({+ queryKey: useResourceKey(STORE_QUERY_RESOURCE, 'payout-providers'),+ queryFn: () => adminClient.payoutProviders.list(),+ staleTime: 5 * 60 * 1000,+ })+}+export function useUpdateStoreSettings() {return useResourceMutation<unknown, Error, StoreUpdateParams>({mutationFn: (params) => adminClient.store.update(params),diff --git a/packages/dashboard/src/locales/ar.json b/packages/dashboard/src/locales/ar.jsonindex 979cb80d53..0f1b649f9d 100644--- a/packages/dashboard/src/locales/ar.json+++ b/packages/dashboard/src/locales/ar.json@@ -1879,6 +1879,32 @@"track_price_history": {"help": "الاحتفاظ بالأسعار السابقة ليتمكن المتجر من عرض أقل سعر خلال آخر 30 يومًا، وفقًا لقواعد الاتحاد الأوروبي.","label": "تسجيل سجل الأسعار"+ },+ "payouts": {+ "title": "مدفوعات البائعين",+ "description": "كيف يدفع هذا السوق للبائعين الذين يتاجرون فيه.",+ "provider": {+ "label": "الدفع عبر",+ "help": "من ينقل الأموال. مع دفاترك الخاصة، ترسل التحويلات بنفسك وتضع علامة على كل منها كمدفوع.",+ "requires_account": "يجب على البائعين إعداد حساب لدى هذا المزود قبل أن يدفع لهم."+ },+ "provider_none": "دفاترك الخاصة",+ "provider_unavailable": "اربط هذا المزود قبل أن تتمكن من الدفع عبره",+ "schedule": {+ "label": "تسوية البائعين",+ "help": "كم مرة تُجمَّع الأرباح في دفعة واحدة. يمكن للبائع أن يتبع جدوله الخاص."+ },+ "schedule_intervals": {+ "daily": "يوميًا",+ "weekly": "أسبوعيًا",+ "biweekly": "كل أسبوعين",+ "monthly": "شهريًا",+ "manual": "فقط عندما تطلب ذلك"+ },+ "minimum": {+ "label": "الحد الأدنى للدفع",+ "help": "دون ذلك، يُرحَّل رصيد البائع إلى الفترة التالية بدل إرساله. الصفر يدفع كل ما هو مستحق."+ }}},"store_credit": {@@ -3420,6 +3446,10 @@"url": "URL"},"title": "Webhooks"+ },+ "payouts": {+ "title": "المدفوعات",+ "subtitle": "كيف ومتى يدفع هذا السوق لبائعيه."}},"staff": {@@ -4413,17 +4443,18 @@"store": "اسم المتجر والمنطقة الزمنية والوحدات والإعدادات الإقليمية","tax_categories": "فئات الضريبة المخصصة للمنتجات","tax_rates": "النسب المطبقة حسب السوق والمنطقة",- "webhooks": "نقاط النهاية التي تُخطر عند وقوع الأحداث"+ "webhooks": "نقاط النهاية التي تُخطر عند وقوع الأحداث",+ "payouts": "من يدفع لبائعيك، وكم مرة، والحد الأدنى الذي يستحق الإرسال"},"groups": {"audit": "التدقيق","developer": "المطوّر","payments": "المدفوعات والضرائب",- "post_sale": "المرتجعات والبائعون","selling": "البيع","shipping": "الشحن والتوصيل","store": "المتجر",- "team": "المستخدمون والأذونات"+ "team": "المستخدمون والأذونات",+ "marketplace": "السوق"},"items": {"allowed_origins": "المصادر المسموح بها",@@ -4447,7 +4478,8 @@"store": "المتجر","tax_categories": "فئات الضريبة","tax_rates": "نسب الضريبة",- "webhooks": "Webhooks"+ "webhooks": "Webhooks",+ "payouts": "المدفوعات"}},"setup": {diff --git a/packages/dashboard/src/locales/de.json b/packages/dashboard/src/locales/de.jsonindex 63d2a1f747..1f9713f1fa 100644--- a/packages/dashboard/src/locales/de.json+++ b/packages/dashboard/src/locales/de.json@@ -1862,6 +1862,32 @@"track_price_history": {"help": "Frühere Preise speichern, damit der Shop den niedrigsten Preis der letzten 30 Tage anzeigen kann, wie es EU-Regeln verlangen.","label": "Preisverlauf aufzeichnen"+ },+ "payouts": {+ "title": "Auszahlungen an Verkäufer",+ "description": "Wie dieser Marktplatz die Verkäufer bezahlt, die auf ihm handeln.",+ "provider": {+ "label": "Bezahlt über",+ "help": "Wer das Geld bewegt. Bei eigener Buchführung überweisen Sie selbst und markieren jede Zahlung als erledigt.",+ "requires_account": "Verkäufer müssen bei diesem Anbieter ein Konto einrichten, bevor er sie bezahlt."+ },+ "provider_none": "Eigene Buchführung",+ "provider_unavailable": "Verbinden Sie diesen Anbieter, bevor Sie darüber bezahlen können",+ "schedule": {+ "label": "Verkäufer abrechnen",+ "help": "Wie oft Einnahmen zu einer Zahlung gebündelt werden. Ein Verkäufer kann einen eigenen Rhythmus haben."+ },+ "schedule_intervals": {+ "daily": "Täglich",+ "weekly": "Wöchentlich",+ "biweekly": "Alle zwei Wochen",+ "monthly": "Monatlich",+ "manual": "Nur auf Ihre Anweisung"+ },+ "minimum": {+ "label": "Mindestauszahlung",+ "help": "Darunter wird das Guthaben in die nächste Periode übertragen statt ausgezahlt. Null zahlt jeden offenen Betrag."+ }}},"store_credit": {@@ -3404,6 +3430,10 @@"url": "URL"},"title": "Webhooks"+ },+ "payouts": {+ "title": "Auszahlungen",+ "subtitle": "Wie und wann dieser Marktplatz seine Verkäufer bezahlt."}},"staff": {@@ -4392,17 +4422,18 @@"store": "Shopname, Zeitzone, Einheiten und regionale Standards","tax_categories": "Steuerklassen für Produkte","tax_rates": "Sätze pro Markt und Region",- "webhooks": "Endpunkte, die bei Ereignissen benachrichtigt werden"+ "webhooks": "Endpunkte, die bei Ereignissen benachrichtigt werden",+ "payouts": "Wer Ihre Verkäufer bezahlt, wie oft und ab welchem Betrag"},"groups": {"audit": "Audit","developer": "Entwickler","payments": "Zahlungen & Steuern",- "post_sale": "Retouren & Verkäufer","selling": "Verkauf","shipping": "Versand & Lieferung","store": "Shop",- "team": "Benutzer & Berechtigungen"+ "team": "Benutzer & Berechtigungen",+ "marketplace": "Marktplatz"},"items": {"allowed_origins": "Zugelassene Ursprünge",@@ -4426,7 +4457,8 @@"store": "Shop","tax_categories": "Steuerkategorien","tax_rates": "Steuersätze",- "webhooks": "Webhooks"+ "webhooks": "Webhooks",+ "payouts": "Auszahlungen"}},"setup": {diff --git a/packages/dashboard/src/locales/en.json b/packages/dashboard/src/locales/en.jsonindex 490bb172ed..902b48d2b2 100644--- a/packages/dashboard/src/locales/en.json+++ b/packages/dashboard/src/locales/en.json@@ -1862,6 +1862,32 @@"track_price_history": {"help": "Keep past prices so the storefront can show the lowest price of the last 30 days, as EU rules require.","label": "Record price history"+ },+ "payouts": {+ "title": "Seller payouts",+ "description": "How this marketplace pays the sellers who trade on it.",+ "provider": {+ "label": "Paid through",+ "help": "Who moves the money. Keeping your own books means you send the transfers yourself and mark each one paid.",+ "requires_account": "Sellers must set up an account with this provider before it will pay them."+ },+ "provider_none": "Your own books",+ "provider_unavailable": "Connect this provider before you can pay through it",+ "schedule": {+ "label": "Settle sellers",+ "help": "How often earnings are batched into a payment. A seller can carry their own schedule instead."+ },+ "schedule_intervals": {+ "daily": "Daily",+ "weekly": "Weekly",+ "biweekly": "Every two weeks",+ "monthly": "Monthly",+ "manual": "Only when you say so"+ },+ "minimum": {+ "label": "Minimum payout",+ "help": "Below this, a seller’s balance carries to the next period rather than being sent. Zero pays whatever is owed."+ }}},"store_credit": {@@ -3404,6 +3430,10 @@"url": "URL"},"title": "Webhooks"+ },+ "payouts": {+ "title": "Payouts",+ "subtitle": "How and when this marketplace pays its sellers."}},"staff": {@@ -4392,17 +4422,18 @@"store": "Store name, timezone, units and regional defaults","tax_categories": "Tax classes assigned to products","tax_rates": "Rates applied per market and region",- "webhooks": "Endpoints notified when events happen"+ "webhooks": "Endpoints notified when events happen",+ "payouts": "Who pays your sellers, how often, and the minimum worth sending"},"groups": {"audit": "Audit","developer": "Developer","payments": "Payments & taxes",- "post_sale": "Returns & sellers","selling": "Selling","shipping": "Shipping & delivery","store": "Store",- "team": "Users & permissions"+ "team": "Users & permissions",+ "marketplace": "Marketplace"},"items": {"allowed_origins": "Allowed origins",@@ -4426,7 +4457,8 @@"store": "Store","tax_categories": "Tax categories","tax_rates": "Tax rates",- "webhooks": "Webhooks"+ "webhooks": "Webhooks",+ "payouts": "Payouts"}},"setup": {diff --git a/packages/dashboard/src/locales/fr.json b/packages/dashboard/src/locales/fr.jsonindex 17cbb3b8e5..02555ea132 100644--- a/packages/dashboard/src/locales/fr.json+++ b/packages/dashboard/src/locales/fr.json@@ -1862,6 +1862,32 @@"track_price_history": {"help": "Conserver les anciens prix afin d’afficher le prix le plus bas des 30 derniers jours, comme l’exige la réglementation européenne.","label": "Enregistrer l’historique des prix"+ },+ "payouts": {+ "title": "Paiements aux vendeurs",+ "description": "Comment cette marketplace paie les vendeurs qui y vendent.",+ "provider": {+ "label": "Payé via",+ "help": "Qui déplace l’argent. Avec vos propres comptes, vous effectuez les virements et marquez chacun comme payé.",+ "requires_account": "Les vendeurs doivent créer un compte chez ce prestataire avant d’être payés."+ },+ "provider_none": "Vos propres comptes",+ "provider_unavailable": "Connectez ce prestataire avant de pouvoir payer par son intermédiaire",+ "schedule": {+ "label": "Régler les vendeurs",+ "help": "À quelle fréquence les gains sont regroupés en un paiement. Un vendeur peut avoir son propre rythme."+ },+ "schedule_intervals": {+ "daily": "Chaque jour",+ "weekly": "Chaque semaine",+ "biweekly": "Toutes les deux semaines",+ "monthly": "Chaque mois",+ "manual": "Uniquement sur votre demande"+ },+ "minimum": {+ "label": "Paiement minimum",+ "help": "En dessous, le solde du vendeur est reporté à la période suivante. Zéro paie tout ce qui est dû."+ }}},"store_credit": {@@ -3404,6 +3430,10 @@"url": "URL"},"title": "Webhooks"+ },+ "payouts": {+ "title": "Paiements",+ "subtitle": "Comment et quand cette marketplace paie ses vendeurs."}},"staff": {@@ -4392,17 +4422,18 @@"store": "Nom de la boutique, fuseau horaire, unités et valeurs régionales","tax_categories": "Classes de taxe attribuées aux produits","tax_rates": "Taux appliqués par marché et région",- "webhooks": "Points de terminaison notifiés lors d'événements"+ "webhooks": "Points de terminaison notifiés lors d'événements",+ "payouts": "Qui paie vos vendeurs, à quelle fréquence et à partir de quel montant"},"groups": {"audit": "Audit","developer": "Développeur","payments": "Paiements et taxes",- "post_sale": "Retours et vendeurs","selling": "Vente","shipping": "Expédition et livraison","store": "Boutique",- "team": "Utilisateurs et autorisations"+ "team": "Utilisateurs et autorisations",+ "marketplace": "Marketplace"},"items": {"allowed_origins": "Origines autorisées",@@ -4426,7 +4457,8 @@"store": "Boutique","tax_categories": "Catégories de taxe","tax_rates": "Taux de taxe",- "webhooks": "Webhooks"+ "webhooks": "Webhooks",+ "payouts": "Paiements"}},"setup": {diff --git a/packages/dashboard/src/locales/pl.json b/packages/dashboard/src/locales/pl.jsonindex b6963e03ec..e3076c62a8 100644--- a/packages/dashboard/src/locales/pl.json+++ b/packages/dashboard/src/locales/pl.json@@ -1880,6 +1880,32 @@"track_price_history": {"help": "Przechowuj poprzednie ceny, aby sklep mógł pokazać najniższą cenę z ostatnich 30 dni, zgodnie z przepisami UE.","label": "Zapisuj historię cen"+ },+ "payouts": {+ "title": "Wypłaty dla sprzedawców",+ "description": "Jak ten marketplace płaci sprzedawcom, którzy na nim handlują.",+ "provider": {+ "label": "Wypłacane przez",+ "help": "Kto przenosi pieniądze. Przy własnej księgowości sam wykonujesz przelewy i oznaczasz każdy jako zapłacony.",+ "requires_account": "Sprzedawcy muszą założyć konto u tego dostawcy, zanim otrzymają wypłatę."+ },+ "provider_none": "Własna księgowość",+ "provider_unavailable": "Połącz tego dostawcę, zanim będziesz mógł przez niego płacić",+ "schedule": {+ "label": "Rozliczaj sprzedawców",+ "help": "Jak często zarobki są łączone w jedną wypłatę. Sprzedawca może mieć własny harmonogram."+ },+ "schedule_intervals": {+ "daily": "Codziennie",+ "weekly": "Co tydzień",+ "biweekly": "Co dwa tygodnie",+ "monthly": "Co miesiąc",+ "manual": "Tylko na Twoje polecenie"+ },+ "minimum": {+ "label": "Minimalna wypłata",+ "help": "Poniżej tej kwoty saldo przechodzi na następny okres zamiast zostać wypłacone. Zero wypłaca każdą należność."+ }}},"store_credit": {@@ -3456,6 +3482,10 @@"url": "URL"},"title": "Webhooki"+ },+ "payouts": {+ "title": "Wypłaty",+ "subtitle": "Jak i kiedy ten marketplace płaci swoim sprzedawcom."}},"staff": {@@ -4454,17 +4484,18 @@"store": "Nazwa sklepu, strefa czasowa, jednostki i ustawienia regionalne","tax_categories": "Klasy podatkowe przypisane do produktów","tax_rates": "Stawki stosowane według rynku i regionu",- "webhooks": "Adresy powiadamiane o zdarzeniach"+ "webhooks": "Adresy powiadamiane o zdarzeniach",+ "payouts": "Kto płaci Twoim sprzedawcom, jak często i od jakiej kwoty"},"groups": {"audit": "Audyt","developer": "Deweloper","payments": "Płatności i podatki",- "post_sale": "Zwroty i sprzedawcy","selling": "Sprzedaż","shipping": "Wysyłka i dostawa","store": "Sklep",- "team": "Użytkownicy i uprawnienia"+ "team": "Użytkownicy i uprawnienia",+ "marketplace": "Marketplace"},"items": {"allowed_origins": "Dozwolone źródła",@@ -4488,7 +4519,8 @@"store": "Sklep","tax_categories": "Kategorie podatkowe","tax_rates": "Stawki podatku",- "webhooks": "Webhooki"+ "webhooks": "Webhooki",+ "payouts": "Wypłaty"}},"setup": {diff --git a/packages/dashboard/src/locales/zh-CN.json b/packages/dashboard/src/locales/zh-CN.jsonindex 3934a366d0..bcc7db21df 100644--- a/packages/dashboard/src/locales/zh-CN.json+++ b/packages/dashboard/src/locales/zh-CN.json@@ -1857,6 +1857,32 @@"track_price_history": {"help": "保留历史价格,以便店铺按欧盟规定显示最近 30 天的最低价。","label": "记录价格历史"+ },+ "payouts": {+ "title": "卖家付款",+ "description": "本平台如何向在此交易的卖家付款。",+ "provider": {+ "label": "付款方式",+ "help": "由谁转移资金。自行记账时,由你自己转账并逐笔标记为已付。",+ "requires_account": "卖家需先在该服务商开设账户,才能收到款项。"+ },+ "provider_none": "自行记账",+ "provider_unavailable": "请先连接该服务商,然后才能通过它付款",+ "schedule": {+ "label": "结算卖家",+ "help": "收益多久汇总为一笔付款。卖家也可以使用自己的周期。"+ },+ "schedule_intervals": {+ "daily": "每天",+ "weekly": "每周",+ "biweekly": "每两周",+ "monthly": "每月",+ "manual": "仅在你指定时"+ },+ "minimum": {+ "label": "最低付款额",+ "help": "低于此金额时,卖家余额结转至下一周期而不发放。设为零则支付所有应付款项。"+ }}},"store_credit": {@@ -3396,6 +3422,10 @@"url": "URL"},"title": "Webhooks"+ },+ "payouts": {+ "title": "付款",+ "subtitle": "本平台如何以及何时向卖家付款。"}},"staff": {@@ -4383,17 +4413,18 @@"store": "店铺名称、时区、单位与区域默认值","tax_categories": "分配给商品的税务类别","tax_rates": "按市场和地区适用的税率",- "webhooks": "事件发生时接收通知的端点"+ "webhooks": "事件发生时接收通知的端点",+ "payouts": "由谁向卖家付款、多久一次,以及值得发放的最低金额"},"groups": {"audit": "审计","developer": "开发者","payments": "支付与税务",- "post_sale": "退货与卖家","selling": "销售","shipping": "配送与物流","store": "店铺",- "team": "用户与权限"+ "team": "用户与权限",+ "marketplace": "平台"},"items": {"allowed_origins": "允许的来源",@@ -4417,7 +4448,8 @@"store": "店铺","tax_categories": "税收类别","tax_rates": "税率",- "webhooks": "Webhooks"+ "webhooks": "Webhooks",+ "payouts": "付款"}},"setup": {diff --git a/packages/dashboard/src/nav/settings.ts b/packages/dashboard/src/nav/settings.tsindex ac7b24a35c..109feb0d72 100644--- a/packages/dashboard/src/nav/settings.ts+++ b/packages/dashboard/src/nav/settings.ts@@ -1,5 +1,6 @@import { Subject, settingsNav } from '@spree/dashboard-core'import {+ BanknoteIcon,ClipboardCheckIcon,CreditCardIcon,GlobeIcon,@@ -43,8 +44,8 @@ settingsNav.addGroup({position: 300,})settingsNav.addGroup({- key: 'post_sale',- labelKey: 'admin.settings_nav.groups.post_sale',+ key: 'marketplace',+ labelKey: 'admin.settings_nav.groups.marketplace',position: 400,})settingsNav.addGroup({ key: 'team', labelKey: 'admin.settings_nav.groups.team', position: 500 })@@ -165,7 +166,7 @@ settingsNav.add({keywords: ['apps', 'providers', 'credentials', 'easypost', 'avalara'],path: '/integrations',icon: PlugIcon,- group: 'selling',+ group: 'store',position: 500,subject: Subject.Integration,})@@ -217,11 +218,23 @@ settingsNav.add({keywords: ['returns', 'refunds', 'claims', 'rma', 'reason'],path: '/reasons',icon: RotateCcwIcon,- group: 'post_sale',- position: 100,+ group: 'shipping',+ position: 400,subject: Subject.ReturnReason,})+settingsNav.add({+ key: 'settings.payouts',+ labelKey: 'admin.settings_nav.items.payouts',+ descriptionKey: 'admin.settings_nav.descriptions.payouts',+ keywords: ['marketplace', 'sellers', 'payouts', 'stripe', 'schedule'],+ path: '/payouts',+ icon: BanknoteIcon,+ group: 'marketplace',+ position: 100,+ subject: Subject.SellerPayout,+})+settingsNav.add({key: 'settings.commission-rates',labelKey: 'admin.settings_nav.items.commission_rates',@@ -229,7 +242,7 @@ settingsNav.add({keywords: ['marketplace', 'sellers', 'payouts', 'fees'],path: '/commission-rates',icon: HandCoinsIcon,- group: 'post_sale',+ group: 'marketplace',position: 200,subject: Subject.CommissionRate,})@@ -241,7 +254,7 @@ settingsNav.add({keywords: ['marketplace', 'onboarding', 'approval', 'checklist'],path: '/seller-requirements',icon: ClipboardCheckIcon,- group: 'post_sale',+ group: 'marketplace',position: 300,subject: Subject.Seller,})diff --git a/packages/dashboard/src/routeTree.gen.ts b/packages/dashboard/src/routeTree.gen.tsindex 9df97447cb..ef4603e6cc 100644--- a/packages/dashboard/src/routeTree.gen.ts+++ b/packages/dashboard/src/routeTree.gen.ts@@ -40,6 +40,7 @@ import { Route as SettingsSellerRequirementsRouteImport } from './routes/_authenimport { Route as SettingsRolesRouteImport } from './routes/_authenticated/$storeId/settings/roles'import { Route as SettingsReasonsRouteImport } from './routes/_authenticated/$storeId/settings/reasons'import { Route as SettingsProductTypesRouteImport } from './routes/_authenticated/$storeId/settings/product-types'+import { Route as SettingsPayoutsRouteImport } from './routes/_authenticated/$storeId/settings/payouts'import { Route as SettingsPaymentMethodsRouteImport } from './routes/_authenticated/$storeId/settings/payment-methods'import { Route as SettingsMarketsRouteImport } from './routes/_authenticated/$storeId/settings/markets'import { Route as SettingsIntegrationsRouteImport } from './routes/_authenticated/$storeId/settings/integrations'@@ -240,6 +241,11 @@ const SettingsProductTypesRoute = SettingsProductTypesRouteImport.update({path: '/product-types',getParentRoute: () => SettingsRoute,} as any)+const SettingsPayoutsRoute = SettingsPayoutsRouteImport.update({+ id: '/payouts',+ path: '/payouts',+ getParentRoute: () => SettingsRoute,+} as any)const SettingsPaymentMethodsRoute = SettingsPaymentMethodsRouteImport.update({id: '/payment-methods',path: '/payment-methods',@@ -505,6 +511,7 @@ export interface FileRoutesByFullPath {'/$storeId/settings/integrations': typeof SettingsIntegrationsRoute'/$storeId/settings/markets': typeof SettingsMarketsRoute'/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute+ '/$storeId/settings/payouts': typeof SettingsPayoutsRoute'/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/$storeId/settings/reasons': typeof SettingsReasonsRoute'/$storeId/settings/roles': typeof SettingsRolesRoute@@ -578,6 +585,7 @@ export interface FileRoutesByTo {'/$storeId/settings/integrations': typeof SettingsIntegrationsRoute'/$storeId/settings/markets': typeof SettingsMarketsRoute'/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute+ '/$storeId/settings/payouts': typeof SettingsPayoutsRoute'/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/$storeId/settings/reasons': typeof SettingsReasonsRoute'/$storeId/settings/roles': typeof SettingsRolesRoute@@ -655,6 +663,7 @@ export interface FileRoutesById {'/_authenticated/$storeId/settings/integrations': typeof SettingsIntegrationsRoute'/_authenticated/$storeId/settings/markets': typeof SettingsMarketsRoute'/_authenticated/$storeId/settings/payment-methods': typeof SettingsPaymentMethodsRoute+ '/_authenticated/$storeId/settings/payouts': typeof SettingsPayoutsRoute'/_authenticated/$storeId/settings/product-types': typeof SettingsProductTypesRoute'/_authenticated/$storeId/settings/reasons': typeof SettingsReasonsRoute'/_authenticated/$storeId/settings/roles': typeof SettingsRolesRoute@@ -732,6 +741,7 @@ export interface FileRouteTypes {| '/$storeId/settings/integrations'| '/$storeId/settings/markets'| '/$storeId/settings/payment-methods'+ | '/$storeId/settings/payouts'| '/$storeId/settings/product-types'| '/$storeId/settings/reasons'| '/$storeId/settings/roles'@@ -805,6 +815,7 @@ export interface FileRouteTypes {| '/$storeId/settings/integrations'| '/$storeId/settings/markets'| '/$storeId/settings/payment-methods'+ | '/$storeId/settings/payouts'| '/$storeId/settings/product-types'| '/$storeId/settings/reasons'| '/$storeId/settings/roles'@@ -881,6 +892,7 @@ export interface FileRouteTypes {| '/_authenticated/$storeId/settings/integrations'| '/_authenticated/$storeId/settings/markets'| '/_authenticated/$storeId/settings/payment-methods'+ | '/_authenticated/$storeId/settings/payouts'| '/_authenticated/$storeId/settings/product-types'| '/_authenticated/$storeId/settings/reasons'| '/_authenticated/$storeId/settings/roles'@@ -1147,6 +1159,13 @@ declare module '@tanstack/react-router' {preLoaderRoute: typeof SettingsProductTypesRouteImportparentRoute: typeof SettingsRoute}+ '/_authenticated/$storeId/settings/payouts': {+ id: '/_authenticated/$storeId/settings/payouts'+ path: '/payouts'+ fullPath: '/$storeId/settings/payouts'+ preLoaderRoute: typeof SettingsPayoutsRouteImport+ parentRoute: typeof SettingsRoute+ }'/_authenticated/$storeId/settings/payment-methods': {id: '/_authenticated/$storeId/settings/payment-methods'path: '/payment-methods'@@ -1461,6 +1480,7 @@ interface SettingsRouteChildren {SettingsIntegrationsRoute: typeof SettingsIntegrationsRouteSettingsMarketsRoute: typeof SettingsMarketsRouteSettingsPaymentMethodsRoute: typeof SettingsPaymentMethodsRoute+ SettingsPayoutsRoute: typeof SettingsPayoutsRouteSettingsProductTypesRoute: typeof SettingsProductTypesRouteSettingsReasonsRoute: typeof SettingsReasonsRouteSettingsRolesRoute: typeof SettingsRolesRoute@@ -1490,6 +1510,7 @@ const SettingsRouteChildren: SettingsRouteChildren = {SettingsIntegrationsRoute: SettingsIntegrationsRoute,SettingsMarketsRoute: SettingsMarketsRoute,SettingsPaymentMethodsRoute: SettingsPaymentMethodsRoute,+ SettingsPayoutsRoute: SettingsPayoutsRoute,SettingsProductTypesRoute: SettingsProductTypesRoute,SettingsReasonsRoute: SettingsReasonsRoute,SettingsRolesRoute: SettingsRolesRoute,diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/settings/payouts.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/settings/payouts.tsxnew file mode 100644index 0000000000..9f1382266a--- /dev/null+++ b/packages/dashboard/src/routes/_authenticated/$storeId/settings/payouts.tsx@@ -0,0 +1,256 @@+import { zodResolver } from '@hookform/resolvers/zod'+import { SpreeError, type Store } from '@spree/admin-sdk'+import { mapSpreeErrorsToForm, PageHeader } from '@spree/dashboard-core'+import {+ Card,+ CardContent,+ CardDescription,+ CardHeader,+ CardTitle,+ ErrorState,+ Field,+ FieldDescription,+ FieldError,+ FieldGroup,+ FieldLabel,+ FormActions,+ Input,+ ResourceLayout,+ Select,+ SelectContent,+ SelectItem,+ SelectTrigger,+ SelectValue,+ Skeleton,+ useFormSubmitShortcut,+} from '@spree/dashboard-ui'+import { createFileRoute } from '@tanstack/react-router'+import { useMemo } from 'react'+import { Controller, FormProvider, useForm } from 'react-hook-form'+import { useTranslation } from 'react-i18next'+import {+ usePayoutProviders,+ useStoreSettings,+ useUpdateStoreSettings,+} from '../../../../hooks/use-store-settings'+import {+ PAYOUT_SCHEDULE_INTERVALS,+ type PayoutSettingsFormValues,+ payoutSettingsFormSchema,+} from '../../../../schemas/payouts'++export const Route = createFileRoute('/_authenticated/$storeId/settings/payouts')({+ component: PayoutSettingsRoute,+})++function PayoutSettingsRoute() {+ const { t } = useTranslation()+ const { data: store, isLoading, error, refetch } = useStoreSettings()++ if (isLoading || !store) {+ if (error) {+ return (+ <ErrorState title={t('admin.store.load_failed_title')} onRetry={() => void refetch()} />+ )+ }++ return <Skeleton className="h-64 w-full" />+ }++ return <PayoutSettingsPage store={store} />+}++function PayoutSettingsPage({ store }: { store: Store }) {+ const { t } = useTranslation()+ const updateMutation = useUpdateStoreSettings()+ const { data: payoutProviders } = usePayoutProviders()++ const form = useForm<PayoutSettingsFormValues>({+ // eslint-disable-next-line @typescript-eslint/no-explicit-any+ resolver: zodResolver(payoutSettingsFormSchema) as any,+ defaultValues: {+ preferred_payout_provider: store.preferred_payout_provider ?? '',+ preferred_default_payouts_schedule_interval:+ (store.preferred_default_payouts_schedule_interval as (typeof PAYOUT_SCHEDULE_INTERVALS)[number]) ??+ 'monthly',+ preferred_default_minimum_payout_amount: Number(+ store.preferred_default_minimum_payout_amount ?? 0,+ ),+ },+ })++ // Blank rather than a class name for the built-in provider, so a+ // marketplace that has connected nothing reads as "we settle these+ // ourselves" rather than as an engine it has to understand.+ const providerOptions = useMemo(+ () => [+ { value: '', label: t('admin.fields.store.payouts.provider_none'), disabled: false },+ ...(payoutProviders?.data ?? [])+ .filter((provider) => !provider.default)+ .map((provider) => ({+ value: provider.id,+ label: provider.name,+ disabled: !provider.available,+ })),+ ],+ [payoutProviders, t],+ )++ const scheduleOptions = useMemo(+ () =>+ PAYOUT_SCHEDULE_INTERVALS.map((interval) => ({+ value: interval,+ label: t(`admin.fields.store.payouts.schedule_intervals.${interval}`),+ })),+ [t],+ )++ const onSubmit = async (values: PayoutSettingsFormValues) => {+ try {+ await updateMutation.mutateAsync({+ preferred_payout_provider: values.preferred_payout_provider,+ preferred_default_payouts_schedule_interval:+ values.preferred_default_payouts_schedule_interval,+ preferred_default_minimum_payout_amount: values.preferred_default_minimum_payout_amount,+ })+ form.reset(values)+ } catch (err) {+ if (!mapSpreeErrorsToForm(err, form.setError)) throw err+ if (!(err instanceof SpreeError)) throw err+ }+ }++ useFormSubmitShortcut(form, onSubmit)++ const { errors } = form.formState+ // A provider that moves money asks sellers to onboard with it first, which+ // is worth saying before the choice rather than after.+ const selected = payoutProviders?.data?.find(+ (provider) => provider.id === form.watch('preferred_payout_provider'),+ )++ return (+ <FormProvider {...form}>+ <form onSubmit={form.handleSubmit(onSubmit)}>+ <ResourceLayout+ header={+ <PageHeader+ title={t('admin.pages.settings.payouts.title')}+ subtitle={t('admin.pages.settings.payouts.subtitle')}+ actions={<FormActions form={form} />}+ />+ }+ main={+ <>+ {errors.root?.message && (+ <p className="text-sm text-destructive" role="alert">+ {errors.root.message}+ </p>+ )}++ <Card>+ <CardHeader>+ <CardTitle>{t('admin.fields.store.payouts.title')}</CardTitle>+ <CardDescription>{t('admin.fields.store.payouts.description')}</CardDescription>+ </CardHeader>+ <CardContent>+ <FieldGroup>+ <Controller+ control={form.control}+ name="preferred_payout_provider"+ render={({ field }) => (+ <Field>+ <FieldLabel htmlFor="payout-provider">+ {t('admin.fields.store.payouts.provider.label')}+ </FieldLabel>+ <Select+ items={providerOptions}+ value={field.value}+ onValueChange={(value) => field.onChange(value as string)}+ >+ <SelectTrigger id="payout-provider">+ <SelectValue />+ </SelectTrigger>+ <SelectContent>+ {providerOptions.map((option) => (+ <SelectItem+ key={option.value}+ value={option.value}+ disabled={option.disabled}+ >+ {option.label}+ </SelectItem>+ ))}+ </SelectContent>+ </Select>+ <FieldDescription>+ {selected?.requires_payout_account+ ? t('admin.fields.store.payouts.provider.requires_account')+ : t('admin.fields.store.payouts.provider.help')}+ </FieldDescription>+ <FieldError errors={[errors.preferred_payout_provider]} />+ </Field>+ )}+ />++ <Controller+ control={form.control}+ name="preferred_default_payouts_schedule_interval"+ render={({ field }) => (+ <Field>+ <FieldLabel htmlFor="payout-schedule">+ {t('admin.fields.store.payouts.schedule.label')}+ </FieldLabel>+ <Select+ items={scheduleOptions}+ value={field.value}+ onValueChange={(value) => field.onChange(value as string)}+ >+ <SelectTrigger id="payout-schedule">+ <SelectValue />+ </SelectTrigger>+ <SelectContent>+ {scheduleOptions.map((option) => (+ <SelectItem key={option.value} value={option.value}>+ {option.label}+ </SelectItem>+ ))}+ </SelectContent>+ </Select>+ <FieldDescription>+ {t('admin.fields.store.payouts.schedule.help')}+ </FieldDescription>+ <FieldError+ errors={[errors.preferred_default_payouts_schedule_interval]}+ />+ </Field>+ )}+ />++ <Field>+ <FieldLabel htmlFor="payout-minimum">+ {t('admin.fields.store.payouts.minimum.label')}+ </FieldLabel>+ <Input+ id="payout-minimum"+ type="number"+ min={0}+ step="0.01"+ aria-invalid={!!errors.preferred_default_minimum_payout_amount || undefined}+ {...form.register('preferred_default_minimum_payout_amount')}+ />+ <FieldDescription>+ {t('admin.fields.store.payouts.minimum.help')}+ </FieldDescription>+ <FieldError errors={[errors.preferred_default_minimum_payout_amount]} />+ </Field>+ </FieldGroup>+ </CardContent>+ </Card>+ </>+ }+ />+ </form>+ </FormProvider>+ )+}diff --git a/packages/dashboard/src/schemas/payouts.ts b/packages/dashboard/src/schemas/payouts.tsnew file mode 100644index 0000000000..29bd2be79d--- /dev/null+++ b/packages/dashboard/src/schemas/payouts.ts@@ -0,0 +1,21 @@+import { z } from 'zod'++/** How often a marketplace settles its sellers, unless one carries its own. */+export const PAYOUT_SCHEDULE_INTERVALS = [+ 'daily',+ 'weekly',+ 'biweekly',+ 'monthly',+ 'manual',+] as const++export const payoutSettingsFormSchema = z.object({+ // Blank is the built-in provider: the marketplace keeps the books and+ // settles by hand.+ preferred_payout_provider: z.string(),+ preferred_default_payouts_schedule_interval: z.enum(PAYOUT_SCHEDULE_INTERVALS),+ // A number, because the preference is a decimal and the API answers with one.+ preferred_default_minimum_payout_amount: z.coerce.number().min(0),+})++export type PayoutSettingsFormValues = z.infer<typeof payoutSettingsFormSchema>