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
Added user docs for translations and multi-currency imports (#13896)
jaburghes37e764163358
diff --git a/docs/docs.json b/docs/docs.jsonindex 7f17a2fbba..88e950ed6e 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -637,7 +637,9 @@"user/manage-products/price-lists","user/manage-products/export-products","user/manage-products/import-products",+ "user/manage-products/multi-currency-import-export","user/manage-products/product-import-file-template",+ "user/manage-products/translations","user/manage-products/stock-levels","user/manage-products/stock-transfers","user/manage-products/product-taxonomies",diff --git a/docs/images/user/products/export-products/3.download_link.png b/docs/images/user/products/export-products/3.download_link.pngdeleted file mode 100644index 25a618fd45..0000000000Binary files a/docs/images/user/products/export-products/3.download_link.png and /dev/null differdiff --git a/docs/images/user/products/multi-currency-import-export/1-export-modal.png b/docs/images/user/products/multi-currency-import-export/1-export-modal.pngnew file mode 100644index 0000000000..84488eecfeBinary files /dev/null and b/docs/images/user/products/multi-currency-import-export/1-export-modal.png differdiff --git a/docs/images/user/products/multi-currency-import-export/2-import-panel.png b/docs/images/user/products/multi-currency-import-export/2-import-panel.pngnew file mode 100644index 0000000000..9acc495ecfBinary files /dev/null and b/docs/images/user/products/multi-currency-import-export/2-import-panel.png differdiff --git a/docs/images/user/products/translations/1-translations-overview.png b/docs/images/user/products/translations/1-translations-overview.pngnew file mode 100644index 0000000000..f6ab4e9a56Binary files /dev/null and b/docs/images/user/products/translations/1-translations-overview.png differdiff --git a/docs/images/user/products/translations/2-coverage-table.png b/docs/images/user/products/translations/2-coverage-table.pngnew file mode 100644index 0000000000..496a9b646dBinary files /dev/null and b/docs/images/user/products/translations/2-coverage-table.png differdiff --git a/docs/images/user/products/translations/3-product-grid.png b/docs/images/user/products/translations/3-product-grid.pngnew file mode 100644index 0000000000..af5030a406Binary files /dev/null and b/docs/images/user/products/translations/3-product-grid.png differdiff --git a/docs/images/user/products/translations/4-translation-drawer.png b/docs/images/user/products/translations/4-translation-drawer.pngnew file mode 100644index 0000000000..1bab50bc2dBinary files /dev/null and b/docs/images/user/products/translations/4-translation-drawer.png differdiff --git a/docs/images/user/products/translations/5-export-modal.png b/docs/images/user/products/translations/5-export-modal.pngnew file mode 100644index 0000000000..ae20036d57Binary files /dev/null and b/docs/images/user/products/translations/5-export-modal.png differdiff --git a/docs/images/user/products/translations/6-import-panel.png b/docs/images/user/products/translations/6-import-panel.pngnew file mode 100644index 0000000000..70ca7d2846Binary files /dev/null and b/docs/images/user/products/translations/6-import-panel.png differdiff --git a/docs/user/manage-products/export-products.mdx b/docs/user/manage-products/export-products.mdxindex 2b05241e94..e4ca2b9c61 100644--- a/docs/user/manage-products/export-products.mdx+++ b/docs/user/manage-products/export-products.mdx@@ -26,4 +26,4 @@ This opens a export modal that gives you two options to choose from:Once you’ve made your selection, click **Export** in the modal, and a link to download the file will be sent to the email address associated with your user account.-\ No newline at end of file+<Note>If your store sells in multiple currencies, the exported file will automatically include additional price-only rows for each currency. See [<u>Multi-Currency Import/Export</u>](https://spreecommerce.org/docs/user/manage-products/multi-currency-import-export) for details on how these rows work.</Note>diff --git a/docs/user/manage-products/import-products.mdx b/docs/user/manage-products/import-products.mdxindex 8dd2b245f6..f0a582250f 100644--- a/docs/user/manage-products/import-products.mdx+++ b/docs/user/manage-products/import-products.mdx@@ -81,3 +81,6 @@ To do so:<Warning>When updating products in bulk, make sure to keep the slug exactly the same for each existing product. The slug is the unique identifier used during import - changing it will cause Spree to treat the row as a new product and create a duplicate record.</Warning>This is the safest and most efficient way to make large-scale updates to product data such as pricing, descriptions, inventory, or metafields.++<Note>If your store sells in multiple currencies, your exported file will include additional price-only rows for each currency. See [<u>Multi-Currency Import/Export</u>](https://spreecommerce.org/docs/user/manage-products/multi-currency-import-export) for details on how these rows work.</Note>+diff --git a/docs/user/manage-products/multi-currency-import-export.mdx b/docs/user/manage-products/multi-currency-import-export.mdxnew file mode 100644index 0000000000..2c36635389--- /dev/null+++ b/docs/user/manage-products/multi-currency-import-export.mdx@@ -0,0 +1,67 @@+---+title: "Multi-Currency Import/Export"+description: "Learn how to import and export product prices across multiple currencies in Spree Commerce."+---++If your store is configured to sell in more than one currency, Spree's product import/export automatically handles pricing for each currency in a single file. This makes it straightforward to review, update, or set prices across all your markets without needing separate exports for each currency.++<Note>Multi-currency import/export relies on your Markets configuration. Each currency in the export corresponds to a market you've set up in your store. See [<u>Settings → Markets</u>](https://spreecommerce.org/docs/user/settings/markets) for more details.</Note>++## How It Works++When you export your product catalog, Spree generates one row per product variant for your default currency — exactly as it always has. For each additional currency your store supports, Spree adds an extra row for each variant containing only the pricing information for that currency.++These additional rows are called **price-only rows**. They contain a smaller set of columns:++- **SKU** - Identifies which variant the price belongs to+- **Slug** - Identifies which product the variant belongs to+- **Price** - The price in the specified currency+- **Compare At Price** - The original/crossed-out price, if applicable+- **Currency** - The currency code for this row (e.g., `EUR`, `GBP`)++All other product fields (name, description, taxons, metafields, etc.) are left blank in price-only rows — they're intentionally omitted because those fields are already handled by the primary row.++## Exporting Multi-Currency Prices++The export process is the same as a standard product export. Navigate to the **Products** tab and click **Export** in the top-right corner.++++Choose to export **Filtered Records** or **All**, then click **Export**. A download link will be sent to your admin email address.++When you open the file, you'll see your standard product rows followed by price-only rows for each additional currency. For example, a store selling in USD (default) and EUR would look something like this:++| SKU | Slug | Name | Price | Currency | ... |+|---|---|---|---|---|---|+| SHIRT-SM | blue-shirt | Blue Shirt | 29.99 | USD | ... |+| SHIRT-MD | blue-shirt | Blue Shirt | 34.99 | USD | ... |+| SHIRT-SM | blue-shirt | | 27.99 | EUR | |+| SHIRT-MD | blue-shirt | | 31.99 | EUR | |++The blank fields in the EUR rows are expected — only the pricing columns matter for those rows.++## Importing Multi-Currency Prices++You can update prices across currencies by editing the exported file and re-importing it through the standard product importer.++<Warning>When editing price-only rows, do not change the SKU or slug values. These are used to match each row to the correct product variant — changing them will prevent the import from updating the right records.</Warning>++To import your updated file, navigate to the **Products** tab and click **Import** in the top-right corner. This opens the import side panel.++++1. Drag and drop your CSV file into the upload area, or click **browse files** to select it from your computer.+2. Select the correct delimiter used in your file (comma, pipe, semicolon, or tab).+3. Click **Create** to proceed to the field mapping step.+4. Review the field mapping and adjust any columns that weren't matched automatically, then click **Continue** to submit.++Spree will automatically detect which rows are full product rows and which are price-only rows. For price-only rows, it will update only the pricing data for the specified currency — it won't overwrite your product descriptions, taxons, or metafields.++<Note>You can import pricing updates for a single currency without including rows for other currencies. Just remove any rows you don't want to update before importing.</Note>++## Next Steps++- [<u>Import Products</u>](https://spreecommerce.org/docs/user/manage-products/import-products) — Full guide to importing product data+- [<u>Export Products</u>](https://spreecommerce.org/docs/user/manage-products/export-products) — Full guide to exporting your product catalog+- [<u>Settings → Markets</u>](https://spreecommerce.org/docs/user/settings/markets) — Configure markets and currencies for your store+- [<u>Price Lists</u>](https://spreecommerce.org/docs/user/manage-products/price-lists) — Set customer- or volume-specific pricing on top of your base pricesdiff --git a/docs/user/manage-products/translations.mdx b/docs/user/manage-products/translations.mdxnew file mode 100644index 0000000000..595ffab647--- /dev/null+++ b/docs/user/manage-products/translations.mdx@@ -0,0 +1,68 @@+---+title: "Translations"+description: "Learn how to manage and track product translations across all your store's locales in Spree Commerce."+---++The Translations page gives you a single place to see how well your product catalog is translated across every language your store supports. Rather than hunting through individual product pages, you can see at a glance which products have been translated and which still need attention — and use bulk import/export to handle translations in volume.++To access Translations, navigate to **Products → Translations** in the admin dashboard.++++<Note>The languages shown on this page are determined by your Markets configuration. If you don't see any locales listed, you'll need to set up additional markets first. See [<u>Settings → Markets</u>](https://spreecommerce.org/docs/user/settings/markets) for more details.</Note>++## Translation Coverage++At the top of the page, you'll see a coverage summary table with one row per locale your store supports (excluding your default language). Each row shows:++- **Locale** - The language code (e.g., `fr`, `de`, `es`)+- **Translated** - How many products have a translation for that locale+- **Total** - The total number of products in your catalog+- **Coverage** - The percentage translated, shown as both a number and a visual progress bar++This gives you a quick health check on your localization progress without needing to export any data.++++## Product Translation Status++Below the coverage table, you'll see a paginated list of all your products. Each product has a column for every configured locale, showing either a checkmark (✓) if a translation exists or a dash (—) if it's missing.++++To edit a product's translations, click on the product name. This will open the translation drawer where you can add or update translated content for that product.++++## Bulk Export Translations++If you prefer to manage translations in a spreadsheet, you can export your entire translation dataset as a CSV file.++Click **Export** in the top-right corner of the page.++++Click **Export** to confirm, and a download link will be sent to the email address associated with your admin account.++## Bulk Import Translations++Once you've updated your translations in the exported file (or built a new file from scratch), you can import them back in bulk.++Click **Import** in the top-right corner of the page. This opens the import side panel.++++1. Drag and drop your CSV file into the upload area, or click **browse files** to select it from your computer.+2. Select the correct delimiter used in your file (comma, pipe, semicolon, or tab).+3. Click **Create** to proceed to the field mapping step.+4. Review the field mapping and adjust any columns that weren't matched automatically, then click **Continue** to submit.++Once submitted, you'll be redirected to a processing screen where you can monitor the import progress. Any rows with errors will be flagged with a message so you can fix and re-import them.++<Note>The translation import uses the same importer infrastructure as the product importer. If you're familiar with importing products, the process will feel very similar.</Note>++## Next Steps++- [<u>Settings → Markets</u>](https://spreecommerce.org/docs/user/settings/markets) — Configure which languages and locales your store supports+- [<u>Import Products</u>](https://spreecommerce.org/docs/user/manage-products/import-products) — Learn how to bulk import product data+- [<u>Export Products</u>](https://spreecommerce.org/docs/user/manage-products/export-products) — Learn how to export your product catalog