| Migrate from Vendr to Umbraco Commerce | migrate-from-vendr-to-umbraco-commerce |
| Configure SQLite support | configure-sqlite-support.md |
| Limit Order Line Quantity | limit-orderline-quantity.md |
| Use an alternative database for Umbraco Commerce tables | use-an-alternative-database-for-umbraco-commerce-tables.md |
| Sub-package | Description |
|---|---|
| Umbraco.Commerce.Common | A shared project of common, non-Commerce-specific patterns and helpers. |
| Umbraco.Commerce.Core | Core Commerce functionality that doesn't require any infrastructure-specific dependencies. |
| Umbraco.Commerce.Infrastructure | Infrastructure-specific project containing implementations of core Commerce functionality. |
| Umbraco.Commerce.Persistence.SqlServer | Persistence-specific project containing implementations of core Commerce persistence functionality for SQL Server. |
| Umbraco.Commerce.Persistence.Sqllite | Persistence-specific project containing implementations of core Commerce persistence functionality for SQLite. |
| Umbraco.Commerce.Web | Core Commerce functionality that requires a web context. |
| Umbraco.Commerce.Cms | Core Commerce functionality that requires an Umbraco dependency. |
| Umbraco.Commerce.Cms.Web | The Commerce functionality for the Umbraco presentation layer. |
| Umbraco.Commerce.Cms.Web.UI | The static Commerce assets for the Umbraco presentation layer. |
| Umbraco.Commerce.Cms.Startup | The Commerce functionality for registering Commerce with Umbraco. |
| Umbraco.Commerce | The main Commerce package entry point package. |
| Umbraco Properties | Umbraco Commerce is based on Umbraco CMS, which means that some of the things you'll be working with are native to the core product. | umbraco-properties.md |
| Calculators | Learn more about the different calculators that Umbraco Commerce ships with and how you can customize and extend them. | calculators.md |
| Product Variants | With Umbraco Commerce you can create a large array of different product variants. Learn more about how this all works. | product-variants |
Variants editor table view
Product attributes
Product attributes values
Product attribute presets
Product attribute preset values
Create variants presets
Create variants attributes
Edit variant
Variant filtering
| Alias | +Type | +Description | +
|---|---|---|
store |
+ Umbraco.Commerce.StorePicker | ++ Often placed on the site root node, but can be placed on any node higher + than the product nodes themselves, this property links the website to a + specific Umbraco Commerce store configuration. + | +
productName |
+ Textstring | +
+ Optional product node property that allows you to define an explicit
+ product name other than the product nodes .Name property,
+ which will be used as fallback.
+ |
+
sku |
+ Textstring | +
+ Product node property defining the unique SKU of the
+ product.
+ |
+
price |
+ Umbraco.Commerce.Price | +Product node property defining the prices for the product. | +
stock |
+ Umbraco.Commerce.Stock | +Product node property defining the stock level of the product. | +
image |
+ Umbraco.MediaPicker3 | +Optional product node property defining an image for the given product. | +
measurements |
+ Umbraco.Commerce.Measurements | +Optional (depending on the shipping configuration) node property defining physical dimensions and weight of the product. | +
taxClass |
+ Umbraco.Commerce.StoreEntityPicker | +
+ Optional product node property that allows you to define an explicit
+ Tax Class for the product, should it differ from the stores
+ default.
+ |
+
isGiftCard |
+ True/False | ++ Optional product node property that defined whether the product node + should be considered a Gift Card product, in which case it triggers the + automatic generation of a Gift Card in the backoffice and emails it + directly to the customer on checkout. + | +
productSource |
+ ContentPicker | ++ Optional product node property allowing you to link a product to another + product outside of it's hierarchy to be used as it's source of product + information. + | +
+
+
+
+Session
+ +When working with Umbraco Commerce's C# Api, Umbraco Commerce will normally keep track of a series of items for you. This could be the current Order ID or the current Language, which it tracks in a cookie. When working in a headless manner however we can no longer rely on cookies for this behavior. It becomes the implementor's responsibility to remember these items and pass them as Headers to the endpoints that need to use them for context. + +The following is a list of supported headers used for session management: + +* `Store` - The ID or Alias of the store the given operation is being performed against. +* `Current-Order` - The ID of any current "in-progress" order. +* `Customer-Reference` - A unique reference for the current customer. +* `Accept-Language` - The ISO Culture Code of the current front-end language. +* `Currency` - The ID or ISO Code of the current currency. If not supplied, will fall back to the default currency of the default country defined on the store. +* `Tax-Class` - The ID or Alias of the default tax class. If not supplied, will fall back to the default defined on the store. +* `Billing-Country` - The ID or ISO Code of the default billing country. If not supplied, falls back to the default country defined on the store. +* `Billing-Region` - The ID or ISO Code of the default billing region. +* `Shipping-Country` - The ID or ISO Code of the default shipping country. If not supplied, falls back to either the supplied billing country or the default country defined on the store. +* `Shipping-Region` - The ID or ISO Code of the default billing region. + +
+
+
+
+Expansion
+ +**Expansion** allows you to retrive additional data about related entities in the API output for a given resource. + +By default, where a resource is connected with another resource, such as an Order holding a reference to it's Currency, the Storefront API will return those connected resources as "Reference" objects which usually only contain the resources ID and Alias/Code. + +```json +{ + "cartNumber": "CART-01280-054677-RP4L9", + "createDate": "2023-07-03T15:11:17.9220005", + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "customerInfo": { ... }, + "discountCodes": [], + ... +} +``` + +Should you wish to retrieve the connected resource, you could perform an additional get operation against that resources own endpoint, however this could result in multiple wasteful network requests. To help with this, you can pass an `expand` query parameter with a path to properties you wish to expand, which for those targeted properties will return the full resource object instead of the reference entity. + +**Request** + +```http +GET /umbraco/commerce/storefront/api/v1/order/af697207-d370-4aee-824c-15711d43a9f2?expand=currency +``` + +**Response** + +```json +{ + "cartNumber": "CART-01280-054677-RP4L9", + "createDate": "2023-07-03T15:11:17.9220005", + "currency": { + "$type": "Currency", + "allowedCountries": [ + { + "country": { + "$type": "CountryRef", + "code": "GB", + "id": "af697207-d370-4aee-824c-15711d43a9f2" + } + } + ], + "code": "GBP", + "culture": "en-GB", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a", + "name": "GBP" + }, + "customerInfo": { ... }, + "discountCodes": [], + ... +} +``` + +The `expand` query parameter can accept a comma seperated list of property keys to expand for properties at the same level, and can also expand nested objects using a `[...]` syntax. In the following example we retrieve a Country entity, expanding it's `defaultCurrency` and `defaultPaymentMethod` whilst at the same time expanding the `allowedCountries.country` properties within the `defaultCurrency`. + +```http +GET /umbraco/commerce/storefront/api/v1.0/country/GB?expand=defaultCurrency[allowedCountries[country]],defaultPaymentMethod +``` + +**Response** + +```json +{ + "code": "GB", + "defaultCurrency": { + "$type": "Currency", + "allowedCountries": [ + { + "country": { + "$type": "Country", + "code": "GB", + "defaultCurrency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "defaultPaymentMethod": { + "$type": "PaymentMethodRef", + "alias": "invoicing", + "id": "e35677ac-a544-45a0-ba4a-a78dd43dbaf2" + }, + "defaultShippingMethod": { + "$type": "ShippingMethodRef", + "alias": "pickup", + "id": "2ecb73ed-1b13-4ca4-8502-c1c4a8df533d" + }, + "id": "af697207-d370-4aee-824c-15711d43a9f2", + "name": "United Kingdom" + } + } + ], + "code": "GBP", + "culture": "en-GB", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a", + "name": "GBP" + }, + "defaultPaymentMethod": { + "$type": "PaymentMethod", + "alias": "invoicing", + "id": "e35677ac-a544-45a0-ba4a-a78dd43dbaf2", + "imageUrl": "https://localhost:44313/media/k4apjvbo/logo.png", + "name": "Invoicing", + "sku": "4815" + }, + "defaultShippingMethod": { + "$type": "ShippingMethodRef", + "alias": "pickup", + "id": "2ecb73ed-1b13-4ca4-8502-c1c4a8df533d" + }, + "id": "af697207-d370-4aee-824c-15711d43a9f2", + "name": "United Kingdom" +} +``` + +#### Shortcuts + +As well as expanding explicit properties, the Storefront API supports shortcut expansion keys that when passed will expand all entities of a given type. Shortcut keys are idenfitied by a `$` prefix. There is currently only one supported shortcut key which is `$prices`. + +**$prices** + +Prices in Umbraco Commerce can contain a lot of meta data, such as listing applied discounts/adjustments and all values including or excluding those discounts. These are useful when displaying a full order breakdown, but when only needing to present an orders total value, are not necesarry. By default, the Storefront API will only return the final `value` property of a price object, but should you wish to receive this full pricing breakdown you can pass the `$prices` shortcut key to expand all price values to include this extra meta data. + +**Request** + +```http +GET /umbraco/commerce/storefront/api/v1/order/af697207-d370-4aee-824c-15711d43a9f2?expand=$prices +``` + +**Response** + +```json +{ + ... + "totalPrice": { + "previousAdjustments": { + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "formatted": { + "tax": "-£0.45", + "withTax": "-£2.60", + "withoutTax": "-£2.15" + }, + "tax": -0.45, + "withTax": -2.60, + "withoutTax": -2.15 + }, + "totalAdjustment": { + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "formatted": { + "tax": "-£0.45", + "withTax": "-£2.60", + "withoutTax": "-£2.15" + }, + "tax": -0.45, + "withTax": -2.60, + "withoutTax": -2.15 + }, + "value": { + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "formatted": { + "tax": "£5.80", + "withTax": "£33.40", + "withoutTax": "£27.60" + }, + "tax": 5.80, + "withTax": 33.40, + "withoutTax": 27.60 + }, + "withPreviousAdjustments": { + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "formatted": { + "tax": "£5.80", + "withTax": "£33.40", + "withoutTax": "£27.60" + }, + "tax": 5.80, + "withTax": 33.40, + "withoutTax": 27.60 + } + }, + ... +} +``` + +
+
+
+
+## Endpoints
+
+The Storefront API is broken down into a number of endpoints grouped by resource type. Select a resource type below to review the available endpoints.
+
+{% content-ref url="endpoints/order.md" %}
+[order.md](endpoints/order.md)
+{% endcontent-ref %}
+
+{% content-ref url="endpoints/checkout.md" %}
+[checkout.md](endpoints/checkout.md)
+{% endcontent-ref %}
+
+{% content-ref url="endpoints/product.md" %}
+[product.md](endpoints/product.md)
+{% endcontent-ref %}
+
+{% content-ref url="endpoints/customer.md" %}
+[customer.md](endpoints/customer.md)
+{% endcontent-ref %}
+
+{% content-ref url="endpoints/store.md" %}
+[store.md](endpoints/store.md)
+{% endcontent-ref %}
+
+{% content-ref url="endpoints/currency.md" %}
+[currency.md](endpoints/currency.md)
+{% endcontent-ref %}
+
+{% content-ref url="endpoints/country.md" %}
+[country.md](endpoints/country.md)
+{% endcontent-ref %}
+
+{% content-ref url="endpoints/payment-method.md" %}
+[payment-method.md](endpoints/payment-method.md)
+{% endcontent-ref %}
+
+{% content-ref url="endpoints/shipping-method.md" %}
+[shipping-method.md](endpoints/shipping-method.md)
+{% endcontent-ref %}
+
+{% content-ref url="endpoints/content.md" %}
+[content.md](endpoints/content.md)
+{% endcontent-ref %}
+
+## Swagger UI
+
+You can access a Swagger document for the Storefront API at `{yourdomain}/umbraco/swagger`, selecting `Umbraco Commerce Storefront API` from the definitions dropdown in the top right. From here you can see a full list of supported APIs, the parameters they accept and the expected payloads and responses.
+
+
+
+## Value Converters
+
+As Umbraco Commerce uses content nodes as products, the Storefront API comes with some replacement value converters that automatically extend the default value converter functionality to return Storefront entities when accessed through the Content Delivery API. You don't need to do anything to enable these.
+
+* **Store Picker** - Returns a Store "Reference" by default, or a complete Store response object if the store picker property is being expanded.
+* **Store Entity Picker** - Returns an entity "Reference" by default, or a complete entity response object if the store entity picker property is being expanded.
+* **Price** - Returns a price for the product based on session information passed through in headers. See the ["Session" concept detailed above](./#concepts).
+* **Stock** - Returns the stock level of the given product.
+* **Variants** - See notes on the [variants value converter](./#variants-value-converter) below.
+
+### Variants Value Converter
+
+To help with common scenarios when working with variants, the Variants value converter will return a series of data items used when building a relevant UI.
+
+```json
+{
+ attributes: [
+ {
+ alias: "color",
+ name: "Color",
+ values: [
+ {
+ alias: "red",
+ name: "Red"
+ },
+ {
+ alias: "blue",
+ name: "Blue"
+ }
+ ]
+ },
+ {
+ alias: "size",
+ name: "Size",
+ values: [
+ {
+ alias: "md",
+ name: "Medium"
+ },
+ {
+ alias: "lg",
+ name: "Large"
+ }
+ ]
+ }
+ ],
+ items: [
+ {
+ attributes: {
+ color: red,
+ size: md
+ },
+ isDefault: true,
+ content: { }
+ },
+ {
+ attributes: {
+ color: blue,
+ size: lg
+ },
+ isDefault: false,
+ content: { }
+ }
+ ],
+ variantContentUrl: "https://{your_domain}/umbraco/delivery/api/v1/content/item/8df5c8bd-b524-4513-805a-c119fc8090e3/variant"
+}
+```
+
+* `attributes` will contain a list of "in use" attributes which means there is at least one variant content item that makes use of that attribute. These should be used to build the attribute options UI.
+* `items` returns a list of variant items. By default, this will return the attribute combinations, and whether it is the default combination but its content value will be empty. The content value can be populated by expanding the variants property through the Delivery API, however, it's important to know this could return a lot of data and be intensive. Instead, it is preferred to return the non-expanded value and use the `variantContentUrl` to fetch individual content items as they are requested. The `items` collection should also be used to check if a combination exists as whilst the root level `attributes` collection contains all in-use attributes, it doesn't mean every possible combination of those attributes exists so you can use the `items` collection to validate a combination.
+* `variantContentUrl` as the URL to a specialized Delivery API route that can return a single variant item content based on a passed-in attribute combination.
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/README.md b/14/umbraco-commerce/reference/storefront-api/endpoints/README.md
new file mode 100644
index 00000000000..97a1a9a3114
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/README.md
@@ -0,0 +1,43 @@
+# Storefront API Endpoints
+
+The Storefront API is broken down into a number endpoints of grouped by resource type. Select a resource type below to review the available endpoints.
+
+{% content-ref url="order.md" %}
+[Order](order.md)
+{% endcontent-ref %}
+
+{% content-ref url="checkout.md" %}
+[Checkout](checkout.md)
+{% endcontent-ref %}
+
+{% content-ref url="product.md" %}
+[Product](product.md)
+{% endcontent-ref %}
+
+{% content-ref url="customer.md" %}
+[Customer](customer.md)
+{% endcontent-ref %}
+
+{% content-ref url="store.md" %}
+[Store](store.md)
+{% endcontent-ref %}
+
+{% content-ref url="currency.md" %}
+[Currency](currency.md)
+{% endcontent-ref %}
+
+{% content-ref url="country.md" %}
+[Country](country.md)
+{% endcontent-ref %}
+
+{% content-ref url="payment-method.md" %}
+[Payment Method](payment-method.md)
+{% endcontent-ref %}
+
+{% content-ref url="shipping-method.md" %}
+[Shipping Method](shipping-method.md)
+{% endcontent-ref %}
+
+{% content-ref url="content.md" %}
+[Content](content.md)
+{% endcontent-ref %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/checkout.md b/14/umbraco-commerce/reference/storefront-api/endpoints/checkout.md
new file mode 100644
index 00000000000..69320d69687
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/checkout.md
@@ -0,0 +1,27 @@
+# Checkout Endpoints
+
+The checkout endpoints provide ways of performing a checkout process against an Order. The Storefront API supports two ways of checking out an order, one using hosted checkout pages, and a more advanced option for inline payment processing.
+
+## Hosted
+
+With the hosted checkout flow it is required that before redirecting to the payment gateway a checkout token should be generated. This token is passed to the pay endpoint to ensure that only the given order can be processed in response to the checkout request. The pay endpoint should be launched in a WebView/iframe with this token which will redirect to the given Orders payment gateway for payment capture. To determine the outcome of the payment developers should monitor the WebView/iframes URL. They will be redirected to the same pay endpoint URL with either a `/completed`, `/canceled` or `/errored` suffix.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/checkout/{orderId}/token" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/checkout/{orderId}/pay/{token}" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+## Inline
+
+With the inline checkout flow, it is left to the implementing developer to perform payment capture. Before a capture can begin, the order should be initialized using the `initialize` endpoint which prepares the Order for capture. The `initialize` endpoint will return the settings of the Orders selected payment method, along with details of expected metadata needed by the payment provider. Developers can use this data to perform an inline capture and call the `confirm` endpoint when the capture is successful, passing back any metadata captured.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/checkout/{orderId}/initialize" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/checkout/{orderId}/confirm" method="post" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/content.md b/14/umbraco-commerce/reference/storefront-api/endpoints/content.md
new file mode 100644
index 00000000000..378f116863d
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/content.md
@@ -0,0 +1,7 @@
+# Content Endpoints
+
+The content endpoints provide additional endpoints to the Umbraco Content Delivery API to help with fetching product related content.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/delivery/api/v1/content/item/{id}/variant" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/country.md b/14/umbraco-commerce/reference/storefront-api/endpoints/country.md
new file mode 100644
index 00000000000..a808cd95bb7
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/country.md
@@ -0,0 +1,31 @@
+# Country Endpoints
+
+The Country API endpoints allow fetching supported countries and their allowed currencies, payment methods and shipping methods from a store.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/countries" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/country/{idOrAlias}" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/currencies" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/paymentmethods" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/country/{idOrAlias}/shippingmethods" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/country/{countryIdOrAlias}/region/{regionIdOrAlias}/paymentmethods" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/currency.md b/14/umbraco-commerce/reference/storefront-api/endpoints/currency.md
new file mode 100644
index 00000000000..81476377282
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/currency.md
@@ -0,0 +1,11 @@
+# Currency Endpoints
+
+The Currency API endpoints allow fetching supported currencies from a store.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/currencies" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/currency/{idOrAlias}" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/customer.md b/14/umbraco-commerce/reference/storefront-api/endpoints/customer.md
new file mode 100644
index 00000000000..f62eb46d2b9
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/customer.md
@@ -0,0 +1,7 @@
+# Customer Endpoints
+
+The Customer API endpoints allow fetching all orders associated with a customer.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/customer/{customerReferenceOrEmail}/orders" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/order.md b/14/umbraco-commerce/reference/storefront-api/endpoints/order.md
new file mode 100644
index 00000000000..0ede104e2c8
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/order.md
@@ -0,0 +1,59 @@
+# Order Endpoints
+
+The Order endpoints are where you will manage your carts/orders and perform cart management functionality. Some examples are adding items to the cart, or setting up billing and shipping details.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/orders" method="post" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}" method="patch" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}" method="delete" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}" method="post" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}/items" method="patch" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}/items" method="delete" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}/item/{orderLineId}" method="patch" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}/item/{orderLineId}" method="delete"%}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}/bundle/{bundleId}" method="post" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}/bundle/{bundleId}/items" method="patch" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}/bundle/{bundleId}/items" method="delete" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}/bundle/{bundleId}/item/{orderLineId}" method="patch" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/order/{orderId}/bundle/{bundleId}/item/{orderLineId}" method="delete" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/payment-method.md b/14/umbraco-commerce/reference/storefront-api/endpoints/payment-method.md
new file mode 100644
index 00000000000..3b35fff07c1
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/payment-method.md
@@ -0,0 +1,11 @@
+# Payment Method Endpoints
+
+The Payment Method API endpoints allow fetching supported payment methods from a store.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/paymentmethods" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/paymentmethod/{idOrAlias}" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/product.md b/14/umbraco-commerce/reference/storefront-api/endpoints/product.md
new file mode 100644
index 00000000000..4505b5edac3
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/product.md
@@ -0,0 +1,7 @@
+# Product Endpoints
+
+The Product API endpoints allow fetching essential product related data such as pricing and stock levels.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/products" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/shipping-method.md b/14/umbraco-commerce/reference/storefront-api/endpoints/shipping-method.md
new file mode 100644
index 00000000000..b5375e9cc39
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/shipping-method.md
@@ -0,0 +1,11 @@
+# Shipping Method Endpoints
+
+The Shipping Method API endpoints allow fetching supported shipping methods from a store.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/shippingmethods" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/shippingmethod/{idOrAlias}" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/storefront-api/endpoints/store.md b/14/umbraco-commerce/reference/storefront-api/endpoints/store.md
new file mode 100644
index 00000000000..a1c2aa879f3
--- /dev/null
+++ b/14/umbraco-commerce/reference/storefront-api/endpoints/store.md
@@ -0,0 +1,7 @@
+# Store Endpoints
+
+The Store API endpoints allow fetching supported store details.
+
+{% swagger src="../../../.gitbook/assets/storefront_swagger.json" path="/umbraco/commerce/storefront/api/v1/store/{idOrAlias}" method="get" %}
+[storefront_swagger.json](../../../.gitbook/assets/storefront_swagger.json)
+{% endswagger %}
\ No newline at end of file
diff --git a/14/umbraco-commerce/reference/stores/README.md b/14/umbraco-commerce/reference/stores/README.md
new file mode 100644
index 00000000000..50c8a0025eb
--- /dev/null
+++ b/14/umbraco-commerce/reference/stores/README.md
@@ -0,0 +1,197 @@
+---
+description: Information on Umbraco Commerce Stores
+---
+
+# Stores
+
+Stores represent a single shop / commercial entity and contain all the settings a configuration specific to that particular store. They are the root entity from which all other Umbraco Commerce entities are connected. They are also able to be linked to content nodes to connect a store to a site.
+
+## Store Settings
+
+General settings for a store can be accessed via the UI by clicking on a store node in the `Settings > Commerce` section.
+
+### General
+
+Fields
+ +A common pitfall of REST APIs is the problem of over-fetching, which is where an endpoint returns more information than you need. The Storefront API supports the passing of `fields` which allows you to define exactly which properties of an object you wish to return. This will reduce the payload size. + +For example, when implementing a cart count feature to show the total number of items in a shopping cart, rather than fetching an entire order for a single `totalQuantity` field, we can return only that field: + +**Request** + +```http +GET /umbraco/commerce/storefront/api/v1/order/af697207-d370-4aee-824c-15711d43a9f2 +``` + +**Response** + +```json +{ + "cartNumber": "CART-01280-054677-RP4L9", + "createDate": "2023-07-03T15:11:17.9220005", + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "finalizedDate": "2023-07-04T10:25:37.1471415", + "id": "832b2f79-915c-49dd-a20a-01891c4edd7c", + "isFinalized": true, + "languageIsoCode": "en-GB", + "orderLines": [ + { + "basePrice": { + "value": { + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "formatted": { + "tax": "£4.51", + "withTax": "£26.00", + "withoutTax": "£21.49" + }, + "tax": 4.51, + "withTax": 26.00, + "withoutTax": 21.49 + } + }, + "id": "e9ec1305-1844-4a72-a343-01891c4f09d8", + "name": "Good and Proper - Breakfast Tea Set", + "properties": { + "giftMessage": "Hey Tom, found this and thought you'd love it." + }, + "quantity": 1, + "sku": "GP002", + "taxRate": 0.21, + "totalPrice": { + "value": { + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "formatted": { + "tax": "£4.51", + "withTax": "£26.00", + "withoutTax": "£21.49" + }, + "tax": 4.51, + "withTax": 26.00, + "withoutTax": 21.49 + } + }, + "unitPrice": { + "value": { + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "formatted": { + "tax": "£4.51", + "withTax": "£26.00", + "withoutTax": "£21.49" + }, + "tax": 4.51, + "withTax": 26.00, + "withoutTax": 21.49 + } + } + } + ], + "orderStatus": { + "$type": "OrderStatusRef", + "alias": "new", + "id": "37cd2c8f-48d8-4416-bb37-b2c7d7bb992f" + }, + "subtotalPrice": { + "value": { + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "formatted": { + "tax": "£4.06", + "withTax": "£23.40", + "withoutTax": "£19.34" + }, + "tax": 4.06, + "withTax": 23.40, + "withoutTax": 19.34 + } + }, + "taxClass": { + "$type": "TaxClassRef", + "alias": "standard", + "id": "17a2eca0-d21f-462a-8915-8b2606661efd" + }, + "totalPrice": { + "value": { + "currency": { + "$type": "CurrencyRef", + "code": "GBP", + "id": "30b62176-6a9e-4a51-b2f0-7ce6c80a461a" + }, + "formatted": { + "tax": "£5.80", + "withTax": "£33.40", + "withoutTax": "£27.60" + }, + "tax": 5.80, + "withTax": 33.40, + "withoutTax": 27.60 + } + }, + "totalQuantity": 1, + "updateDate": "2023-07-06T14:20:26.1939545" +} +``` + +We can pass a `fields` query parameter to limit the response to only return that field we are interested in: + +**Request** + +```http +GET /umbraco/commerce/storefront/api/v1/order/af697207-d370-4aee-824c-15711d43a9f2?fields=totalQuantity +``` + +**Response** + +```json +{ + "id": "832b2f79-915c-49dd-a20a-01891c4edd7c", + "totalQuantity": 1 +} +``` + +When using the `fields` query parameter to limit fields returned, `id` properties will always be included. + +Inline with the expansion feature, the `fields` paramter can also retrieve multiple fields, and nested fields using comma seperate values and the `[...]` syntax. + +**Request** + +```http +GET /umbraco/commerce/storefront/api/v1/order/af697207-d370-4aee-824c-15711d43a9f2?fields=totalQuantity,orderLines[sku,quantity] +``` + +**Response** + +```json +{ + "id": "832b2f79-915c-49dd-a20a-01891c4edd7c", + "orderLines": [ + { + "id": "e9ec1305-1844-4a72-a343-01891c4f09d8", + "quantity": 1, + "sku": "GP002" + } + ], + "totalQuantity": 1 +} +``` + +| Name | +Description | +
|---|---|
| Base Currency | +Defines the base currency a store operates in and for which all order values will be converted for the basis of reporting and analytics. | + +
| Default Location | +Defines the main location of the store and is used by shipping calculators to work out shipping rates. | +
| Default Country | +Defines the default country of the store and is used to set the default payment/shipping country of newly created orders. | + +
| Default Order Status | +Defines the order status to assign newly created orders to. | +
| Error Order Status | +Defines the order status to assign orders to when an error occurs during order processing. | + +
| Measurement System | +Defines whether to use a Metric or Imperial measurement system when capturing product measurement. | + +
| Prices Include Tax | +Defines whether all prices entered into the system are inclusive or exclusive of tax. | +
| Use Cookies | +Defines whether cookies should be used for tracking a customers current order, allowing them to last between browser sessions. | +
| Cookie Timeout | +If using cookies, defines the length of time in minutes the cookie should be persisted for. | +
| Name | +Description | +
|---|---|
| Confirmation Email | +Defines the email to send to customers when an order is successfully completed. | +
| Error Email | +Defines the email to send to customers when an error occurs completing their order. | +
| Name | +Description | +
|---|---|
| Cart Number Template | +Defines a string formatting template to use when generating a Cart Number, eg: 'CART-{0}'. | +
| Order Number Template | +Defines a string formatting template to use when generating an Order Number, eg: 'ORDER-{0}'. | +
| Order Rounding Method | +Defines At what level in the order calculation process prices should be rounded. Can be either `Unit` where prices are rounded at the item level, `Line` where prices are rounded at the order line level after quantity multiplication or `Total` where prices are rounded at the order total level. | +
| Name | +Description | +
|---|---|
| Product Property Aliases | +Defines a comma-separated list of property aliases to be copied to the order line when added to the cart. See the [Properties concept documentation](../../key-concepts/properties.md#automatic-properties) for more details. | +
| Product Uniqueness Property Aliases | +Defines a comma-separated list of property aliases to be used to define product uniqueness. See the [Properties concept documentation](../../key-concepts/properties.md#product-uniqueness-properties) for more details. | + +
| Name | +Description | +
|---|---|
| Code Length | +Defines the length of a gift card code when auto-generated. | +
| Code Template | +Defines a string formatting template to use when auto-generating a gift card code, eg: 'GIFTCARD-{0}'. | +
| Valid For | +Defines the number of days gift cards should be valid for by default. | +
| Gift Card Property Aliases | +Defines a comma-separated list of property aliases to be copied to the gift card from the order line. | +
| Activation Method | +Defines the method by which gift cards become active. Can be `Manual` where the store owner must manually active the gift card, `Automatic` where the gift card automatically becomes active after purchase or `Order Status` where the gift card becomes active when the purchase order moves into a specific order status. | +
| Activation Order Status | +When the activation method is `Order Status`, it defines the order status that activates the gift card. | +
| Default Gift Card Email | +Defines the email to be sent to customers if an order contains a gift card item. | +