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 type {
DeliveryMethod,
DeliveryMethodCreateParams,
DeliveryMethodUpdateParams,
} from '@spree/admin-sdk'
import {
adminClient,
useResourceKey,
useResourceKeyBuilder,
useResourceMutation,
} from '@spree/dashboard-core'
import { useQuery, useQueryClient } from '@tanstack/react-query'
import i18n from 'i18next'
export function useDeliveryMethod(id: string | undefined) {
return useQuery({
queryKey: useResourceKey('delivery-methods', id ?? 'noop'),
queryFn: () => adminClient.deliveryMethods.get(id as string),
enabled: !!id,
})
}
export function useDeliveryCalculators() {
return useQuery({
queryKey: useResourceKey('delivery-methods', 'calculators'),
queryFn: () => adminClient.deliveryMethods.calculators(),
staleTime: 1000 * 60 * 30,
})
}
export function useFulfillmentProviders() {
return useQuery({
queryKey: useResourceKey('delivery-methods', 'fulfillment-providers'),
queryFn: () => adminClient.deliveryMethods.fulfillmentProviders(),
staleTime: 1000 * 60 * 30,
})
}
/** Rate providers available to this store (carrier providers appear once their integration is connected), plus the default. */
export function useDeliveryRateProviders() {
return useQuery({
queryKey: useResourceKey('delivery-methods', 'rate-providers'),
queryFn: () => adminClient.deliveryMethods.rateProviders(),
staleTime: 1000 * 60 * 30,
})
}
/**
* Every delivery method of the store, across pages — the zone-grouped
* settings view renders all of them at once, Shopify-style, so a silent
* page-one cap would hide methods from the merchant.
*/
export function useAllDeliveryMethods() {
return useQuery({
queryKey: useResourceKey('delivery-methods', 'all'),
queryFn: async () => {
const first = await adminClient.deliveryMethods.list({ page: 1, limit: 100 })
const rest = await Promise.all(
Array.from({ length: (first.meta?.pages ?? 1) - 1 }, (_, index) =>
adminClient.deliveryMethods.list({ page: index + 2, limit: 100 }),
),
)
return [...first.data, ...rest.flatMap((page) => page.data)]
},
})
}
export function useCreateDeliveryMethod() {
return useResourceMutation<DeliveryMethod, Error, DeliveryMethodCreateParams>({
mutationFn: (params) => adminClient.deliveryMethods.create(params),
invalidate: [['delivery-methods']],
successMessage: i18n.t('admin.delivery_methods.messages.created'),
errorMessage: i18n.t('admin.errors.failed_to_create'),
})
}
export function useUpdateDeliveryMethod(id: string) {
return useResourceMutation<DeliveryMethod, Error, DeliveryMethodUpdateParams>({
mutationFn: (params) => adminClient.deliveryMethods.update(id, params),
invalidate: [['delivery-methods'], ['delivery-methods', id]],
successMessage: i18n.t('admin.delivery_methods.messages.updated'),
errorMessage: i18n.t('admin.errors.failed_to_update'),
})
}
export function useDeleteDeliveryMethod() {
const queryClient = useQueryClient()
const buildKey = useResourceKeyBuilder()
return useResourceMutation<void, Error, string>({
mutationFn: (id) => adminClient.deliveryMethods.delete(id),
invalidate: [['delivery-methods']],
successMessage: i18n.t('admin.delivery_methods.messages.deleted'),
errorMessage: i18n.t('admin.errors.failed_to_delete'),
onSuccess: (_data, id) => {
queryClient.removeQueries({ queryKey: buildKey('delivery-methods', id) })
},
})
}
export function useDeliveryMethodRules(deliveryMethodId: string | undefined) {
return useQuery({
queryKey: useResourceKey('delivery-methods', deliveryMethodId ?? 'noop', 'rules'),
queryFn: () => adminClient.deliveryMethods.rules.list(deliveryMethodId as string),
enabled: !!deliveryMethodId,
})
}
export function useDeliveryMethodRuleTypes() {
return useQuery({
queryKey: useResourceKey('delivery-method-rule-types'),
queryFn: () => adminClient.deliveryMethods.ruleTypes(),
staleTime: 1000 * 60 * 30,
})
}