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
Rewrite of Settings user guides (#14711)
jaburghesa900b9a1b8b5
diff --git a/docs/images/user/settings/delivery-profiles/1-profiles-overview.png b/docs/images/user/settings/delivery-profiles/1-profiles-overview.pngnew file mode 100644index 0000000000..e7085abea4Binary files /dev/null and b/docs/images/user/settings/delivery-profiles/1-profiles-overview.png differdiff --git a/docs/images/user/settings/delivery-profiles/2-new-profile.png b/docs/images/user/settings/delivery-profiles/2-new-profile.pngnew file mode 100644index 0000000000..fed1703b8fBinary files /dev/null and b/docs/images/user/settings/delivery-profiles/2-new-profile.png differdiff --git a/docs/images/user/settings/delivery-profiles/3-profile-editor.png b/docs/images/user/settings/delivery-profiles/3-profile-editor.pngnew file mode 100644index 0000000000..bde2770715Binary files /dev/null and b/docs/images/user/settings/delivery-profiles/3-profile-editor.png differdiff --git a/docs/images/user/settings/delivery-profiles/4-add-zone.png b/docs/images/user/settings/delivery-profiles/4-add-zone.pngnew file mode 100644index 0000000000..a67835896eBinary files /dev/null and b/docs/images/user/settings/delivery-profiles/4-add-zone.png differdiff --git a/docs/images/user/settings/delivery-profiles/5-new-method.png b/docs/images/user/settings/delivery-profiles/5-new-method.pngnew file mode 100644index 0000000000..44360ef358Binary files /dev/null and b/docs/images/user/settings/delivery-profiles/5-new-method.png differdiff --git a/docs/images/user/settings/delivery-profiles/6-pickup.png b/docs/images/user/settings/delivery-profiles/6-pickup.pngnew file mode 100644index 0000000000..b6d025fa5eBinary files /dev/null and b/docs/images/user/settings/delivery-profiles/6-pickup.png differdiff --git a/docs/images/user/settings/emails/1-email-settings.png b/docs/images/user/settings/emails/1-email-settings.pngnew file mode 100644index 0000000000..4c3c7f27b2Binary files /dev/null and b/docs/images/user/settings/emails/1-email-settings.png differdiff --git a/docs/images/user/settings/emails/1.Emails.png b/docs/images/user/settings/emails/1.Emails.pngdeleted file mode 100644index bc939ec895..0000000000Binary files a/docs/images/user/settings/emails/1.Emails.png and /dev/null differdiff --git a/docs/images/user/settings/emails/2-email-logo.png b/docs/images/user/settings/emails/2-email-logo.pngnew file mode 100644index 0000000000..1510f39642Binary files /dev/null and b/docs/images/user/settings/emails/2-email-logo.png differdiff --git a/docs/images/user/settings/emails/2.Logo.png b/docs/images/user/settings/emails/2.Logo.pngdeleted file mode 100644index 5945bb6778..0000000000Binary files a/docs/images/user/settings/emails/2.Logo.png and /dev/null differdiff --git a/docs/images/user/settings/emails/3.Addresses.png b/docs/images/user/settings/emails/3.Addresses.pngdeleted file mode 100644index a37b081f67..0000000000Binary files a/docs/images/user/settings/emails/3.Addresses.png and /dev/null differdiff --git a/docs/images/user/settings/locations/1-locations-overview.png b/docs/images/user/settings/locations/1-locations-overview.pngnew file mode 100644index 0000000000..8e57cd1df6Binary files /dev/null and b/docs/images/user/settings/locations/1-locations-overview.png differdiff --git a/docs/images/user/settings/locations/1-stock-locations.png b/docs/images/user/settings/locations/1-stock-locations.pngdeleted file mode 100644index 1473e21255..0000000000Binary files a/docs/images/user/settings/locations/1-stock-locations.png and /dev/null differdiff --git a/docs/images/user/settings/locations/2-add-location.png b/docs/images/user/settings/locations/2-add-location.pngnew file mode 100644index 0000000000..21cf6752dfBinary files /dev/null and b/docs/images/user/settings/locations/2-add-location.png differdiff --git a/docs/images/user/settings/locations/2-create-stock-location.png b/docs/images/user/settings/locations/2-create-stock-location.pngdeleted file mode 100644index 96b6069176..0000000000Binary files a/docs/images/user/settings/locations/2-create-stock-location.png and /dev/null differdiff --git a/docs/images/user/settings/locations/3-stock-at-location.png b/docs/images/user/settings/locations/3-stock-at-location.pngnew file mode 100644index 0000000000..220d4e6fa4Binary files /dev/null and b/docs/images/user/settings/locations/3-stock-at-location.png differdiff --git a/docs/images/user/settings/locations/3-stock-location-created.png b/docs/images/user/settings/locations/3-stock-location-created.pngdeleted file mode 100644index 09897155de..0000000000Binary files a/docs/images/user/settings/locations/3-stock-location-created.png and /dev/null differdiff --git a/docs/images/user/settings/locations/4-set-default-location.png b/docs/images/user/settings/locations/4-set-default-location.pngdeleted file mode 100644index 80fb155621..0000000000Binary files a/docs/images/user/settings/locations/4-set-default-location.png and /dev/null differdiff --git a/docs/images/user/settings/locations/4-stock-history.png b/docs/images/user/settings/locations/4-stock-history.pngnew file mode 100644index 0000000000..a7bfaa1216Binary files /dev/null and b/docs/images/user/settings/locations/4-stock-history.png differdiff --git a/docs/images/user/settings/locations/5-delete-stock-location.png b/docs/images/user/settings/locations/5-delete-stock-location.pngdeleted file mode 100644index 1016426bfc..0000000000Binary files a/docs/images/user/settings/locations/5-delete-stock-location.png and /dev/null differdiff --git a/docs/images/user/settings/markets/1-markets-overview.png b/docs/images/user/settings/markets/1-markets-overview.pngindex 8e0e91c541..2181f52dc8 100644Binary files a/docs/images/user/settings/markets/1-markets-overview.png and b/docs/images/user/settings/markets/1-markets-overview.png differdiff --git a/docs/images/user/settings/markets/2-add-market.png b/docs/images/user/settings/markets/2-add-market.pngnew file mode 100644index 0000000000..4842209039Binary files /dev/null and b/docs/images/user/settings/markets/2-add-market.png differdiff --git a/docs/images/user/settings/markets/2-new-market.png b/docs/images/user/settings/markets/2-new-market.pngdeleted file mode 100644index 37c4899c16..0000000000Binary files a/docs/images/user/settings/markets/2-new-market.png and /dev/null differdiff --git a/docs/images/user/settings/markets/3-edit-market.png b/docs/images/user/settings/markets/3-edit-market.pngdeleted file mode 100644index 5bfba1c20a..0000000000Binary files a/docs/images/user/settings/markets/3-edit-market.png and /dev/null differdiff --git a/docs/images/user/settings/payments/1-payments-methods-overview.png b/docs/images/user/settings/payments/1-payments-methods-overview.pngnew file mode 100644index 0000000000..7a2838e3c2Binary files /dev/null and b/docs/images/user/settings/payments/1-payments-methods-overview.png differdiff --git a/docs/images/user/settings/payments/1.payments.png b/docs/images/user/settings/payments/1.payments.pngdeleted file mode 100644index eab57b3d0d..0000000000Binary files a/docs/images/user/settings/payments/1.payments.png and /dev/null differdiff --git a/docs/images/user/settings/payments/2-add-payment-method.png b/docs/images/user/settings/payments/2-add-payment-method.pngnew file mode 100644index 0000000000..7ed4b96118Binary files /dev/null and b/docs/images/user/settings/payments/2-add-payment-method.png differdiff --git a/docs/images/user/settings/payments/2.payments_overview.png b/docs/images/user/settings/payments/2.payments_overview.pngdeleted file mode 100644index b610c93c2e..0000000000Binary files a/docs/images/user/settings/payments/2.payments_overview.png and /dev/null differdiff --git a/docs/images/user/settings/payments/3-provider-configuration.png b/docs/images/user/settings/payments/3-provider-configuration.pngnew file mode 100644index 0000000000..b9e94bdc0cBinary files /dev/null and b/docs/images/user/settings/payments/3-provider-configuration.png differdiff --git a/docs/images/user/settings/payments/3.payments_display.png b/docs/images/user/settings/payments/3.payments_display.pngdeleted file mode 100644index 0500f02740..0000000000Binary files a/docs/images/user/settings/payments/3.payments_display.png and /dev/null differdiff --git a/docs/images/user/settings/payments/4.enabled_payment_methods.png b/docs/images/user/settings/payments/4.enabled_payment_methods.pngdeleted file mode 100644index 445ef1093e..0000000000Binary files a/docs/images/user/settings/payments/4.enabled_payment_methods.png and /dev/null differdiff --git a/docs/images/user/settings/payments/5.available_payment_methods.png b/docs/images/user/settings/payments/5.available_payment_methods.pngdeleted file mode 100644index 825365e1ba..0000000000Binary files a/docs/images/user/settings/payments/5.available_payment_methods.png and /dev/null differdiff --git a/docs/images/user/settings/payments/6.add_payment_method.png b/docs/images/user/settings/payments/6.add_payment_method.pngdeleted file mode 100644index d2896dfb0c..0000000000Binary files a/docs/images/user/settings/payments/6.add_payment_method.png and /dev/null differdiff --git a/docs/images/user/settings/payments/7.payment_provider_settings.png b/docs/images/user/settings/payments/7.payment_provider_settings.pngdeleted file mode 100644index 4fa73ad274..0000000000Binary files a/docs/images/user/settings/payments/7.payment_provider_settings.png and /dev/null differdiff --git a/docs/images/user/settings/payments/8.display_settings.png b/docs/images/user/settings/payments/8.display_settings.pngdeleted file mode 100644index 35b32b098c..0000000000Binary files a/docs/images/user/settings/payments/8.display_settings.png and /dev/null differdiff --git a/docs/images/user/settings/payments/9.edit_payment_method.png b/docs/images/user/settings/payments/9.edit_payment_method.pngdeleted file mode 100644index 6ff222ab52..0000000000Binary files a/docs/images/user/settings/payments/9.edit_payment_method.png and /dev/null differdiff --git a/docs/images/user/settings/policies/1-policies-overview.png b/docs/images/user/settings/policies/1-policies-overview.pngnew file mode 100644index 0000000000..f4f7dae4bfBinary files /dev/null and b/docs/images/user/settings/policies/1-policies-overview.png differdiff --git a/docs/images/user/settings/policies/1-policies-tab.png b/docs/images/user/settings/policies/1-policies-tab.pngdeleted file mode 100644index fcfc1b9627..0000000000Binary files a/docs/images/user/settings/policies/1-policies-tab.png and /dev/null differdiff --git a/docs/images/user/settings/policies/2-policy-editor.png b/docs/images/user/settings/policies/2-policy-editor.pngnew file mode 100644index 0000000000..af4ec26d0dBinary files /dev/null and b/docs/images/user/settings/policies/2-policy-editor.png differdiff --git a/docs/images/user/settings/policies/2-policy-form.png b/docs/images/user/settings/policies/2-policy-form.pngdeleted file mode 100644index de3476f0a3..0000000000Binary files a/docs/images/user/settings/policies/2-policy-form.png and /dev/null differdiff --git a/docs/images/user/settings/policies/3-policy-published.png b/docs/images/user/settings/policies/3-policy-published.pngdeleted file mode 100644index 21c2811874..0000000000Binary files a/docs/images/user/settings/policies/3-policy-published.png and /dev/null differdiff --git a/docs/images/user/settings/sales-channels/1-sales-channels-overview.png b/docs/images/user/settings/sales-channels/1-sales-channels-overview.pngindex ea6b06238f..24ad734ce7 100644Binary files a/docs/images/user/settings/sales-channels/1-sales-channels-overview.png and b/docs/images/user/settings/sales-channels/1-sales-channels-overview.png differdiff --git a/docs/images/user/settings/sales-channels/2-new-sales-channel.png b/docs/images/user/settings/sales-channels/2-new-sales-channel.pngindex 79e3e4a366..7a978f470a 100644Binary files a/docs/images/user/settings/sales-channels/2-new-sales-channel.png and b/docs/images/user/settings/sales-channels/2-new-sales-channel.png differdiff --git a/docs/images/user/settings/sales-channels/3-order-routing-rules.png b/docs/images/user/settings/sales-channels/3-order-routing-rules.pngnew file mode 100644index 0000000000..b5eb5f2264Binary files /dev/null and b/docs/images/user/settings/sales-channels/3-order-routing-rules.png differdiff --git a/docs/images/user/settings/sales-channels/3-product-publishing-card.png b/docs/images/user/settings/sales-channels/3-product-publishing-card.pngdeleted file mode 100644index 44ae423ea7..0000000000Binary files a/docs/images/user/settings/sales-channels/3-product-publishing-card.png and /dev/null differdiff --git a/docs/images/user/settings/sales-channels/4-manage-channels.png b/docs/images/user/settings/sales-channels/4-manage-channels.pngdeleted file mode 100644index 83d6ca0775..0000000000Binary files a/docs/images/user/settings/sales-channels/4-manage-channels.png and /dev/null differdiff --git a/docs/images/user/settings/sales-channels/4-product-publishing-card.png b/docs/images/user/settings/sales-channels/4-product-publishing-card.pngnew file mode 100644index 0000000000..6bfdfbf0c2Binary files /dev/null and b/docs/images/user/settings/sales-channels/4-product-publishing-card.png differdiff --git a/docs/images/user/settings/sales-channels/5-channel-scheduling.png b/docs/images/user/settings/sales-channels/5-channel-scheduling.pngindex 975604a115..a532e29eef 100644Binary files a/docs/images/user/settings/sales-channels/5-channel-scheduling.png and b/docs/images/user/settings/sales-channels/5-channel-scheduling.png differdiff --git a/docs/images/user/settings/sales-channels/6-orders-list-channel-column.png b/docs/images/user/settings/sales-channels/6-orders-list-channel-column.pngindex beeb4443d7..6ed7b1ff35 100644Binary files a/docs/images/user/settings/sales-channels/6-orders-list-channel-column.png and b/docs/images/user/settings/sales-channels/6-orders-list-channel-column.png differdiff --git a/docs/images/user/settings/sales-channels/7-order-details-channel.png b/docs/images/user/settings/sales-channels/7-order-details-channel.pngdeleted file mode 100644index 7ac8c47975..0000000000Binary files a/docs/images/user/settings/sales-channels/7-order-details-channel.png and /dev/null differdiff --git a/docs/images/user/settings/store-details/1-name-and-logo.png b/docs/images/user/settings/store-details/1-name-and-logo.pngdeleted file mode 100644index 2673d705ad..0000000000Binary files a/docs/images/user/settings/store-details/1-name-and-logo.png and /dev/null differdiff --git a/docs/images/user/settings/store-details/1-store-settings.png b/docs/images/user/settings/store-details/1-store-settings.pngnew file mode 100644index 0000000000..366feec578Binary files /dev/null and b/docs/images/user/settings/store-details/1-store-settings.png differdiff --git a/docs/images/user/settings/store-details/2-standards-and-formats.png b/docs/images/user/settings/store-details/2-standards-and-formats.pngdeleted file mode 100644index 7a60b44e5b..0000000000Binary files a/docs/images/user/settings/store-details/2-standards-and-formats.png and /dev/null differdiff --git a/docs/images/user/settings/store-details/2-storefront-access.png b/docs/images/user/settings/store-details/2-storefront-access.pngnew file mode 100644index 0000000000..1743111a5fBinary files /dev/null and b/docs/images/user/settings/store-details/2-storefront-access.png differdiff --git a/docs/images/user/settings/store-details/3-order-numbers.png b/docs/images/user/settings/store-details/3-order-numbers.pngnew file mode 100644index 0000000000..372138ee18Binary files /dev/null and b/docs/images/user/settings/store-details/3-order-numbers.png differdiff --git a/docs/images/user/settings/store-details/3-phone-and-address.png b/docs/images/user/settings/store-details/3-phone-and-address.pngdeleted file mode 100644index ea49065182..0000000000Binary files a/docs/images/user/settings/store-details/3-phone-and-address.png and /dev/null differdiff --git a/docs/images/user/settings/store-details/4-digital-assets.png b/docs/images/user/settings/store-details/4-digital-assets.pngdeleted file mode 100644index 83ab78b148..0000000000Binary files a/docs/images/user/settings/store-details/4-digital-assets.png and /dev/null differdiff --git a/docs/images/user/settings/store-details/4-payments.png b/docs/images/user/settings/store-details/4-payments.pngnew file mode 100644index 0000000000..c9d9676666Binary files /dev/null and b/docs/images/user/settings/store-details/4-payments.png differdiff --git a/docs/images/user/settings/store-details/5-inventory.png b/docs/images/user/settings/store-details/5-inventory.pngnew file mode 100644index 0000000000..469c2eba74Binary files /dev/null and b/docs/images/user/settings/store-details/5-inventory.png differdiff --git a/docs/images/user/settings/store-details/6-catalog.png b/docs/images/user/settings/store-details/6-catalog.pngnew file mode 100644index 0000000000..46598811a7Binary files /dev/null and b/docs/images/user/settings/store-details/6-catalog.png differdiff --git a/docs/images/user/settings/store-details/7-digital-downloads.png b/docs/images/user/settings/store-details/7-digital-downloads.pngnew file mode 100644index 0000000000..c2e20fbc71Binary files /dev/null and b/docs/images/user/settings/store-details/7-digital-downloads.png differdiff --git a/docs/images/user/settings/store-details/placeholder b/docs/images/user/settings/store-details/placeholderdeleted file mode 100644index 8b13789179..0000000000--- a/docs/images/user/settings/store-details/placeholder+++ /dev/null@@ -1 +0,0 @@-diff --git a/docs/user/settings/delivery-profiles.mdx b/docs/user/settings/delivery-profiles.mdxindex d1e8ee3e4d..751a7dae95 100644--- a/docs/user/settings/delivery-profiles.mdx+++ b/docs/user/settings/delivery-profiles.mdx@@ -1,105 +1,180 @@---title: "Delivery Profiles"-description: "Learn how to set up delivery profiles in Spree Commerce — the origins, zones and delivery methods that decide what a customer is offered at checkout."+description: "Learn how to set up delivery profiles in Spree Commerce, the origins, zones and delivery methods that decide what a customer is offered at checkout."----If you want to run a successful online business, having shipping methods in place is essential. These methods appear at checkout, representing the carriers and services used to deliver your products to customers.+A delivery profile is a set of rules for how a group of products ships. It holds the warehouses those products ship from, the places they can be sent to, and the delivery methods offered for each of those places. Every product ships on a profile, so the delivery methods a customer sees at checkout are dependant on which profile their address and the products in their cart qualify for.-<Warning>If you don’t set up at least one shipping method for each region you sell to, customers in those regions won’t be able to complete their checkout.</Warning>+Most stores need more than one. Bulky furniture does not ship like a pair of shoes, and a download does not ship at all. Rather than setting rules product by product, you build a profile for each kind of goods and point products at it.-To set up shipping methods, navigate to **Settings → Shipping** in the Spree dashboard.+To manage delivery profiles, navigate to **Settings → Delivery profiles**, under the **Shipping & delivery** group.-+## Reviewing Your Delivery Profiles-## Add a New Shipping Method+-To add a new shipping method, click **New Shipping Method** in the top right corner. This will open the shipping method creation form.+Each row shows:-+- **Name** - What the profile is called. One profile carries a **Default** badge.+- **Capabilities** - What this profile can do: **Ships**, **Pickup**, **Digital**, or a combination.+- **Ships from** - How many stock locations its goods leave from, or **All locations**.+- **Products** - How many products are assigned to it.+- **Zones** - How many destination zones it covers.+- **Methods** - How many delivery methods it offers in total.-This page is divided into seven distinct sections, so let’s take a look at each individually:+<Note>The **Products** count is read-only. A product is assigned to a profile from the product page, not from the delivery profile.</Note>-### Presentation+## How to Create a Delivery Profile-+Click **Add profile** to open the delivery profile creation form.-Here you can set a descriptive name for the shipping method (e.g., UPS Standard, FedEx Next Day), and choose where it should be displayed.+-<Warning>Make sure the **Display on** setting includes **storefront** if you want customers to see this shipping method on the checkout.</Warning>+- **Name** - Name it after the kind of goods it covers, such as Bulky Items or Digital, rather than after a carrier.+- **Kind** - **Shipping** for physical goods, or **Digital** for downloads. This decides which fulfillment providers the profile's methods can use.+- **Origins** - **All locations**, or **Selected locations** to name the warehouses these goods ship from.-### Tracking URL+Click **Create profile**, then open it to add zones and methods. That is where the real work is.-+<Warning>The **Kind** cannot be changed after the profile is created. If you pick the wrong one, you will need to create a new profile and reassign its products.</Warning>-Here you can add the tracking URL format for the shipping carrier that’s associated with the shipping method, e.g.:+## Inside a Profile-- [<u>https://www.fedex.com/wtrk/track/?trknbr=:tracking</u>](https://www.fedex.com/wtrk/track/?trknbr=:tracking)-- [<u>https://www.ups.com/track?loc=en_US&tracknum=:tracking</u>](https://www.ups.com/track?loc=en_US&tracknum=:tracking)-- [<u>https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=:tracking</u>](https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=:tracking)+A delivery profile is built in three layers: the **origin** the goods leave from, the **zones** that origin can reach, and the **delivery methods** offered within each zone.-This way, you can simply enter the tracking number when fulfilling an order that’s using the associated shipping method, and the customer will receive the correct tracking link for their order.+-<Warning>Make sure to verify the tracking link format for each shipping carrier you plan on using and test them before going live.</Warning>+Two panels on the right side of the page control the profile itself:-### Zones+- **General** - The profile's **Name**, its **Kind** (fixed at creation), and a **Default** switch. The default profile is what products without a profile of their own ship on.+- **Ships from** - **All locations**, or a tick box per stock location.-+### Shipping from more than one warehouse-Not all shipping methods should be available in every region - especially if you serve customers across multiple countries or continents. Zones allow you to define regional availability for each shipping method.+If goods leave from several warehouses and the rates differ, click **Split shipping origins**. This breaks the profile into origin groups, each with its own zones and methods, so stock leaving Amsterdam can be priced differently from the same goods leaving California.-Simply select the appropriate Zone(s) to ensure the method only appears for customers in those regions. This helps you prevent invalid shipping options and tailor your delivery strategy to each market.+If rates are the same wherever goods ship from, leave it unsplit.-<Note>Customers will only see shipping methods that apply to their delivery address based on the assigned Zones.</Note>+## How to Add a Delivery Zone-### Shipping Categories+A zone is a set of destinations a method can be offered to. Click **Add delivery zone** within the origin group it belongs to.-+-Shipping Categories are especially useful when your store includes products with very different delivery needs. For example:+Name the zone after the region it covers, then choose the countries in it. A zone can hold one country or two hundred, so a single **International** zone is often easier to maintain than one zone per country.-- Assigning a “Digital” category to non-physical products ensures they skip the shipping step during checkout.-- Creating a “Heavy” category for large or heavy items allows you to limit specific shipping methods to those products.+<Note>Every profile has a default **No zone restriction** container. Methods placed inside it are offered wherever the profile reaches, regardless of destination.</Note>-### Tax Category+<Warning>A customer whose address falls outside of every configured delivery zone will have no delivery method to choose from and be unable to complete checkout. Make sure each delivery profile covers every location you plan to sell to.</Warning>-+### Postal code rules-Use this setting to assign a Tax Category to the shipping method. This determines how taxes are applied to shipping charges at checkout.+For finer control, add postal code rules within a country. This is how you separate destinations that cost more to reach, such as pricing the Scottish Highlands differently from the rest of the United Kingdom, or excluding offshore postcodes from a next-day service.-Different types of products may be subject to different tax rules, and assigning a tax category here ensures that shipping is taxed appropriately based on the contents of the order.+Each rule offers three fields:-For example:+- **Prefix** - Matches any postal code starting with what you enter, so `IV` covers every code in the Scottish Highlands. Works with every postal code format.+- **From** and **To** - Matches a range of postal codes, and the range includes both ends. `1000` to `1999` covers `1000` and `1999` as well as everything between them.-- In some regions, digital goods may be exempt from shipping tax, while physical goods are not.-- Shipping charges related to tax-exempt products might also need to be excluded from tax calculations entirely.+<Warning>**Prefix** and the **From** / **To** range are alternatives, not companions. Set one or the other on a rule, never both. A rule carrying both is rejected.</Warning>-Assigning the correct tax category helps you stay compliant with local tax regulations and ensures customers are charged accurately.+Which you use depends on the country. **From** and **To** only work with numeric postal codes, such as the Netherlands or the United States, so a country with letters in its postal code format has to use **Prefix**. Prefix, on the otherhand, works everywhere.-### Calculator+## How to Add a Delivery Method-+A delivery method is what the customer actually chooses at checkout. Click **Add method** inside the zone it should belong to.-This section determines how the shipping cost will be calculated for this method. Spree offers several calculator types to support different pricing strategies:+-- **Flat Percent** - charges a percentage of the order total as the shipping cost.-- **Flat Rate** - charges a fixed shipping amount, regardless of order size or value.-- **Flexible Rate per package item** - charges a base rate plus an additional amount for each item in the package (ideal for variable-size orders).-- **Flat Rate per package item** - Applies the same fixed fee to every item in the shipment.-- **Price Sack** - offers tiered pricing based on the total order value (e.g., \$5 for orders under \$50, free over \$100).-- **Digital Delivery** - used for digital products that don’t require physical shipping (typically results in no shipping cost).+Within the side panel editor, there are several different sections that need to be configured:-Each calculator type may reveal different fields depending on its configuration. Choose the one that best aligns with your fulfillment strategy.+### Providers-For a more detailed guide on shipping calculators, please refer to another support article.+These two settings decide who handles the delivery and where its price comes from. Most stores can leave both on their defaults and price the method themselves.-### Estimated Transit Business Days+- **Fulfillment provider** - How fulfillments for this method are dispatched and tracked:+ - **Manual** for goods you ship yourself,+ - **Pickup** for collection,+ - **Pickup Point** for a third-party collection point.+- **Delivery rate provider** - Where the price comes from:+ - **Internal** prices with the calculator below, which is what most stores want.+ - **Freight** is for freight carriers.-+<Note>Both dropdowns show a greyed entry reading "Connect EasyPost to use it". That is a prompt, not a choice. Connecting EasyPost lets these methods quote live carrier rates instead of using an internal calculator.</Note>-This optional setting allows you to display an estimated delivery time for the shipping method, visible on both the product detail page (PDP) and during checkout.+### Naming and visibility-While not required, showing delivery estimates can help build trust, reduce cart abandonment, and improve conversions by setting clear expectations about when customers will receive their orders.+What this method is called, who sees it, and where it can be used. Customers only ever see the **Name**, so it is worth wording it around how fast the delivery is rather than which carrier you use.-### Create Shipping Method+- **Name** - What customers see at checkout. Be specific about speed rather than carrier, such as "Next day" rather than "DHL".+- **Internal name** - What your team sees. Useful when two methods look alike at checkout.+- **Code** - A short reference for integrations and exports.+- **Visible in storefront** - On by default. Turn it off to keep a method for staff-created orders only.+- **Available to sellers** - Off by default. Turn it on to let marketplace sellers ship with this method.-Once you’ve configured all of the above settings, simply click **Create** at the bottom of the page to save your new shipping method. It will become immediately available to customers provided the order details match the method’s configuration.+### Pricing++What the method charges and how that charge is taxed.++- **Rate Calculator** - How the price is worked out. See the calculators below.+- **Tax category** - Which tax applies to the delivery charge, if delivery is taxed where you sell.+- **Currency** - Which currency the rate is priced in. This only applies to the rate-based calculators, so it has no effect on a method that does not charge a set amount.++#### Rate calculators++The calculator decides what a method charges. Six are available:++| Calculator | What it charges |+|---|---|+| **Flat Rate** | One price per order, whatever is in the cart. The simplest option and the right default for most methods. |+| **Per Item** | A price for each item in the cart, so a cart of five item costs five times a cart of one. |+| **Flat Percent** | A percentage of the order total, so delivery scales with cart value. |+| **Flexi Rate** | A price for the first item plus a smaller price for each additional item, up to a cap. Suits goods that combine into one parcel. |+| **Price Sack** | Charges one rate below a set order value and a discounted rate above it, so larger orders pay less to ship. |+| **Digital Delivery** | For downloads, where nothing physical ships. |++### Delivery expectations++What you tell the customer about timing and tracking. Neither field changes the price, but both reduce the number of "where is my order" messages your team answers.++- **Estimated transit, business days** - A minimum and a maximum, shown to the customer at checkout.+- **Tracking URL** - The carrier's tracking link, with `:tracking` being where the tracking number goes.++### Conditions++Conditions limit when a method is offered, based on what is in the cart or who is buying. A method with no conditions is offered to everyone who reaches it. Click **Add condition** to choose from:++- **Item total** - Offer the method only above or below a cart value. This is how a free delivery threshold is built.+- **Weight** - Offer the method only within a certain weight range.+- **Excluded products** - Hide the method when the cart contains particular products.+- **Channel** - Offer the method only on certain sales channels.+- **Volume** - Offer the method only within a certain size range.+- **Company** - Offer the method only to particular business customers.++With no conditions set, the method is offered wherever it otherwise applies.++<Note>Free delivery over a threshold is an **Item total** condition on a method priced at zero, not a setting of its own.</Note>++Click **Create delivery method** when you are done.++## Pickup++Pickup is for orders customers collect in person. It sits in its own section on the profile page, outside the origin groups, because collection has no destination and zones do not apply.++++Add a method the same way as any other, choosing **Pickup** as the fulfillment provider, then tick the locations under **Collect from**. Only the locations you tick are offered to customers.++<Warning>The **Collect from** tick boxes save the moment you click them. There is no Save button on this panel and no confirmation, so an accidental tick takes effect immediately.</Warning>++## How to Delete a Delivery Profile++Open the row menu on the profiles list and choose **Delete**.++<Note>The default profile cannot be deleted. Its row offers **Edit** only, because products with no profile of their own rely on it. Make another profile the default first if you need to remove it.</Note>++## Further Reading++- [<u>Stock Locations</u>](/user/settings/locations) - The warehouses and pickup points a profile ships from+- [<u>Package Types</u>](/user/settings/package-types) - The boxes and pallets used when quoting+- [<u>Create a Product</u>](/user/products/creating-products) - Where a product is assigned to a profilediff --git a/docs/user/settings/emails.mdx b/docs/user/settings/emails.mdxindex 473d747740..32277605eb 100644--- a/docs/user/settings/emails.mdx+++ b/docs/user/settings/emails.mdx@@ -1,32 +1,49 @@---title: "Emails"-description: "Configure how your store communicates with customers via email."+description: "Learn how to set the addresses your store's transactional emails come from, who replies reach, and the logo shown at the top."----Email communication is a key part of building trust with your customers. From order confirmations to support inquiries, making sure your emails are professional and come from the right addresses helps reinforce your brand and ensures important messages reach the right people.+Spree sends transactional emails automatically as orders move: confirmations, shipping notifications, refunds and password resets. This screen controls the addresses behind those emails, who is told when an order comes in, and the logo at the top of each one.-To configure email settings, navigate to the Emails tab of the Settings menu.+Email wording and layout are handled separately by your developers, who set the templates. What you control here is where mail comes from and where replies land, which is what customers actually judge when a message arrives.-+To configure email settings, navigate to **Settings → Emails**, under the **Store** group.-## Logo for Emails+-+## Delivery-Here you can upload a logo that will appear in all automated email notifications (e.g. order confirmations, shipment tracking). Simply select the file you wish to upload.+Whether your store emails customers at all.-Note: We recommend using a transparent PNG or JPEG for best results.+- **Send transactional emails to customers** - When off, no order confirmation, shipping, or refund emails are sent.++<Warning>Turning this off stops every customer email, besides password resets. Customers will place orders and hear nothing back, so only use it on a store that is not yet live or where another system is being used to send the messages instead.</Warning>## Email Addresses-+Three addresses doing three different jobs. Each is worth setting deliberately, because they appear in different places and confusing them is easy.++- **Sender address** - The From address on every transactional email. This is what a customer sees the message arrive from, so use an address at your own domain rather than a personal one.+- **Customer support email** - The reply-to address shown to customers in storefront emails. When a customer hits reply, this is where it goes, so it needs to be a mailbox somebody actually reads.+- **New order notifications** - Where "new order placed" notifications are sent. Use an internal address your team monitors, or leave it blank to turn those notifications off.++<Note>**Sender address** and **Customer support email** are often different on purpose. Mail goes out from a no-reply address, and replies are routed to a support inbox.</Note>++## Logo-Here you can set the email addresses that will be used for various purposes by your business:+The image embedded in the header of transactional emails.-- **Mail from address**: The email address used as the sender for all outgoing store emails.-- **Customer Support Email**: This will be shown in your store’s footer so customers know how to reach you.-- **New Order Notifications Email**: Want to be notified every time an order is placed? Enter the email address where those alerts should go.+++Drop an image into the upload area or click to browse. Spree recommends **204 by 104 pixels**, as a PNG or JPG with a transparent background.++<Note>A transparent background matters more here than elsewhere, because email clients render backgrounds differently and a logo with a white box around it will look wrong against a coloured header.</Note>## Saving Changes-After making any updates, click Update at the bottom of the page to save your email settings, otherwise any changes you’ve made will not be saved.\ No newline at end of file+Click **Save** at the top of the page. The button stays greyed out until you change something.++## Further Reading++- [<u>Policies</u>](/user/settings/policies) - The terms and privacy documents linked from your emails and storefront+- [<u>Sending out Emails</u>](/developer/deployment/emails) - How your developers configure delivery and customise templatesdiff --git a/docs/user/settings/locations.mdx b/docs/user/settings/locations.mdxindex f14e0b9bb5..d9661779e3 100644--- a/docs/user/settings/locations.mdx+++ b/docs/user/settings/locations.mdx@@ -1,44 +1,143 @@---title: "Stock Locations"-description: "Learn how to create and manage stock locations in Spree Commerce."+description: "Learn how to set up the warehouses, shops and pickup points your store holds stock in and fulfils orders from."----For large businesses with multiple warehouses, the ability to add multiple stock locations is essential for efficiently managing inventory across different regions.+A stock location is a place you hold stock and fulfil orders from. That might be a warehouse, a shop with a stockroom, or a third-party fulfilment centre. Every unit of stock in your store sits at a location, and every order is fulfilled from one.-It ensures accurate stock tracking, optimizes order fulfillment, and enables faster shipping by routing orders from the nearest warehouse.+Stores running a single warehouse can largely set this up once and leave it. It becomes more involved as you add locations: stock is counted per location, [<u>transfers</u>](/user/inventory/stock-transfers) move goods between them, and [<u>delivery profiles</u>](/user/settings/delivery-profiles) decide which locations ship to which places and at what price.-To set up and manage stock locations, navigate to **Settings → Locations**.+To manage stock locations, navigate to **Settings → Stock locations**, under the **Shipping & delivery** group.-+## Reviewing Your Stock Locations-## Add a New Location+-To add a new Location, click on **New Stock Location** in the top right corner. This will open the Location creation form.+Each row shows:-+- **Name** - What the location is called.+- **Type** - Whether it is a warehouse, a store, or a fulfillment center.+- **Location** - The city and country from its address.+- **Pickup** - Whether customers can collect orders from here.+- **Returns** - Whether returned goods come back here.+- **Active** - Whether the location is available for fulfilment.+- **Default** - The location new stock levels propagate to. Only one location carries this.+- **Seller** - On a marketplace, the seller the location belongs to.-Simply enter a name, company name, the address, and (optionally) a phone number, and click then click **Create** at the bottom of the page to create the Location.+Use the **Type** filter to narrow the list to warehouses, stores or fulfillment centers.-The new Location will now be added to your list of stock locations.+## How to Create a Stock Location-+Click **Add stock location**. A panel opens with five groups of settings.-## Edit a Location+-To edit a Location, simply click **Edit** on the right-hand side of the Location’s row, and update the information as necessary.+### Details-## Set a Default Location+What the location is called and what kind of place it is.-To set your default Location, click the **three-dot menu** on the right-hand side of the Location’s row and select **Mark as default** from the menu.+- **Name** - What the location is called. Customers may see this at checkout when choosing a pickup point.+- **Internal name** - An optional alternative name shown only in the admin, for when your team calls a location something different from what customers see.+- **Kind** - **Warehouse**, **Store**, or **Fulfillment center**.-+### Behavior-## Delete a Location+Four switches that decide how the location handles stock.-To delete a Location, click **Edit** on the right side of the Location’s row to open the Location edit form, and click **Delete** at the bottom of the page.+- **Active** - On by default. Inactive locations do not appear in fulfillment selection.+- **Default location** - New stock levels propagate here. Only one location can be default.+- **Backorderable by default** - New stock levels at this location default to allowing backorders when out of stock.+- **Auto-create stock levels for all variants** - Creates a stock level at this location for every product variant you sell.-+<Warning>Turning on **Auto-create stock levels for all variants** puts every variant in your catalogue onto this location's books at once. On a large catalogue that is a lot of rows. Leave it off if the location will only ever carry part of your range.</Warning>-The Location will then be removed from your list of stock locations.+### Address-Congratulations, you now know how to create, edit, and delete stock locations!+- **Address line 1**, **Address line 2**, **City**, **Postal code**, **Country**, **State / Province**+- **Phone**+- **Company**++A complete address matters more than it looks. It is what carriers quote delivery rates from, and what customers are shown when collecting an order in person.++<Note>The **State / Province** field changes shape with the country you pick, appearing as a dropdown for countries with defined states and a plain text box for those without.</Note>++### Returns++Whether goods customers send back come here.++- **Accept returns here** - On by default. Returned goods come back to this location. Turn it off if returns are inspected somewhere else.++<Note>**Accept returns here** is on by default, so a new location will start receiving returns as soon as it is created unless you turn it off.</Note>++### Pickup++Whether customers can collect their orders here in person.++- **Allow customer pickup** - Off by default. Customers can pick orders up from this location at checkout.++Turning this on reveals three more settings that decide how collection works here:++- **Stock policy** - What a customer can collect:+ - **Only items at this location** offers pickup for what is already on this shelf, so a customer is never promised something that is not there.+ - **Allow transfers from other locations** lets them collect items you would bring in from another warehouse first.+- **Ready in (minutes)** - How long it takes your team to have an order ready to collect. This sets the expectation the customer is given at checkout, so base it on how quickly someone actually picks and packs rather than on how quickly you would like to.+- **Pickup instructions** - Where the customer should go to collect their order. Worth being specific: the entrance to use, the desk to ask at, and what to bring.++<Warning>**Allow transfers from other locations** means a customer can order to pick up something this location does not hold. Only use it where your team will reliably review and process the transfer and bring the stock in, otherwise a customer arrives to collect an order that was never here.</Warning>++Click **Create stock location** when you are done.++## How to Edit a Stock Location++Open the row menu on any location and choose **Edit**. The panel carries everything from the creation form, plus two sections that only appear once the location exists.++### Stock at this location++++This panel lists every variant stocked here, with its **On hand** count and whether it is **Backorderable**, and lets you adjust both per variant. Variants running low are marked **low stock**.++Use the search box to find a product by name or SKU. If the location has no stock yet, the panel reads **No stock levels at this location yet**.++<Note>For day-to-day counting, the [<u>Inventory</u>](/user/inventory/stock-levels) page is usually quicker, because it shows every location at once and records a reason against each correction.</Note>++### Stock history++Every change to this location's stock, newest first, and what caused it. Where the **Stock at this location** panel shows what you have now, this shows how it got that way.++++Each row records:++- **Date** - When the change happened.+- **Product** - The variant that moved, with its SKU beneath.+- **Where** - The location the change was recorded against.+- **Change** - How many units, signed. Additions are shown in green and departures in red.+- **What happened** - **Received**, **Allocated**, **Shipped**, **Released**, or **Adjusted**.+- **Why** - The document behind the change, such as **Purchase order**, **Stock transfer**, **Return**, **Exchange**, **Fulfillment**, **Order**, or **Manual adjustment**.++The **Why** column names the document and links to it, so a row reading "Stock transfer T1001" takes you straight to the transfer that moved the units. Returns and exchanges link to the order they belong to.++This is where you answer "why is this number what it is". A count that looks wrong is usually explained by a movement here, and if it is not, the change was made outside Spree and needs a correction with a reason attached.++<Note>If the location has never held stock, the panel reads **Nothing has changed this stock yet**.</Note>++Click **Save** when you have finished, then **Close**.++## How to Set a Default Location++The default location is the one new stock levels propagate to. To change it, open the location you want as the default, turn on **Default location**, and save.++<Note>Only one location can be default. Turning the switch on for one location takes it off whichever location held it before.</Note>++## How to Delete a Stock Location++Open the row menu on the locations list and choose **Delete**.++<Warning>Deleting a location removes the stock records held there. Move the stock out with a [<u>transfer</u>](/user/inventory/stock-transfers) first if it is going somewhere else, so the movement is recorded rather than simply disappearing.</Warning>++## Further Reading++- [<u>Inventory</u>](/user/inventory/stock-levels) - What you have at each location+- [<u>Stock Transfers</u>](/user/inventory/stock-transfers) - Moving stock between locations+- [<u>Delivery Profiles</u>](/user/settings/delivery-profiles) - Which locations ship where, and at what pricediff --git a/docs/user/settings/markets.mdx b/docs/user/settings/markets.mdxindex d08cd09dd6..a9c7f6f4c3 100644--- a/docs/user/settings/markets.mdx+++ b/docs/user/settings/markets.mdx@@ -1,74 +1,82 @@---title: "Markets"-description: "Learn how to create and manage markets in Spree Commerce."+description: "Learn how to define the regions you sell to in Spree Commerce, each with its own currency, languages and tax treatment."----import { Since } from '/snippets/since.mdx';+A market is a region you sell to, grouped into a single pricing area with its own currency, languages and tax treatment. Rather than configuring each country separately, you group the countries that should behave the same way and set the rules once.-<Since version="5.4" />+Most stores start with one market covering everywhere they ship, and add more as they grow. A store selling into the EU and the US needs two, because one prices in euros with tax shown in the price and the other prices in dollars with tax added at checkout. Markets are also available as a rule condition on price lists, so a region can carry its own prices without duplicating products.-Markets allow you to define distinct shopping experiences for different regions or customer-segments — each with its own currency, language, and tax settings. When multiple markets are-configured, customers can switch between them on the storefront to see prices and content in-their preferred currency and language.+To manage markets, navigate to **Settings → Markets**, under the **Selling** group.-Markets can also be used as a rule condition in Price Lists, making it easy to apply-region-specific pricing without duplicating products.+## Reviewing Your Markets-To manage markets, navigate to **Settings → Markets** in the admin dashboard.+-+Each row shows:-## Markets Overview+- **Name** - What the market is called. The countries it covers are listed beneath.+- **Currency** - The currency all prices in this market are held in.+- **Default locale** - The language shoppers in this market see first.+- **Tax** - Whether prices in this market include tax or have it added at checkout.+- **Default** - The market shown to shoppers whose country is unknown.-The Markets table displays all configured markets with the following details:+This list is dragged into order rather than sorted, so use the handle on any row to move it.-- **Name** — the internal label for the market (e.g., "United States", "Europe")-- **Currency** — the currency customers in this market will see at checkout-- **Default Locale** — the primary language for this market-- **Default** — indicates which market is set as the default for new visitors+## How to Create a Market-## Create a Market+Click **Add market**.-To create a new market, click **New Market** in the top-right corner.+-+- **Name** - What the region is called internally, such as Europe or DACH.+- **Currency** - The currency used for all prices in this market.+- **Default locale** - The storefront language shoppers in this market see first.+- **Supported locales** - Additional languages shoppers can switch to. The default locale is always included.+- **Countries** - The countries this market covers. Search for each one and add it.+- **Tax engine** - Which engine calculates tax for orders in this market. Leave this as it is unless another engine has been installed for your store.+- **Tax-inclusive pricing** - Display prices with tax included. Common in EU markets.+- **Default market** - Shoppers without a known country see this market. Only one can be default per store.-Fill in the following fields:+Click **Create market** when you are done.-- **Name** — an internal label to identify this market (e.g., "United Kingdom", "DACH Region")-- **Default Country** — the primary country for this market, used to determine default shipping- and tax behaviour-- **Currency** — the currency displayed to customers in this market at checkout-- **Default Locale** — the primary language shown to customers in this market-- **Supported Locales** — additional languages customers can switch to within this market-- **Tax Inclusive** — check this if prices should be displayed with tax already included- (common in VAT-inclusive markets such as the EU)-- **Default** — check this to make this the default market for visitors who haven't selected one+<Warning>Each country can belong to at most one market per store. A country already claimed by another market cannot be added to a second one, so plan your coverage before creating several markets.</Warning>-Once you've filled in the details, click **Create** to save the new market.+### What the built-in tax engine does not calculate-<Note>A country must be included in a configured Zone before it can be set as the Default Country for a Market. See Zones for setup instructions.</Note>+Spree's built-in tax engine handles the rates you configure per country or state. Four things it does not do are printed under the **Tax engine** chooser, and each one can mean collecting the wrong amount of tax:-## Edit a Market+- **US local tax** - "County, city and district rates are not applied, only the rates configured per country or state. Sales into US states that levy local tax will be under-collected."+- **EU reverse charge** - "A VAT-registered business buyer is charged tax instead of receiving a zero-rated invoice. Their registration number is recorded but does not change the tax."+- **Distance-selling thresholds** - "Crossing the EU-wide cross-border threshold does not switch to destination-country rates automatically, because it depends on annual turnover across every destination rather than on any single order."+- **Proportional delivery tax** - "Delivery is taxed at the single rate its delivery method names, not split across the rates of the goods being delivered. A basket mixing tax rates collects the wrong amount on delivery."-To edit a market, click on its row in the Markets table to open the edit form.+<Warning>If any of these apply to where you sell, connect a tax provider and then select it in **Tax engine** on every market it affects. Connecting a provider does not change anything on its own, and a market left on the built-in engine keeps calculating tax with it.</Warning>-+<Note>Tax rates and their calculators are configuration for the built-in engine, and do not decide which engine a market uses. Setting a rate's calculator does not move that market off the built-in engine. See [<u>Tax Rates</u>](/user/settings/tax-rates) for what rates do.</Note>-The edit form contains the same fields as the creation form. Update the relevant fields and-click **Update** to save your changes.+## How to Edit a Market-## Delete a Market+Click a market's row to open it. The panel carries the same controls as the creation form, with chosen locales and countries shown as removable chips.-To delete a market, click on its row to open the edit form, then click **Delete** at the-bottom of the page.+### Changing a market's currency-<Warning>Deleting a market cannot be undone. Before deleting, check that no active Price List rules or storefront configurations reference this market.</Warning>+Changing the currency does not convert the prices you already have. It changes which currency the market's prices are read from, and nothing is carried across:-## Related+- Products need a **base price** in the new currency.+- Price list entries for that market appear with empty prices until you fill them in.-- [<u>Delivery Profiles</u>](/user/settings/delivery-profiles)-- [<u>Tax Rates</u>](/user/settings/tax-rates)-- [<u>Tax Categories</u>](/user/settings/tax-categories)-- [<u>Price Lists</u>](/user/pricing/price-lists)+<Warning>Set the base prices and any price list prices in the new currency before switching a live market. A product with no price in the market's currency is hidden from the storefront, unless **Show products without a price** is turned on in [<u>Store Details</u>](/user/settings/store-details).</Warning>++## How to Delete a Market++Open the row menu and choose **Delete**.++<Warning>Before deleting, check that no price list rules or storefront configuration reference this market. Countries covered by a deleted market are freed up and can be added to another one.</Warning>++## Further Reading++- [<u>Tax Rates</u>](/user/settings/tax-rates) - The rates charged in each market+- [<u>Tax Categories</u>](/user/settings/tax-categories) - The tax classes products are assigned to+- [<u>Price Lists</u>](/user/pricing/price-lists) - Using a market as a pricing rule+- [<u>Delivery Profiles</u>](/user/settings/delivery-profiles) - Where goods can be shipped, and at what pricediff --git a/docs/user/settings/payments.mdx b/docs/user/settings/payments.mdxindex bbae5022f2..508fb53c2b 100644--- a/docs/user/settings/payments.mdx+++ b/docs/user/settings/payments.mdx@@ -1,119 +1,108 @@---title: "Payment Methods"-description: "Learn how to view, add, edit, and remove payment methods in Spree."+description: "Learn how to set up the ways customers can pay in Spree Commerce, and control when their money is taken."----Payments are a vital part of any e-commerce store. Spree offers a flexible and modular system for managing payment methods, supporting both out-of-the-box and third-party options.+A payment method is a way for a customer to pay, and the provider that handles it. Most stores need more than one, because different customers pay differently and not every method suits every order.-<Warning>- Not all payment methods are available by default - most require the installation of additional gems by a developer before they can be used in the admin interface.-</Warning>+A typical setup might pair a card gateway for everyday retail with one or two methods your team uses on back-office orders. A business customer placing a large order may need to pay on invoice rather than by card, and a shop with a counter may take payment in person. Each of those is its own payment method, and each can be shown to customers or kept for staff only.-To manage payments, navigate to the Payments tab of the Settings menu.+To manage payment methods, navigate to **Settings → Payment methods**, under the **Selling** group.-+<Note>Stripe is included with Spree out of the box, so you can take card payments by connecting an account rather than installing anything first.</Note>-## Payment Methods Overview+## Reviewing Your Payment Methods-+-Here you can see a list of enabled payment methods, and a list of available payment methods:+Each row shows:-### Enabled Payment Methods+- **Name** - What the method is called, with its customer-facing description beneath.+- **Provider** - What handles the payment behind the scenes.+- **Storefront** - **Visible** if customers can choose it, **Admin only** if it is reserved for staff.+- **Status** - Whether the method is active or disabled.-+The order of this list is the order customers see at checkout. Drag the handle on any row to move it, and put your most-used method at the top.-Enabled methods are those that are configured and can be used by customers on checkout.+## How to Add a Payment Method-You can easily modify the display settings of enabled payment methods by changing the visibility and active status.+Click **Add payment method**. A panel opens, and the first thing to choose is the provider.-+-### Available Payment Methods+### Choosing a provider-+The **Provider** decides what actually processes the payment, and which settings appear afterwards. There are two kinds.-Available payment methods are those that have been installed, but have not been configured yet.+**Third-party providers**, such as Stripe, connect to an outside payment processor. They need credentials from that provider, which you enter in the same panel while creating the method.-### Default Payment Methods+**Built-in methods** need no credentials because nothing is being processed elsewhere:-By default, the following payment methods are available in Spree:+- **Check** - Records that a customer will pay by cheque or bank transfer. The order is created and your team marks it paid when the money arrives.+- **Store Credit** - Lets customers pay with credit already on their account.+- **Custom Payment Source Method** - A generic method for payment arrangements handled outside Spree, such as an account customer paying on invoice.+- **Bogus** - A test method that simulates payments without moving money. Use it to try a checkout end to end, and keep it **Admin only** so customers never see it.-- **Store Credits**: allow customers to pay using store credits issued by the admin, enabled by default-- **Offsite Payment**: labelled as "Check", not enabled by default+### Provider configuration-### Third-Party Payment Methods+Third-party providers need credentials before they will work. The fields differ by provider, and they appear in the panel as soon as you choose one.-Additional payment gateways (e.g., Stripe) can be made available by having your developers install the relevant gems. For example, Stripe gateway is free to use, but requires adding the [<u>spree_stripe</u>](https://github.com/spree/spree_stripe) gem to your store's codebase before it becomes available in the admin interface.+-For more information about our native Stripe integration, see Integrations → Stripe Gateway.+Enter the keys from your provider's own dashboard. Stored credentials are not shown back to you afterwards, and each has a **Replace** button for rotating a key later.-Once a payment method has been installed, it appears in the Available Payment Methods list. From there, it can be added, configured, or removed as needed.+Built-in methods have no configuration section, because nothing is being processed elsewhere.-## Add a Payment Method+### Naming and visibility-To add a payment method, click Add on the corresponding row in the Available Payment Methods list. This will direct you to the payment method creation form for that method.+These settings decide how a method is displayed:-+- **Name** - What customers see at checkout, such as "Credit card" or "Pay by invoice".+- **Description** - The customer-facing description shown at checkout, useful for explaining what happens next on anything other than a card payment.+- **Visible on storefront** - On by default. When off, only staff see this option, which is what you want for methods used on back-office orders and manual entry.+- **Active** - On by default. Inactive methods are hidden from checkout entirely.-Depending on the payment method you’re adding, the sections displayed in the form may differ. The following example covers Stripe which has 2 distinct sections:+<Note>**Visible on storefront** and **Active** do different jobs. Turning off **Visible on storefront** keeps a method available to your team; turning off **Active** withdraws it from everyone.</Note>-### Payment Provider Settings+### When to charge customers-+This decides the moment a customer's money actually moves. Every method inherits the store default unless you override it here.-Simply enter the required credentials into their respective fields.+| Option | What happens |+|---|---|+| **Use the store setting** | Follows the store default, with the inherited value named in brackets. |+| **At checkout** | Takes the money as soon as the order is placed. |+| **On dispatch** | Reserves the amount at checkout and takes it when the goods go out. |+| **Manually** | Reserves the amount at checkout and lets staff take it later. |-<Note>- This section only applies to third-party payment methods.-</Note>+Which one suits depends on how quickly you fulfil:-<Warning>- Different payment providers may require different credentials to be entered.-</Warning>+**At checkout** is the simplest and suits stores shipping in-stock goods promptly. The money is in before you pack, and reconciliation is straightforward because every order has a payment against it.-### Display Settings+**On dispatch** suits made-to-order goods, pre-orders and anything with a wait, where charging weeks before a customer receives anything invites complaints and refunds. The amount is reserved at checkout so you know the card is good, and taken when the parcel leaves.-+**Manually** suits orders that need a person to decide, such as a business order awaiting approval, a quote being finalised, or an order shipping in parts. Staff take the payment when they are ready.-Display settings can be configured for all payment methods whether default or third-party.+<Warning>Reserved amounts do not hold indefinitely. Card authorisations expire after a period set by the card network, so **On dispatch** and **Manually** need the order fulfilled or the payment taken within that window, or the reservation lapses and has to be retaken.</Warning>-There are four fields to configure:+Click **Create payment method** when you are done.-- **Name**: The name displayed on the storefront-- **Display**: Where the method is available for use- - On both the admin panel & storefront- - Only on storefront- - Only on admin panel-- **Auto Capture**: Determines whether payment is captured automatically at the time of authorization. Use the app default or override it per method.-- **Status**: Toggle whether the payment method is available for use in orders. Inactive methods are hidden but not deleted.+## How to Edit a Payment Method-### Create+Open the row menu and choose **Edit** to update the name, description, visibility, status or credentials. The edit panel shows the provider in its subtitle rather than as a dropdown.-Once you’ve entered all the required fields, click Create to add the payment method.+The provider cannot be changed once a method exists. If you need a different provider, create a new method and disable the old one.-The method will now be listed in your store’s enabled payment methods and will be available to users on checkout (provided it is active and visible).+<Warning>Test a new payment method with a real checkout before making it visible to customers. A method with wrong credentials still appears at checkout and fails when a customer tries to use it.</Warning>-## Edit a Payment Method+## How to Delete a Payment Method-To edit a payment method, click on the corresponding row in the enabled payment methods list. This will direct you to the edit form for that method.+Open the row menu and choose **Delete**. Spree confirms that the method will no longer be available at checkout.-+<Note>Disabling a method is usually better than deleting it. Turning **Active** off withdraws it from checkout while keeping it attached to the orders that used it.</Note>-Feel free to update any of the display settings for the payment method, but be very cautious when editing payment provider settings.+## Further Reading-<Warning>- Swapping payment provider accounts on an active store can disrupt payment processing and lead to failed transactions or reporting inconsistencies. Ensure all pending payments are settled and test the new account thoroughly in a staging environment before applying changes in production.-</Warning>--## Delete a Payment Method--To remove a payment method, simply open the edit form as shown above and click Delete.--<Warning>- Once a payment method is associated with an order, it cannot be deleted.-</Warning>--<Note>- Deleting a payment method moves it from the enabled payment methods list back into the available payments list. It does not uninstall the associated gem. A developer would need to remove it from the codebase if complete deactivation is desired.-</Note>+- [<u>Store Details</u>](/user/settings/store-details) - The store-wide default for when customers are charged+- [<u>Processing Orders</u>](/user/orders/processing-orders) - Taking a payment that was reserved rather than captured+- [<u>Issue Store Credits</u>](/user/loyalty/store-credits) - Adding credit that the Store Credit method can spenddiff --git a/docs/user/settings/policies.mdx b/docs/user/settings/policies.mdxindex a4aeb79562..37ea8e6d06 100644--- a/docs/user/settings/policies.mdx+++ b/docs/user/settings/policies.mdx@@ -1,58 +1,65 @@---title: "Policies"-description: "Learn how to set up and manage store policies in Spree Commerce."+description: "Learn how to write and publish your store's terms, privacy, returns and shipping policies in Spree Commerce."----Your store policies are an essential part of your eCommerce setup, helping you establish trust, maintain compliance, and communicate clearly with your customers. Spree allows you to easily manage these pages from the Policies tab.+Your policies are the legal documents customers can read: your terms, your privacy notice, and how returns and shipping work. They matter for trust and for compliance, and in most places you are required to publish at least some of them.-You can create as many custom policy pages as you need, with full control over their content and URL structure.+Every new store starts with four, already created and ready to write:-The following four standard policies are added to every store by default:+- **Terms of Service**+- **Privacy Policy**+- **Returns Policy**+- **Shipping Policy**-- Terms of Service-- Privacy Policy-- Returns Policy-- Shipping Policy+To manage them, navigate to **Settings → Policies**, under the **Store** group.-These can be customized, deleted, or supplemented with additional policies depending on your business needs.+<Note>Each policy has an address of its own, which Spree's Next.js storefront publishes as a page automatically. A custom or headless storefront reads policies through the API, so where they appear is up to whoever built it.</Note>-## Create a New Policy+<Warning>The four built-in policies start empty. Writing them is a launch task rather than an optional one, because a customer following a link to a policy you have not written finds nothing there.</Warning>-To create a new policy, navigate to **Settings → Policies** in your Spree dashboard.+## Reviewing Your Policies-+-Click **New Policy** in the top-right corner to open the policy creation form.+Each row shows:-+- **Name** - What the policy is called, with its address beneath it.+- **Content** - A preview of the document. A policy you have not written yet reads **Nothing written yet**.+- **Updated at** - When it was last changed.-Simply enter data into the following fields:+Use the search box to find a policy by name. The **Content** column is the quickest way to see at a glance which policies are still outstanding.-- **Name** - displayed title on the storefront.-- **Slug** - URL identifier (e.g. /policies/custom-warranty).-- **Content** - enter your policy text using the rich text editor (supports formatting, links, media, etc.).+## How to Write a Policy-Then, click **Create** to save and publish your new policy.+Click a policy's row to open it. The panel is titled with the policy's name.-Once published, the policy will be accessible from the storefront and can also be linked in your footer navigation or other relevant areas.+-+- **Name** - The title shown at the top of the document.+- **Slug** - The address for this policy, such as `returns-policy`. Leave it blank and it follows the name.+- **Content** - The document itself.-## Edit an Existing Policy+The editor has a formatting toolbar covering **Bold**, **Italic**, **Strikethrough**, bullet and numbered lists, blockquotes, links, images, and undo and redo. Use headings and lists rather than long unbroken paragraphs, because these are documents people scan for one specific answer rather than read end to end.-To edit an existing policy, navigate to **Settings → Policies** and follow these steps:+Click **Save**. The policy is published immediately.-1. Click on the policy you’d like to update.-2. Modify the name, slug, or content as needed.-3. Click **Update** to save your changes.+<Note>Changing the **Slug** changes a published policy's address, so any link you have shared pointing at the old one stops working. Set it once and leave it.</Note>-Your edits will be reflected immediately on the live storefront.+## How to Add a Policy-## Delete a Policy+Click **Add policy** for a document the four built-in ones do not cover, such as a warranty, an accessibility statement or a cookie notice.-To delete an existing policy, navigate to **Settings → Policies** and follow these steps:+Fill in the **Name**, leave **Slug** blank unless the address needs to differ, write the **Content**, and click **Create policy**.-1. Click on the policy you’d like to delete.-2. Click **Delete** at the bottom of the page and confirm.+## How to Delete a Policy-<Warning>Deleted policies are permanently removed and will no longer be accessible to customers.</Warning>+Open the row menu and choose **Delete**.++<Warning>Deleting a policy removes it permanently and its address stops working. Clearing a policy's content is not a way to take it down: the text goes, but the address still resolves and customers reach an empty page.</Warning>++## Further Reading++- [<u>Returns & Reasons</u>](/user/settings/returns-and-reasons) - The reasons behind the returns your policy describes+- [<u>Emails</u>](/user/settings/emails) - Where your support address is set+- [<u>Store Details</u>](/user/settings/store-details) - Your store's name and regional defaultsdiff --git a/docs/user/settings/sales-channels.mdx b/docs/user/settings/sales-channels.mdxindex ad815b7468..d5d97128cc 100644--- a/docs/user/settings/sales-channels.mdx+++ b/docs/user/settings/sales-channels.mdx@@ -3,25 +3,21 @@ title: "Sales Channels"description: "Create and manage sales channels in Spree to run multiple storefronts, B2B portals, POS, and mobile apps with per-channel catalogs and order attribution."----import { Since } from '/snippets/since.mdx';--<Since version="5.5" />--Sales channels let you run multiple distinct storefronts or selling contexts from a single Spree instance — each with its own product catalog, order attribution, and routing behaviour. A channel might represent a public-facing online store, a wholesale portal, a mobile app, a point-of-sale terminal, or a seasonal microsite.+Sales channels let you run multiple distinct storefronts or selling contexts from a single Spree instance, each with its own product catalog, order attribution, and routing behaviour. A channel might represent a public-facing online store, a wholesale portal, a mobile app, a point-of-sale terminal, or a seasonal microsite.When an order comes in through a given channel, Spree tags it automatically so you can filter, report, and route fulfilment by channel. Products can be assigned to one or more channels, giving you precise control over what each audience sees.Common use cases include:-- **Online store + POS** — keep retail and in-person orders separate for reporting and fulfilment-- **B2C + B2B wholesale portal** — show different catalogues and pricing to different audiences from one backend-- **Marketplace or affiliate channel** — attribute orders to the source channel for commission tracking-- **Mobile app** — route mobile orders separately and track conversion independently-- **Seasonal microsite** — run a limited-time catalogue without affecting your main storefront+- **Online store + POS** - keep retail and in-person orders separate for reporting and fulfilment+- **B2C + B2B wholesale portal** - show different catalogues and pricing to different audiences from one backend+- **Marketplace or affiliate channel** - attribute orders to the source channel for commission tracking+- **Mobile app** - route mobile orders separately and track conversion independently+- **Seasonal microsite** - run a limited-time catalogue without affecting your main storefront<Note>Developers connect a storefront or integration to a specific channel by passing the `X-Spree-Channel` header with the channel's code in API requests. See the [Spree API docs](https://spreecommerce.org/docs/api-reference/storefront) for details.</Note>-To manage sales channels, navigate to **Settings → Sales Channels** in the admin dashboard.+To manage sales channels, navigate to **Settings → Sales channels**, under the **Store** group.## Sales Channels Overview@@ -29,43 +25,64 @@ To manage sales channels, navigate to **Settings → Sales Channels** in the admThe Sales Channels table displays all configured channels with the following details:-- **Name** — the internal label for the channel (e.g., "Online Store", "Wholesale Portal")-- **Code** — the unique identifier used in API requests to attribute orders to this channel-- **Default** — indicates which channel is used when no channel is specified in a request-- **Active** — whether the channel is currently enabled+- **Name** - the internal label for the channel (e.g., "Online Store", "Wholesale Portal")+- **Code** - the unique identifier used in API requests to attribute orders to this channel+- **Default** - indicates which channel is used when no channel is specified in a request+- **Active** - whether the channel is currently enabled++Open the row menu on any channel to **Edit** or **Delete** it. The default channel offers **Edit** only, because every store needs one.## Create a Sales Channel-To create a new channel, click **New Sales Channel** in the top-right corner.+To create a new channel, click **New sales channel** in the top-right corner. A panel slides in from the right.Fill in the following fields:-- **Name** — an internal label to identify this channel (e.g., "iOS App", "EU Wholesale")-- **Code** — a short, unique identifier used in API requests (e.g., `ios-app`, `eu-wholesale`). This cannot be changed after creation.-- **Active** — uncheck to disable this channel without deleting it-- **Default** — check to make this the fallback channel for orders placed without a channel header-- **Order Routing Strategy** — controls how orders placed through this channel are allocated to stock locations for fulfilment. Select from:- - **Inherit from store** — uses the same routing strategy as the default channel- - **Rules (ordered)** — sets up a rules-based strategy; the specific rules can be configured via code- - **Legacy** — uses the original Spree fulfilment flow+- **Name** - an internal label to identify this channel (e.g., "iOS App", "EU Wholesale")+- **Code** - the stable identifier API clients pass in the `X-Spree-Channel` header, and what orders are attributed to. Leave it blank to derive one from the name. Lowercase letters, numbers, hyphens and underscores only.+- **Active** - turn off to stop this channel accepting orders without deleting it. An inactive channel is also no longer matched by the `X-Spree-Channel` header.+- **Default channel** - exactly one channel per store is the default. It is the fallback when no channel is selected, and the channel new products are automatically published to.+- **Order routing strategy** - how orders on this channel are allocated to stock locations. See below.+- **Storefront access** - what anonymous visitors can see on this channel:+ - **Inherit from store** - follows the store-wide setting. Leave it here unless this channel differs.+ - **Public** - anyone can browse and see prices.+ - **Prices hidden** - visitors must sign in to see prices, and guests must sign in to check out.+ - **Login required** - visitors must sign in to browse at all.+- **Guest checkout** - whether shoppers can check out without an account here. **Inherit from store**, **Allowed**, or **Not allowed**.+- **Default catalog** - what shoppers outside any company or customer group catalog see on this channel. Leave it blank to show every product published to the channel, or pick a catalog to restrict the range.+- **Locations** - which warehouses and pickup counters fulfil orders placed on this channel. Choose **All locations**, or select specific ones.-Once you've filled in the details, click **Create** to save the new channel.+Once you've filled in the details, click **Create sales channel**.++<Note>**Storefront access** and **Guest checkout** both default to inheriting the store setting, so a channel only needs them set when it should behave differently from the rest of the store. See [<u>Store Details</u>](/user/settings/store-details) for the store-wide values they inherit.</Note>### Order Routing StrategyOrder routing determines which stock location fulfils an order when you have multiple warehouses or fulfilment points. When an order is placed, Spree evaluates the assigned strategy for that channel to decide where to source each shipment from.--Channels that serve different regions or customer types often benefit from dedicated routing rules — for example, routing wholesale orders to a separate warehouse, or ensuring a specific fulfilment centre handles all orders from a particular storefront.--When using the **Rules (ordered)** strategy, the following rules can be configured and arranged in priority order:--1. **Preferred location** — always attempts to fulfil from a specific, designated stock location first, regardless of stock levels at other locations-2. **Minimize stock locations** — tries to fulfil the entire order from as few stock locations as possible, reducing split shipments and simplifying fulfilment-3. **Default location** — falls back to a designated stock location when no other rule has been satisfied-<Note>Rule rankings within the Rules (ordered) strategy can be adjusted by a developer per channel. See the [<u>developer documentation</u>](https://spreecommerce.org/docs/developer/core-concepts/channels) for details.</Note>+Channels that serve different regions or customer types often benefit from dedicated routing rules. You might route wholesale orders to a separate warehouse, or have one fulfilment centre handle every order from a particular storefront.++Three strategies are available:++- **Inherit from store** - uses the store-level routing strategy. This is the default and suits most channels.+- **Rules (ordered)** - evaluates a list of rules you arrange yourself, covered below.+- **Legacy** - uses the original Spree fulfilment flow.++### Order Routing Rules++The rules themselves appear once the channel exists, so create the channel first and then reopen it to arrange them.++++Rules are evaluated top to bottom. The first rule that singles out a stock location wins, and a tie carries to the next rule down. Drag them into the order you want:++1. **Preferred location** - always attempts to fulfil from a specific, designated stock location first, regardless of stock levels at other locations+2. **Minimize stock locations** - tries to fulfil the entire order from as few stock locations as possible, reducing split shipments and simplifying fulfilment+3. **Default location** - falls back to a designated stock location when no other rule has been satisfied++<Note>The rules only take effect when the channel's **Order routing strategy** is set to **Rules (ordered)**. On any other strategy the list is ignored.</Note>## Products and Sales Channels@@ -73,26 +90,32 @@ When a product is created, it is automatically assigned to the default channel oTo manage which channels a product is available on, open the product in the editor and locate the **Publishing** card.-+Click **Manage** to add or remove the channels this product is assigned to.---Once a channel is assigned, you can click on it in the Publishing card to configure its scheduling settings — including the start and end dates for when the product should be active on that channel.+Once a channel is assigned, you can click on it in the Publishing card to configure its scheduling settings, including the start and end dates for when the product should be active on that channel.A product's availability per channel follows its publishing status:-- **Live** — visible and purchasable on that channel-- **Scheduled** — will become active automatically at the configured start date-- **Not available** — assigned to the channel but hidden from customers+- **Live** - visible and purchasable on that channel+- **Scheduled** - will become active automatically at the configured start date+- **Not available** - assigned to the channel but hidden from customers-This allows you to curate entirely different catalogues for different audiences — for example, showing a reduced range on a wholesale channel while keeping the full catalogue on the main storefront.+This allows you to curate entirely different catalogues for different audiences. You might show a reduced range on a wholesale channel while keeping the full catalogue on the main storefront.<Note>If creating products via the Admin API, the product will have no channels assigned unless a channel is explicitly set in the request.</Note>+### Assigning channels in bulk++Doing this product by product is fine for a handful, but to assign a whole range of products at once, use the bulk action on the products list instead.++Go to **Products**, tick the products you want, and the bulk action bar will be revealed at the top of the table. Use **Add to sales channels** to list them on a channel, or **Remove from sales channels**, under **More actions**, to unlist them.++<Note>Selection is per page, so a range spread over several pages requires repeating the bulk action on each page in turn.</Note>+## Orders and Sales ChannelsEvery order placed through a channel is automatically attributed to it, making it easy to track volume and manage fulfilment per channel without any manual tagging.@@ -101,9 +124,7 @@ In the **Orders** list, a **Channel** column shows which channel each order came-Opening an individual order shows the channel attribution in the order summary panel at the bottom of the page.--+Opening an individual order shows which channel it came from in the order summary panel at the foot of the page.## Relateddiff --git a/docs/user/settings/store-details.mdx b/docs/user/settings/store-details.mdxindex ec3af61149..d46cad0f20 100644--- a/docs/user/settings/store-details.mdx+++ b/docs/user/settings/store-details.mdx@@ -1,66 +1,147 @@---title: "Store Details"-description: "Learn how to configure your store's core settings in Spree Commerce."+description: "Learn how to configure your store's name, formats, checkout access, order numbering, stock handling and catalog defaults in Spree Commerce."----The Store Details section is where you define your store's identity and core operational-preferences — from its name and logo to timezones, units of measurement, and how digital-downloads are handled.+Store settings are the store-wide defaults that everything else falls back on. They decide how your store reads to customers, how orders are numbered, when money is taken, whether stock is counted, and what shoppers can see before signing in.-To configure these settings, navigate to **Settings → Store Details** in the admin dashboard.+Most of these are set once during setup and rarely touched again. The exceptions are worth knowing, because a few of them change how every future order behaves.-## Name & Logo+To configure these settings, navigate to **Settings → Store**, under the **Store** group.-+-- **Name** — the public-facing name of your store, displayed in headers, footers, and other- storefront areas.-- **Logo** — upload a store logo (recommended size: 240x240 px). This image is used only in- the admin dashboard.+<Note>The page is one long scroll divided into titled sections, with a single **Save** button at the top. It stays greyed out until you change something, and it saves the whole page rather than one section.</Note>-## Currencies & Countries+## General-<Note>Currency, locale, and regional settings are now managed in **Settings → Markets**. See [<u>Markets</u>](https://spreecommerce.org/docs/user/settings/markets) for full details.</Note>+The name your business trades under. It is the one setting on this page that customers see everywhere, so it is worth getting right before you open.-## Standards & Formats+- **Store name** - What your store is called. This appears in the dashboard, in emails and on the storefront.-+## Standards and Formats-Here you can set the timezone, unit system, and weight units to match your region and business-preferences:+How the store reads and measures. These affect what your team sees in the dashboard and the units products are described in, so set them to match how your business already works rather than where your customers are.-- **Timezone** — set your store's timezone for accurate timestamps and order data.-- **Unit system** — choose between imperial and metric. This affects how weights and measures- are displayed across your storefront:- - Imperial system- - Metric system-- **Weight unit** — choose the default unit for product weights:- - Pound (lb) — imperial system- - Ounce (oz) — imperial system- - Kilogram (kg) — metric system- - Gram (g) — metric system+- **Admin language** - The language your team sees in the dashboard. This does not change the storefront.+- **Timezone** - The timezone dates and times are shown in across the dashboard.+- **Unit system** - **Metric** or **Imperial**, used for product dimensions.+- **Weight unit** - **Kilogram (kg)** or **Gram (g)** for Metric, or **Pound (lb)** or **Ounce (oz)** for Imperial.-## Phone & Address+## Storefront Access-+Who can see your store before signing in, and whether they can buy without an account. This is the difference between an open retail shop and a trade store where prices are only shown to approved customers.-Enter your store's contact details here:+-- **Phone** — your store's contact phone number.-- **Address** — your business address.+- **Storefront access** - The store-wide default for anonymous visitors:+ - **Public** - Anyone can browse and see prices.+ - **Prices hidden** - Visitors must sign in to see prices. Guests must sign in to check out.+ - **Login required** - Visitors must sign in to browse at all.+- **Guest checkout** - Whether shoppers can check out without creating an account.-## Digital Assets+<Note>Both settings are defaults that a sales channel can override. If you change one here and a storefront does not behave as expected, check that channel's own settings rather than changing this again.</Note>-+The two restricted options do different things, and the difference matters:-Here you can control how digital products (e.g., downloads) are handled after purchase:+- **Prices hidden** is how most wholesale and trade stores work. A visitor can browse the range and see what you sell, but not what it costs, until you have approved their account.+- **Login required** goes further and closes the catalogue as well. A visitor sees nothing at all until they sign in, so choose it only when the range itself is confidential.-- **Limit digital links download days** — set how long download links remain active after- purchase (in days).-- **Limit digital links download count** — restrict the number of times a download link can- be used per purchase.+## Addresses++What customers are asked for when entering an address. Every extra field is one more thing between a shopper and a completed order, so only ask for what you will actually use.++- **Company field** - Show a company field on address forms during checkout. Worth turning on if you sell to businesses.+- **Require phone number** - Make a phone number mandatory on customer addresses. Some carriers need one for delivery.++## Order Numbers++How orders and other numbered documents are referenced. These are the numbers your team quotes on the phone and customers quote back in emails, so readability matters more than you might think.++++- **Numbering format**:+ - **Sequential** - Counts up from a starting number. Easier to read back over the phone, and easier to sort.+ - **Random** - Unpredictable digits, so your numbers do not reveal how many orders your store has taken.+- **Prefix** and **Suffix** - Text wrapped around the number, such as an `R` prefix.+- **Start numbering at** - The number to begin counting from.+- **Preview** - Shows what the next number will look like as you change the settings above.++<Warning>**Start numbering at** only works before your first order. Once any order exists the field is permanently disabled, because numbers already issued never change. Set it during setup or not at all.</Warning>++These settings apply to future orders only.++## Payments++When money moves, and which address decides the tax. The charging setting has the widest reach of anything on this page, because it applies to every payment method unless one overrides it.++++- **When to charge customers** - The default for every payment method:+ - **At checkout** - Take the money as soon as the order is placed.+ - **On dispatch** - Reserve the amount at checkout and take it when the goods go out.+ - **Manually** - Reserve the amount at checkout and let staff take it later.+- **Tax by shipping address** - Calculate tax from the customer's shipping address. Turn this off to tax by the billing address instead.++<Note>An individual payment method can override **When to charge customers**. See [<u>Payment Methods</u>](/user/settings/payments) for when that is worth doing.</Note>++## Inventory++How stock is counted and reserved. These settings decide whether Spree keeps track of quantities at all, whether a unit is held while someone checks out, and when your team is warned that something is running low.++++- **Track stock levels** - Count on-hand quantities. Turn this off to treat every product as always available, which suits made-to-order goods or services.+- **Hold stock during checkout** - Reserve items while a shopper checks out, so the same unit cannot be sold twice.+- **Low stock threshold** - A tracked variant with this many units or fewer counts as low stock on the home screen. Set it to 0 to turn the warning off.++<Warning>Turning off **Track stock levels** stops Spree counting stock for every product in the store. If only some products are always available, leave tracking on and set those products as backorderable instead.</Warning>++## Pricing Source++Where prices are answered from. Most stores price from their own catalog and never change this, but a business running an ERP or a contract-pricing system can have that system answer instead.++- **Prices come from** - **Spree (built in)** prices from your catalog and price lists. An external system can answer instead.++This is for stores running an ERP or contract-pricing system that already holds the authoritative prices. Setting it up is developer work, and the section links to the documentation for building a provider.++## Inventory Source++Where stock levels are answered from. As with pricing, this exists for stores whose warehouse or ERP system is the authority on stock rather than Spree.++- **Stock levels come from** - **Spree (built in)** uses your own stock records. An external system can answer instead.++An external source is asked when an item is added to a cart and again at checkout. Product listings always show your own stock records, so a shopper browsing sees Spree's figures either way.++## Catalog++Three switches covering how products behave across the store. Each one is small on its own, but the price history switch has a legal dimension worth reading before you skip past it.++++- **Show products without a price** - List products that have no price in the shopper's currency. Leave it off to hide anything unpriced rather than showing a product nobody can buy.+- **Record price history** - Keep past prices so the storefront can show the lowest price of the last 30 days.+- **Allow duplicate SKUs** - Let more than one variant share the same SKU.++<Note>**Record price history** exists for EU price indication rules, which require a discount to be shown against the lowest price of the previous 30 days. Turn it on before you start discounting, because it only keeps prices from the moment it is enabled.</Note>++## Digital Downloads++Defaults for how long a download link works and how often it can be used. These apply to every digital product you sell, and an individual file can override them where something needs tighter or looser limits.++++- **Limit number of downloads** - Off means buyers can download as often as they like.+- **Downloads allowed** - How many downloads each buyer gets.+- **Limit download period** - Off means download links never expire.+- **Days available** - How many days a link stays valid.## Saving Changes-After making any updates, click **Update** at the bottom of the page to save your store-settings, otherwise any changes you've made will not be saved.+Click **Save** at the top of the page. The button is greyed out until something has changed, and it saves every section at once, so you can work down the page and save once at the end.++## Further Reading++- [<u>Payment Methods</u>](/user/settings/payments) - Overriding when customers are charged, per method+- [<u>Sales Channels</u>](/user/settings/sales-channels) - Overriding storefront access and guest checkout per channel+- [<u>Inventory</u>](/user/inventory/stock-levels) - The stock figures the tracking settings produce