You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 14/umbraco-commerce/getting-started/introduction.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description: Getting Started with Umbraco Commerce.
6
6
7
7
In this section, you will find information about the key steps necessary to get you started with Umbraco Commerce.
8
8
9
-
It is assumed that you have an Umbraco 12+ website configured, ready to install Umbraco Commerce into.
9
+
It is assumed that you have an Umbraco 14+ website configured, ready to install Umbraco Commerce into.
10
10
11
11
{% hint style="info" %}
12
12
Find detailed instructions on how to install the latest version of Umbraco in the [Umbraco CMS documentation](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/install).
@@ -16,7 +16,7 @@ Find detailed instructions on how to install the latest version of Umbraco in th
16
16
17
17
The minimum requirements for using Umbraco Commerce are as follows:
18
18
19
-
* Umbraco CMS version 12+
19
+
* Umbraco CMS version 14+
20
20
* SQL Server 2015+ Database
21
21
***SQLite** is fine for testing, but not recommended for live deployments. See [Configuring SQLite support](../how-to-guides/configure-sqlite-support.md) for more details.
Copy file name to clipboardExpand all lines: 14/umbraco-commerce/getting-started/user-interface.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,31 +16,34 @@ The **Settings** section is where the configuration of all Store settings is man
16
16
17
17
The UI for the **Settings** section consists of a Tree which lists all available Stores and their key areas available for configuration. It also contains a right-hand editor panel. This can either act as an editor interface or as a list view interface for listing items within that given configuration area.
21
+
22
22
23
-
Each Store has 8 key areas of configuration accessible within the **Settings** section:
23
+
Each Store has a number of key areas of configuration accessible within the **Settings** section:
24
24
25
25
***Store**: Each Store node contain Store level configuration settings.
26
+
***Locations** contain the configuration of the different locations of the store.
26
27
***Order Statuses** contain the configuration of the different Statuses an order can be in. Think of these as an organizational structure for your Orders.
27
28
***Shipping Methods** contains the list of Shipping Methods available to a Store.
28
29
***Payment Methods** contains the list of Payment Methods available to a Store.
29
30
***Countries** contain the list of Countries the Store is able to trade with.
30
31
***Currencies** contain the list of accepted Currencies for the Store.
31
32
***Taxes** contains the list of Tax Classes and their Tax Rates for the Store.
32
33
***Email Templates** contains the list of Email Templates supported by the Store.
34
+
***Print Templates** contains the list of Print Templates supported by the Store.
35
+
***Export Templates** contains the list of Export Templates supported by the Store.
33
36
34
37
## Commerce Section
35
38
36
39
The **Commerce** section contains a Tree to access the Stores and their different features, as well as a right-hand panel for managing the items.
43
+
41
44
42
45
## Content Section
43
46
44
47
The **Content** section is where the Umbraco Commerce product nodes are managed. Managing products with Umbraco Commerce is similar to working with regular content nodes.
45
48
46
-
49
+
Copy file name to clipboardExpand all lines: 14/umbraco-commerce/installation/install.md
+70-1Lines changed: 70 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,76 @@ Alternatively, you can also find and install the NuGet package via the NuGet Pac
25
25
26
26
For most sites using a single solution, the above will be all you need to install Umbraco Commerce into your project. When you have a more complex solution structure consisting of multiple projects, Umbraco Commerce is available in multiple sub-packages with varying dependencies.
27
27
28
-
<table><thead><tr><th width="282">Sub-package</th><th>Description</th></tr></thead><tbody><tr><td><strong>Umbraco.Commerce.Common</strong></td><td>A shared project of common, non-Commerce-specific patterns and helpers.</td></tr><tr><td><strong>Umbraco.Commerce.Core</strong></td><td>Core Commerce functionality that doesn't require any infrastructure-specific dependencies.</td></tr><tr><td><strong>Umbraco.Commerce.Infrastructure</strong></td><td>Infrastructure-specific project containing implementations of core Commerce functionality.</td></tr><tr><td><strong>Umbraco.Commerce.Persistence.SqlServer</strong></td><td>Persistence-specific project containing implementations of core Commerce persistence functionality for SQL Server.</td></tr><tr><td><strong>Umbraco.Commerce.Persistence.Sqllite</strong></td><td>Persistence-specific project containing implementations of core Commerce persistence functionality for SQLite.</td></tr><tr><td><strong>Umbraco.Commerce.Web</strong></td><td>Core Commerce functionality that requires a web context.</td></tr><tr><td><strong>Umbraco.Commerce.Cms</strong></td><td>Core Commerce functionality that requires an Umbraco dependency.</td></tr><tr><td><strong>Umbraco.Commerce.Cms.Web</strong></td><td>The Commerce functionality for the Umbraco presentation layer.</td></tr><tr><td><strong>Umbraco.Commerce.Cms.Web.UI</strong></td><td>The static Commerce assets for the Umbraco presentation layer.</td></tr><tr><td><strong>Umbraco.Commerce.Cms.Startup</strong></td><td>The Commerce functionality for registering Commerce with Umbraco.</td></tr><tr><td><strong>Umbraco.Commerce</strong></td><td>The main Commerce package entry point package.</td></tr></tbody></table>
28
+
<table>
29
+
<thead>
30
+
<tr>
31
+
<th width="282">Sub-package</th>
32
+
<th>Description</th>
33
+
</tr>
34
+
</thead>
35
+
<tbody>
36
+
<tr>
37
+
<td><strong>Umbraco.Commerce.Common</strong></td>
38
+
<td>A shared project of common, non-Commerce-specific patterns and helpers.</td>
39
+
</tr>
40
+
<tr>
41
+
<td><strong>Umbraco.Commerce.Core</strong></td>
42
+
<td>Core Commerce functionality that doesn't require any infrastructure-specific dependencies.</td>
Copy file name to clipboardExpand all lines: 14/umbraco-commerce/key-concepts/base-currency.md
+2-30Lines changed: 2 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,34 +10,6 @@ When you configure a store you need to assign a base currency to it. This curren
10
10
11
11
When a store has a base currency configured, any order placed will track the price of the order in the customer's chosen currency. It will also track the current exchange rate between that currency and the store's base currency. Whenever a report is run the order total prices will be converted using this exchange rate. This means that they can all be automatically presented in the single base currency of the store.
12
12
13
-
## Currency Exchange Rates
13
+
## Currency Exchange Rate Services
14
14
15
-
Umbraco Commerce uses an `ICurrencyExchangeRateService` to retrieve the most up-to-date rate to be able to track the current exchange rate. This is done for each individual order.
16
-
17
-
Out of the box, Umbraco Commerce comes with a number of available services you can choose to use. Some are free services, whilst others require a paid subscription.
18
-
19
-
***ExchangeRatesApiCurrencyExchangeRateService** uses the free [exchangeratesapi.io](https://exchangeratesapi.io/) API and is the default option.
20
-
***FixerCurrencyExchangeRateService** uses the [fixer.io](https://fixer.io/) API which is a reliable paid option (with a reasonable free plan).
21
-
***CurrencyLayerCurrencyExchangeRateService** uses the [currencylayer.com](https://currencylayer.com/) API which is another reliable paid option (with a reasonable free plan).
22
-
23
-
If you wish to change the currency exchange rate service used, you can do so via the [dependency injection](dependency-injection.md) approach. This is used to override the default service configuration. For services that require configuration to be passed in, such as service API keys, you'll need to use the factory-based override as follows:
Umbraco Commerce has a background service that will attempt to ensure that all historic orders without an exchange rate defined get updated. This is done in case the third-party APIs fail and we need a method of cleaning data. It is also done in case the store base currency is ever changed. In this case, we need to re-process all orders again with the newly selected base currency.
42
-
43
-
The currency exchange rate background task will run once every 24 hours or after 20 seconds after an app pool recycle.
15
+
Umbraco Commerce uses an `ICurrencyExchangeRateService` to retrieve the most up-to-date rate and track the current exchange rate. For more details on configuring an exchange rate service, see the [Currency Exchange Rate Service Providers](./currency-exchange-rate-service-providers.md) article.
description: Currency Exchange Rate Service Provider for currency conversion in Umbraco Commerce.
3
+
---
4
+
5
+
Umbraco Commerce can track the current exchange rate of orders compared to the stores [Base Currency](./base-currency.md). This is necessary to produce reports and analytics in a single currency.
6
+
7
+
8
+
## Currency Exchange Rate Services
9
+
10
+
Umbraco Commerce uses an `ICurrencyExchangeRateService` to retrieve the most up-to-date rate and track the current exchange rate. This is done for each order.
11
+
12
+
13
+
Out of the box, Umbraco Commerce comes with a number of available services you can choose to use. Some are free services, while others require a paid subscription.
14
+
15
+
16
+
***ExchangeRateHostCurrencyExchangeRateService** uses the free [exchangerate.host](https://exchangerate.host/) API.
17
+
***ExchangeRatesApiCurrencyExchangeRateService** uses the free [exchangeratesapi.io](https://exchangeratesapi.io/) API.
18
+
***FixerCurrencyExchangeRateService** uses the [fixer.io](https://fixer.io/) API which is a reliable paid option (with a reasonable free plan).
19
+
***CurrencyLayerCurrencyExchangeRateService** uses the [currencylayer.com](https://currencylayer.com/) API which is another reliable paid option (with a reasonable free plan).
20
+
21
+
If you are using multiple currencies in your store then you should sign up for and configure an exchange rate service to ensure accurate reporting. You can do so via the [dependency injection](dependency-injection.md) approach. This is used to override the default service configuration. For services that require configuration to be passed in, such as service API keys, you'll need to use the factory-based override as follows:
If you have multiple currencies enabled but have not configured an exchange rate service, Umbraco Commerce will display a warning. This alert appears on the store dashboard and analytics section, indicating that the reported data may be inaccurate.
38
+
39
+
40
+
41
+
## Historic Orders
42
+
43
+
Umbraco Commerce has a background service that will attempt to ensure that all historic orders without an exchange rate defined get updated. This is done in case the third-party APIs fail and we need a method of cleaning data. It is also done in case the store base currency is ever changed. In this case, we need to re-process all orders again with the newly selected base currency.
44
+
45
+
The currency exchange rate background task will run once every 24 hours or after 20 seconds after an app pool recycle.
0 commit comments