Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Documentation edits made through Mintlify web editor

mintlify[bot]1687f93b041a
diff --git a/docs/user/manage-products/export-products.mdx b/docs/user/manage-products/export-products.mdx
index bc1311e9ae..aabed40141 100644
--- a/docs/user/manage-products/export-products.mdx
+++ b/docs/user/manage-products/export-products.mdx
@@ -25,6 +25,6 @@ Once you’re happy with your selection, click the blue Export button, and a lin
<img alt="Product Export into CSV Complete" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734430408/docs/Manage%20Products/Export%20Products/2.2.4.3_Product_Export_-_Export_Complete_kpl7f5.png" />
-### Update Products in Bulk
+## Update Products in Bulk
If you’re planning to update product data in bulk, simply open the exported file in your preferred spreadsheet software, edit all of product fields you’d like to change, and then reupload the file to update the product data in Spree.
\ No newline at end of file
diff --git a/docs/user/manage-products/import-products.mdx b/docs/user/manage-products/import-products.mdx
index 13c45b4c28..ddaa685893 100644
--- a/docs/user/manage-products/import-products.mdx
+++ b/docs/user/manage-products/import-products.mdx
@@ -25,7 +25,7 @@ You’ll be greeted by two options:
First, lets take a look at uploading a file
-### Upload File
+## Upload File
When clicking on ‘Upload file’, you’ll be prompted to select a file from your device.
@@ -35,7 +35,7 @@ Select the file you want to upload and click Open.
This will automatically extract the product data from the file.
-#### Map Fields
+### Map Fields
Next, you’ll be directed to the field mapping step, which allows you to match the incoming fields from the CSV with the internal fields in your store.
@@ -53,7 +53,7 @@ In the ‘Destination Fields’ column, you can select the internal field that t
Once you’re happy with the mapping of the fields, click ‘Continue’ in the top right corner of the window.
-#### Review and Submit
+### Review and Submit
On the next screen, can review the data to be uploaded and submit it for upload provided there are no errors.
@@ -71,7 +71,7 @@ Once you’ve fixed all the errors and updated any other fields you want to chan
<img alt="Submit Product Import Data" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733926795/docs/Manage%20Products/Import%20Products/2.2.3.1.9_Product_Imports_-_Submit_Data_s9n9fh.png" />
-#### Import Processing
+### Import Processing
Once you’ve submitted the data, you’ll be redirected to another page where you can watch the monitor the progress of the import process.
@@ -85,7 +85,7 @@ The products will now manageable in the Products tab of the admin dashboard.
<img alt="Products Uploaded" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733926800/docs/Manage%20Products/Import%20Products/2.2.3.1.12_Product_Imports_-_Products_Uploaded_b5ucnj.png" />
-### Manually Enter Data
+## Manually Enter Data
If you don’t have an existing file to upload, you can manually enter the product data directly into the product importer, which you may find more convenient than adding products one by one using the product editor.
@@ -95,7 +95,7 @@ Simply fill in all of the necessary fields following the Product File Format gui
Once you’ve added all the relevant product data, click ‘Submit data’ in the top right corner of the window and the products will be imported.
-### Import Auditing
+## Import Auditing
You can audit past imports by navigating to Settings > Audit Trail and clicking on ‘Imports’ at the top of the page.
diff --git a/docs/user/manage-products/product-taxonomies.mdx b/docs/user/manage-products/product-taxonomies.mdx
index 9fc277a8f3..827699569c 100644
--- a/docs/user/manage-products/product-taxonomies.mdx
+++ b/docs/user/manage-products/product-taxonomies.mdx
@@ -21,7 +21,7 @@ Here you will see three automatically created taxonomies that are commonly used
* Collections - Curated groups of products based on themes or trends
-### Add a New Taxonomy
+## Add a New Taxonomy
To add a new Taxonomy, such as a Category, Collection, or Brand, click on the blue button in the top right corner.
@@ -35,7 +35,7 @@ You’ll then be redirected to a page that allows you to manage the new taxonomy
<img alt="Create Taxonomy" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530075/docs/Manage%20Products/Product%20Taxonomies/2.4.3_Taxonomies_-_Create_Taxonomy_jldjm8.png" />
-### Add Taxons
+## Add Taxons
With the taxonomy created, you can start adding taxons to organize your product catalog more effectively.
@@ -45,7 +45,7 @@ To add a taxon, either click the blue ‘+ New Taxon’ button in the top right
This opens up the taxon editor page which allows you to define the taxon and add media.
-#### Presentation
+### Presentation
There are four sections that affect how the taxon is presented on the storefront:
@@ -57,17 +57,17 @@ There are four sections that affect how the taxon is presented on the storefront
* Square Image - Upload a complimentary square image to optionally be displayed in page sections featuring that taxon
-#### Taxon Type
+### Taxon Type
Taxon Type allows you to choose between a manual taxon or an automatic taxon.
<img alt="Taxon Type" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530068/docs/Manage%20Products/Product%20Taxonomies/2.4.5_Taxonomies_-_Taxon_Type_rqqr3h.png" />
-##### Manual Taxons
+#### Manual Taxons
As the name suggests, you must add products manually, either by assigning products to the taxon in bulk, curating them one by one, or by adding the appropriate values to the category column when importing a product file.
-##### Automatic Taxons
+#### Automatic Taxons
Allows you to automatically (and dynamically) populate the taxon based on various conditions.
@@ -91,7 +91,7 @@ Once you’ve selected the condition type, you can select the value from the dro
Feel free to add more conditions to further curate the taxon by clicking onn ‘+ Add One’.
-#### Navigation
+### Navigation
Here you can select where the new taxon should be nested.
@@ -103,19 +103,19 @@ Start typing the name of the taxon you’d like to nest within to filter the res
<img alt="Navigation Filtering" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530070/docs/Manage%20Products/Product%20Taxonomies/2.4.9_Taxonomies_-_Navigation_Filtering_xznfix.png" />
-#### Search Engine Listing
+### Search Engine Listing
Here you can set the meta title, meta description, and the slug for the new taxon.
<img alt="Search Engine Listing" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530069/docs/Manage%20Products/Product%20Taxonomies/2.4.10_Taxonomies_-_Search_Engine_Listing_kouuok.png" />
-#### Create Taxon
+### Create Taxon
Once you’ve added the name and defined the taxon type, click the blue ‘Create’ button at the bottom of the page to create the taxon, and you’ll receive a notification that the taxon was successfully created.
-<img alt="" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530078/docs/Manage%20Products/Product%20Taxonomies/2.4.11_Taxonomies_-_Taxon_Created_nlmenj.png" />
+<img classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530078/docs/Manage%20Products/Product%20Taxonomies/2.4.11_Taxonomies_-_Taxon_Created_nlmenj.png" />
-#### Add Products
+### Add Products
Once the taxon is created, you can add products to the taxon directly in taxon editor page by clicking ‘+ Add Products’, if and only if you chose the manual Taxon Type.
@@ -133,7 +133,7 @@ Note: You can removed individual products by clicking on the red trash can butto
<img alt="Products Added" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530074/docs/Manage%20Products/Product%20Taxonomies/2.4.14_Taxonomies_-_Products_Added_neudzx.png" />
-#### Sort Order
+### Sort Order
For merchandising purposes, you may want to change the order in which products in a taxon are presented in the storefront.
@@ -147,7 +147,7 @@ If you choose manual sort order, you can rearrange the ordering by clicking on t
Important: Make sure to hit ‘Update’ at the bottom of the page if you want to save any changes you’ve made to taxon.
-### Build A Taxonomy Tree
+## Build A Taxonomy Tree
If you’d like to create multiple levels of the taxonomy tree, you can add add subtaxons (i.e. nested taxons) to an existing taxon.
@@ -165,7 +165,7 @@ If you’d like to reorganize your taxonomy later, you can do so by drag and dro
<img alt="Reordering Taxons: Catgories or Collections or Brands" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530076/docs/Manage%20Products/Product%20Taxonomies/2.4.19_Taxonomies_-_Reordering_Taxons_ljppr7.png" />
-### Import Taxons
+## Import Taxons
Taxons can be automatically imported if you add the appropriate values to the category columns in a product import file. Just make sure to use the correct naming convention for the taxons to make sure nesting is respected after import, e.g.:
@@ -179,7 +179,7 @@ Taxons can be automatically imported if you add the appropriate values to the ca
To learn more about imports, please refer to the [Import Products](https://spreecommerce.org/docs/user/manage-products/import-products) article.
-### Editing Taxonomies
+## Editing Taxonomies
If you’d like to change the name of a taxonomy, navigate back to the main Taxonomies tab.
@@ -187,21 +187,21 @@ If you’d like to change the name of a taxonomy, navigate back to the main Taxo
Find the taxonomy you’d like to rename, and click the Edit button the far right side.
-<img alt="" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530078/docs/Manage%20Products/Product%20Taxonomies/2.4.21_Taxonomies_-_Rename_Taxonomy_chetzs.png" />
+<img classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530078/docs/Manage%20Products/Product%20Taxonomies/2.4.21_Taxonomies_-_Rename_Taxonomy_chetzs.png" />
Simply rename the taxonomy and click ‘Update’.
-### Editing Taxons
+## Editing Taxons
To edit a taxon, find the taxon you’d like to edit in its respective taxonomy, and click the Edit button on the far right.
-<img alt="" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530080/docs/Manage%20Products/Product%20Taxonomies/2.4.22_Taxonomies_-_Edit_Taxons_dkly9r.png" />
+<img classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1734530080/docs/Manage%20Products/Product%20Taxonomies/2.4.22_Taxonomies_-_Edit_Taxons_dkly9r.png" />
You’re free to edit the name and description, swap out images, change the nesting, and update search engine listing settings. Make sure to click Update if you do.
Important: You cannot edit the Taxon Type of a taxon once created. If you want to change a taxon from manual to automatic (or vice versa), delete the old taxon and create another.
-### Translations
+## Translations
If you’re store is multi-language, you can add translations for both taxonomies and taxons.