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
(Massic) documentation update
Damian Legawiec01705f1fe6a4
diff --git a/docs/api-reference/storefront.yaml b/docs/api-reference/storefront.yamlindex 09ff8671c2..808edc3a06 100644--- a/docs/api-reference/storefront.yaml+++ b/docs/api-reference/storefront.yaml@@ -39,7 +39,7 @@ paths:security:- bearerAuth: []post:- description: 'Creates a new account. This endpoint requires the [Spree Auth Devise](https://github.com/spree/spree_auth_devise) gem to be installed.'+ description: 'Creates a new account'summary: Create an Accounttags:- Account@@ -89,7 +89,7 @@ paths:'422':$ref: '#/components/responses/422UnprocessableEntity'patch:- description: 'Updates the users account details. This endpoint requires the [Spree Auth Devise](https://github.com/spree/spree_auth_devise) gem to be installed.'+ description: 'Updates the users account details'summary: Update an Accounttags:- Account@@ -932,7 +932,7 @@ paths:To generate shipments you first need to fetch shipping rates via- [Get Shipping Rates](https://api.spreecommerce.org/docs/api-v2/b3A6MzE0Mjc2MQ-list-shipping-rates) endpoint+ [Get Shipping Rates](/api-reference/storefront/checkout-shipments/list-shipping-rates) endpointoperationId: select-shipping-methodresponses:'200':diff --git a/docs/developer/contributing/creating-an-extension.mdx b/docs/developer/contributing/creating-an-extension.mdxindex 77b5d3923b..bcf979a97f 100644--- a/docs/developer/contributing/creating-an-extension.mdx+++ b/docs/developer/contributing/creating-an-extension.mdx@@ -5,7 +5,7 @@ description: Learn how to create a Spree extension.## Overview-[Spree Extensions](/extending-spree/3rd-party-extensions) are a way to add new functionality to your Spree store. They are a great way to extend the functionality of Spree and add new features. You can share them with Spree community on Github so anyone can use them, contribute back and share your improvements.+[Spree Extensions](/customization/extensions) are a way to add new functionality to your Spree store. They are a great way to extend the functionality of Spree and add new features. You can share them with Spree community on Github so anyone can use them, contribute back and share your improvements.## Getting Starteddiff --git a/docs/developer/contributing/quickstart.mdx b/docs/developer/contributing/quickstart.mdxindex fd997c5b13..7ea5af020b 100644--- a/docs/developer/contributing/quickstart.mdx+++ b/docs/developer/contributing/quickstart.mdx@@ -21,7 +21,7 @@ To find issues you can tackle on we recommend visiting [Spree Contribute page](h## Creating a Spree extension-Extensions provide additional features and integrations for your Spree store. You can create your own and share with the rest of the community. Before doing so please check our [Extension directory](/developer/extending-spree/3rd-party-extensions) if your desired extension does not exist already. If not [follow Extensions tutorial](../contributing/extensions_tutorial) to learn how to create one.+Extensions provide additional features and integrations for your Spree store. You can create your own and share with the rest of the community. Before doing so please check our [Extension directory](/developer/customization/extensions) if your desired extension does not exist already. If not [follow Extensions tutorial](../contributing/extensions_tutorial) to learn how to create one.## Upgrading old extensions to recent Spree versionsdiff --git a/docs/developer/core-concepts/addresses.mdx b/docs/developer/core-concepts/addresses.mdxindex 7d5dfb578a..995ecdd093 100644--- a/docs/developer/core-concepts/addresses.mdx+++ b/docs/developer/core-concepts/addresses.mdx@@ -1,6 +1,6 @@---title: Addresses-+icon: "map"---The `Spree::Address` model is used to track address information, mainly for orders. Address information can also be tied to the `Spree.user_class` which by default is `Spree::User` ([More on Users](users)).diff --git a/docs/developer/core-concepts/adjustments.mdx b/docs/developer/core-concepts/adjustments.mdxindex f88a9b1283..fee1c4474e 100644--- a/docs/developer/core-concepts/adjustments.mdx+++ b/docs/developer/core-concepts/adjustments.mdx@@ -1,5 +1,6 @@---title: Adjustments+icon: "pencil"---## Overview@@ -69,7 +70,7 @@ shipment.adjustments.eligible## Adjustment Associations-As of Spree 2.2, you are able to retrieve the specific adjustments of an Order, a Line Item or a Shipment.+You are able to retrieve the specific adjustments of an Order, a Line Item or a Shipment.An order itself, much like line items and shipments, can have its own individual modifications. For instance, an order with over $100 of line items may have 10% off. To retrieve these adjustments on the order, call the `adjustments` association:@@ -141,5 +142,4 @@ app.config.spree.adjusters = []```-That's it! Your custom adjuster is ready to go.-+That's it! Your custom adjuster is ready to go.\ No newline at end of filediff --git a/docs/developer/core-concepts/architecture.mdx b/docs/developer/core-concepts/architecture.mdxindex 5e17e84e30..c1120eed94 100644--- a/docs/developer/core-concepts/architecture.mdx+++ b/docs/developer/core-concepts/architecture.mdx@@ -1,55 +1,43 @@---title: Architecturedescription: Learn about the Spree architecture+icon: "code"----Spree is built on top of [Ruby on Rails framework](https://rubyonrails.org) and handful of other libraries. Spree itself is a modular platform consisting of several modules (Ruby gems).--As many Rails applications Spree requires a relational database to run. Spree supports both MySQL and PostgreSQL. You can also use SQLite.--### Core gems+Spree is a modular full-stack platform that can be used to build a wide range of e-commerce applications. It includes:++<CardGroup>+ <Card title="Core" icon="code">+ <p>Core is the foundation of Spree, such as models, services, and the backend logic necessary to run an e-commerce business.</p>+ </Card>+ <Card title="Admin Dashboard" icon="gauge">+ <p>The Admin Dashboard is the control center for your Spree store. It allows you to manage products, orders, customers, and more.</p>+ </Card>+ <Card title="Storefront" icon="store">+ <p>The Storefront is the public-facing part of your Spree store where customers can browse products, add them to their cart, and complete purchases.</p>+ </Card>+ <Card title="Emails" icon="envelope">+ <p>Spree includes built-in support for sending transactional emails to customers, such as order confirmations and shipping notifications.</p>+ </Card>+ <Card title="Storefront API" icon="cart-shopping" href="/api-reference/storefront">+ <p>The Storefront API allows developers to interact with the Spree store programmatically, enabling custom front-end experiences and integrations.</p>+ </Card>+ <Card title="Platform API" icon="server" href="/api-reference/platform">+ <p>The Platform API provides a comprehensive set of endpoints for managing all aspects of the Spree store, including products, orders, and customers.</p>+ </Card>+ <Card title="Webhooks" icon="webhook">+ <p>Webhooks allow your Spree store to send real-time notifications to external systems when certain events occur, such as order creation or payment completion.</p>+ </Card>+</CardGroup>++### Code Conventions++Spree is built on top of [Ruby on Rails framework](https://rubyonrails.org) and follows Model-View-Controller (MVC) architecture. As an example let's look at the Product model.++* the model itself is located in [app/models/spree/product.rb](https://github.com/spree/spree/blob/main/core/app/models/spree/product.rb) and is named `Spree::Product`+* the controller is located in [app/controllers/spree/products_controller.rb](https://github.com/spree/spree/blob/main/storefront/app/controllers/spree/products_controller.rb) and is named `Spree::ProductsController`+* views for that controller are located in [app/views/spree/products](https://github.com/spree/spree/tree/main/storefront/app/views/spree/products) directory<Info>-These gems are the core of Spree and they are the most important part of the Spree platform. They are the building blocks that make Spree possible.-</Info>--<AccordionGroup>- <Accordion title="Core">- The core module is the heart of Spree, containing the essential components and functionalities that power Spree stores. This includes the models, services, and the backend logic necessary to manage products, orders, payments, shipping, and more.- </Accordion>- <Accordion title="API">- The API module provides a [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) programmable interface to Spree, allowing developers to interact with the Spree store programmatically. This is useful for integrating Spree with other systems, building mobile applications, or customizing the frontend of a Spree store.-- API gem also includes Webhooks which are a way to let Spree know when something happens in the store. For example, when an order is placed, the API gem can send a webhook to a 3rd party service to let them know about the order.- </Accordion>-</AccordionGroup>--### UI gems--<AccordionGroup>- <Accordion title="Admin Panel">- The Admin Panel module provides a comprehensive backend interface for managing a Spree store. It includes functionalities for product management, order processing, customer service, configuration settings, and more. This module is designed to give store administrators full control over the operations and settings of the store.- </Accordion>- <Accordion title="Storefront">- The Storefront module is the customer-facing part of a Spree store. It includes the presentation layer for displaying products, handling customer carts, and processing checkout operations. This module is built with a focus on user experience, ensuring that customers have a smooth and enjoyable shopping experience.- </Accordion>-</AccordionGroup>--### Optional gems--<AccordionGroup>- <Accordion title="Emails">- The Emails module handles all aspects of email generation and delivery in Spree. This includes order confirmation emails, shipping notifications, promotional emails, and any other email communications between a Spree store and its customers.-- You can opt-out of the default email functionality and use a 3rd party email service eg. Klaviyo or [Mailchimp](https://github.com/spree-contrib/spree_mailchimp_ecommerce).- </Accordion>- <Accordion title="Gateway">- The Gateway module in Spree is responsible for handling payment processing. It integrates with various payment gateways and providers, allowing Spree stores to accept payments from customers through different methods and channels. This module ensures secure and efficient transaction processing, supporting a wide range of payment options to cater to diverse customer preferences.- </Accordion>-</AccordionGroup>--### 3rd party Extensions--Extensions are Spree plugins that add new features or functionality to a Spree store. They are developed and maintained by the Spree community.--You can find a list of Spree extensions on the [Extensions list page](/developer/extending-spree/3rd-party-extensions)+All Spree code is prefixed with `Spree` namespace. Thanks to this convention, it's easy to identify Spree code in a Rails application and we will not have any conflicts with your application code or other libraries.+</Info>\ No newline at end of filediff --git a/docs/developer/core-concepts/calculators.mdx b/docs/developer/core-concepts/calculators.mdxindex 81e5d4a81e..51e632ee17 100644--- a/docs/developer/core-concepts/calculators.mdx+++ b/docs/developer/core-concepts/calculators.mdx@@ -1,5 +1,6 @@---title: Calculators+icon: "calculator"---## Overview@@ -20,11 +21,11 @@ Calculators link to a `calculable` object, which are typically one of `Spree::Sh## Available Calculators-The following are descriptions of the currently available calculators in Spree. If you would like to add your own, please see the [Creating a New Calculator](calculators#creating-a-new-calculator) section.+The following are descriptions of the currently available calculators in Spree. If you would like to add your own, please see the [Creating a New Calculator](#creating-a-new-calculator) section.### Default Tax-For information about this calculator, please read the [Taxation](taxation) guide.+For information about this calculator, please read the [Taxes](/developer/core-concepts/taxes) guide.### Flat Percent Per Item Total@@ -40,7 +41,7 @@ This calculator takes an order and calculates an amount using this calculation:[item total] x [flat percentage]```-For example, if an order had an item total of $31 and the calculator was configured to have a flat percent amount of 10, the discount would be$3.10, because $31 x 10% =$3.10.+For example, if an order had an item total of `$31` and the calculator was configured to have a flat percent amount of `10`, the discount would be `$3.10`, because `$31 x 10% = $3.10`.### Flat Rate@@ -75,11 +76,11 @@ The calculator computes based on this:* up to the `max_items`-Thus, if you have ten items in your shopping cart, your `first_item` preference is set to $10, your `additional_items` preference is set to $5, and your `max_items` preference is set to 4, the total discount would be$25:+Thus, if you have ten items in your shopping cart, your `first_item` preference is set to `$10`, your `additional_items` preference is set to `$5`, and your `max_items` preference is set to `4`, the total discount would be `$25`:-* $10 for the first item-* $5 for each of the 3 subsequent items:$5 \* 3 = $15-* $0 for the remaining 6 items+* `$10` for the first item+* `$5` for each of the `3` subsequent items: `$5 \* 3 = $15`+* `$0` for the remaining `6` items### Per Item@@ -98,9 +99,9 @@ The list of matching products is compared against the line items for the order bEvery matching product within an order will add to the calculator's total. For example, assuming the calculator has an `amount` of 5 and there's an order with the following line items:-* Product A: $15.00 x 2 within matching products-* Product B: $10.00 x 1 within matching products-* Product C: $20.00 x 4 excluded from matching products+* Product A: `$15.00` x `2` within matching products+* Product B: `$10.00` x `1` within matching products+* Product C: `$20.00` x `4` excluded from matching productsThe calculation would be:@@ -113,7 +114,7 @@ meaning the calculator will compute an amount of 15.### Percent Per Item-The Percent Per Item calculator works in a near-identical fashion to the [Per Item Calculator](calculators#per-item), with the exception that rather than providing a flat-rate per item, it is a percentage.+The Percent Per Item calculator works in a near-identical fashion to the [Per Item Calculator](#per-item), with the exception that rather than providing a flat-rate per item, it is a percentage.Assuming a calculator amount of 10% and an order such as this:@@ -138,9 +139,9 @@ The Price Sack calculator is useful for when you want to provide a discount for* `minimal_amount`: The minimum amount for the line items total to trigger the calculator.* `discount_amount`: The amount to discount from the order if the line items total is equal to or greater than the `minimal_amount`.* `normal_amount`: The amount to discount from the order if the line items total is less than the `minimal_amount`.-* `currency`: The currency for this calculator. Defaults to the currency you have set for your application with `Spree::Config[:currency]`+* `currency`: The currency for this calculator. Defaults to the store currency-Suppose you have a Price Sack calculator with a `minimal_amount` preference of $50, a `normal_amount` preference of $2, and a `discount_amount` of$5. An order with a line items total of $60 would result in a discount of$5 for the whole order. An order of $20 would result in a discount of$2.+Suppose you have a Price Sack calculator with a `minimal_amount` preference of `$50`, a `normal_amount` preference of `$2`, and a `discount_amount` of `$5`. An order with a line items total of `$60` would result in a discount of `$5` for the whole order. An order of `$20` would result in a discount of `$2`.## Creating a New Calculator@@ -175,17 +176,15 @@ endThe second thing is to register this calculator as a tax, shipping, or promotion adjustment calculator by calling code like this at the end of `config/initializers/spree.rb` inside your application `config` variable defined for brevity:```ruby-config = Rails.application.config-config.spree.calculators.tax_rates << CustomCalculator-config.spree.calculators.shipping_methods << CustomCalculator-config.spree.calculators.promotion_actions_create_adjustments << CustomCalculator+Rails.application.config.spree.calculators.tax_rates << CustomCalculator+Rails.application.config.spree.calculators.shipping_methods << CustomCalculator+Rails.application.config.spree.calculators.promotion_actions_create_adjustments << CustomCalculator```For example if your calculator is placed in `app/models/spree/calculator/shipping/my_own_calculator.rb` you should call:```ruby-config = Rails.application.config-config.spree.calculators.shipping_methods << Spree::Calculator::Shipping::MyOwnCalculator+Rails.application.config.spree.calculators.shipping_methods << Spree::Calculator::Shipping::MyOwnCalculator```### Determining Availabilitydiff --git a/docs/developer/core-concepts/i18n.mdx b/docs/developer/core-concepts/i18n.mdxindex bb20b15e44..73cc2dde6c 100644--- a/docs/developer/core-concepts/i18n.mdx+++ b/docs/developer/core-concepts/i18n.mdx@@ -1,6 +1,6 @@---title: Internationalization-order: 8+icon: "language"description: >-Spree is ready out of the box to make your brand a global one.---@@ -46,10 +46,6 @@ As of Spree 4.6, resources with user-facing content fields now have built in supOur translatable resources are configured with Mobility’s [Table Backend](https://github.com/shioyama/mobility#table-backend-like-globalize) storage strategy. The way this works is that each translatable resource has a corresponding translations table in the database, in which translation values are stored - for example, product translations are stored in `spree_product_translations`.-<Note>-As of 4.6, data for translatable fields exists solely in the the translation tables so that there is a single source of truth. In the database, the translatable fields on the resource itself will always null. Even if there is only data for a single language, the data for those fields will be stored in the corresponding translations table. In the code, the data will still be accessible via attribute accessors like `.name` and `.description` in the code.-</Note>-<Info>You can read more about how to work with translations by reading [Mobility's usage docs](https://github.com/shioyama/mobility#usage).</Info>@@ -89,6 +85,12 @@ Spree now stores all of the translation information in a separate GitHub projectThe project is actually a Spree extension. This extension contains translations files. To translate models (provide translations for Products, Taxons, etc) you will need to install also [Spree Globalize](https://github.com/spree-contrib/spree_globalize).+To install the Spree I18n extension, run the following command:++```bash+bundle add spree_i18n+```+### Translation FilesEach language is stored in a YAML file located in `config/locales`. Each YAML file contains one top level key which is the language code for the translations contained within that file. The following is a snippet showing the basic layout of a locale file:@@ -134,6 +136,6 @@ en:## Localizing Extensions-[Spree extensions](/developer/extending-spree/3rd-party-extensions) can contain their own `config/locales` directory where developers can include YAML files for each language they wish to support.+[Spree extensions](/developer/customization/extensions) can contain their own `config/locales` directory where developers can include YAML files for each language they wish to support.We strongly urge all extension developers to ensure all customer facing text is rendered via the `Spree.t()` helper method even if they only include a single default language locale file (as other users can simply include the required YAML file and translations in their site extension).diff --git a/docs/developer/core-concepts/inventory.mdx b/docs/developer/core-concepts/inventory.mdxindex e20dee696a..ee1cd1a2d3 100644--- a/docs/developer/core-concepts/inventory.mdx+++ b/docs/developer/core-concepts/inventory.mdx@@ -1,5 +1,6 @@---title: Inventory+icon: "boxes-stacked"---## Overviewdiff --git a/docs/developer/core-concepts/orders.mdx b/docs/developer/core-concepts/orders.mdxindex 9d0280a2e2..5fd6ecb77a 100644--- a/docs/developer/core-concepts/orders.mdx+++ b/docs/developer/core-concepts/orders.mdx@@ -1,5 +1,6 @@---title: Orders+icon: "cart-shopping"---## Overviewdiff --git a/docs/developer/core-concepts/payments.mdx b/docs/developer/core-concepts/payments.mdxindex c365cb69e9..c3f238aaff 100644--- a/docs/developer/core-concepts/payments.mdx+++ b/docs/developer/core-concepts/payments.mdx@@ -1,5 +1,6 @@---title: Payments+icon: "credit-card"---## Overviewdiff --git a/docs/developer/core-concepts/products.mdx b/docs/developer/core-concepts/products.mdxindex 5a8e56d9b8..030df554e7 100644--- a/docs/developer/core-concepts/products.mdx+++ b/docs/developer/core-concepts/products.mdx@@ -1,13 +1,14 @@---title: Products+icon: "box"---## Overview-`Product` records track unique products within your store. These differ from [Variants](products#variants), which track the unique variations of a product. For instance, a product that's a T-shirt would have variants denoting its different colors and sizes. Together, Products and Variants describe what is for sale.+`Product` records track unique products within your store. These differ from [Variants](#variants), which track the unique variations of a product. For instance, a product that's a T-shirt would have variants denoting its different colors and sizes. Together, Products and Variants describe what is for sale.<Info>-Note that as of version 4.6, certain product fields are translatable (read more about this in [Internationalization](../customization/i18n#resource-translations)).+Note that as of version 4.6, certain product fields are translatable (read more about this in [Internationalization](/developer/core-concepts/i18n#resource-translations)).</Info>Products have the following attributes:@@ -45,7 +46,7 @@ The `name` and `presentation` fields for option types are translatable as of ver`Variant` records track the individual variants of a `Product`. Variants are of two types: master variants and normal variants.-Variant records can track some individual properties regarding a variant, such as height, width, depth, and cost price. These properties are unique to each variant, and so are different from [Product Properties](products#product-properties), which apply to all variants of that product.+Variant records can track some individual properties regarding a variant, such as height, width, depth, and cost price. These properties are unique to each variant, and so are different from [Product Properties](#product-properties), which apply to all variants of that product.| Attribute | Description | Example Value ||--------------------|-----------------------------------------------------------------------------------------------|------------------------|@@ -76,7 +77,7 @@ Master variants are automatically created along with a product and exist for the### Regular Variants-Variants which are not the master variant are unique based on a [option type and option value](products#option-types-and-option-values) combinations.+Variants which are not the master variant are unique based on a [option type and option value](#option-types-and-option-values) combinations.For instance, you may be selling a product which is a Baseball Jersey, which comes in the sizes "Small", "Medium" and "Large", as well as in the colors of "Red", "Green". For this combination of sizes and colors, you would be able to create 9 unique variants:@@ -132,15 +133,13 @@ Image order is determined by the `position` attribute, which is an integer. By d<Info>Under the hood we use [Rails Active Storage](https://guides.rubyonrails.org/active_storage_overview.html) to handle image storage and manipulation.--More information about images can be found in the [Images Customization](../customization/images) section.</Info>## Product PropertiesProduct properties track individual attributes for a product that don't apply to all products. These are typically additional information about the item. For instance, a T-Shirt may have properties representing information about the kind of material used, as well as the type of fit the shirt is.-A `Property` should not be confused with an [`OptionType`](products#option-types-and-option-values), which is used when defining [Variants](products#variants) for a product.+A `Property` should not be confused with an [`OptionType`](#option-types-and-option-values), which is used when defining [Variants](#variants) for a product.You can retrieve the value for a property on a `Product` object by calling the `property` method on it and passing through that property's name:@@ -163,7 +162,7 @@ As of version 4.6, product property `value` fields are translatable.## Prices-`Price` objects track a price for a particular currency and variant combination. For instance, a [Variant](products#variants) may be available for $15 (`15 USD`) and €7 (`7 Euro`).+`Price` objects track a price for a particular currency and variant combination. For instance, a [Variant](#variants) may be available for $15 (`15 USD`) and €7 (`7 Euro`).`Price` object contains 3 important attributes:diff --git a/docs/developer/core-concepts/promotions.mdx b/docs/developer/core-concepts/promotions.mdxindex ebb1940b4b..3a1a61540b 100644--- a/docs/developer/core-concepts/promotions.mdx+++ b/docs/developer/core-concepts/promotions.mdx@@ -1,5 +1,6 @@---title: Promotions+icon: "ticket"---## Overview@@ -12,7 +13,6 @@ Promotions can be activated in three different ways:* When a user adds a product to their cart (automatic promotions, eg. free shipping with a threshold)* When a user enters a coupon code during the checkout process-* When a user visits a page within the Spree store (path-based promotions, eg. a promotion that offers a discount on a specific page)Promotions for these individual ways are activated through their corresponding [PromotionHandler class](https://github.com/spree/spree/tree/main/core/app/models/spree/promotion_handler), once they've been checked for eligibility.@@ -29,12 +29,10 @@ Here is a table showcasing the attributes of the `Spree::Promotion` model along| `code` | A code that users can enter to apply the promotion | `SUMMER2023` || `usage_limit` | The total number of times the promotion can be used | 500 || `match_policy` | The policy for how promotion rules are matched | `all` |-| `path` | The specific path that activates the promotion | `/summer-sale` |-| `per_code_usage_limit` | The number of times a single code can be used | 1 |--<Info>- Path-based promotions will only work when the `Spree::PromotionHandler::Page` class is used, as in `Spree::ContentController` from [spree_rails_frontend](https://github.com/spree/spree_rails_frontend) gem-</Info>+| `code_prefix` | A prefix for generated coupon codes | `SUMMER` |+| `number_of_codes` | The number of unique codes to be generated for the promotion| 1000 |+| `kind` | The type of promotion (coupon_code or automatic) | `coupon_code` |+| `multi_codes` | Indicates if the promotion uses multiple coupon codes | `false` |## Actions@@ -43,7 +41,7 @@ There are four actions that come with Spree:<AccordionGroup><Accordion title="Creating an Adjustment"><p>When a <code>CreateAdjustment</code> action is undertaken, an adjustment is automatically applied to the order, unless the promotion has already applied an adjustment to the order.</p>- <p>Once the adjustment has been applied to the order, its eligibility is re-checked every time the order is saved, by way of the <code>Promotion#eligible?</code> method, which uses <code>Promotion#eligible_rules</code> to determine if the promotion is still eligible based on its rules. For how this process works, please see the <a href="promotions#rules">rules section</a> below.</p>+ <p>Once the adjustment has been applied to the order, its eligibility is re-checked every time the order is saved, by way of the <code>Promotion#eligible?</code> method, which uses <code>Promotion#eligible_rules</code> to determine if the promotion is still eligible based on its rules. For how this process works, please see the <a href="#rules">rules section</a> below.</p><p>An adjustment to order from a promotion depends on the calculators. For more information about calculators, please see the <a href="calculators">Calculators guide</a>.</p></Accordion><Accordion title="Creating an Item Adjustment">@@ -92,6 +90,23 @@ Here's a list of all the rules that come with Spree:Rules are used by Spree to determine if a promotion is applicable to an order and can be matched in one of two ways: all of the rules must match, or one rule must match. This is determined by the `match_policy` attribute on the `Promotion` object. As you will see in the Admin, you can set the match_policy to be "any" or "all" of the rules associated with the Promotion. When set to "any" the Promotion will be considered eligible if any one of the rules applies, when set to "all" it will be eligible only if all the rules apply.+## Coupon Codes++Coupon codes are a way to track the usage of a promotion. They are associated with a promotion and can be used to apply the promotion to an order.++Coupon codes are generated when a promotion is created. The number of codes to be generated is set in the `number_of_codes` attribute on the `Promotion` object.++Here is a list of attributes for the `CouponCode` model:++| Attribute | Description | Example |+|----------------|-----------------------------------------------------------------------------|---------------|+| `code` | Auto-generated unique 16-character code for the promotion. | `22A0F62A230BD919` |+| `promotion_id` | ID of the associated promotion. | `12345` |+| `order_id` | ID of the order to which the coupon code is applied. | `67890` |+| `state` | Sate of the promotion code | `unused`, `used` |++If `code_prefix` is set in the `Promotion` object (eg. `PRM`), the `code` will be generated with that prefix, eg. `PRM22A0F62A230BD919`.+## Extending PromotionsPlease follow our [extending Promotions guide](/developer/extending-spree/promotions) to learn how to create custom promotion rules and actions.\ No newline at end of filediff --git a/docs/developer/core-concepts/shipments.mdx b/docs/developer/core-concepts/shipments.mdxindex 0fba25144f..f4f4677fb2 100644--- a/docs/developer/core-concepts/shipments.mdx+++ b/docs/developer/core-concepts/shipments.mdx@@ -1,5 +1,6 @@---title: Shipments+icon: "truck-fast"---## Overview@@ -277,11 +278,11 @@ Split shipments are a feature for more complex Spree applications that require s### Creating Proposed Shipments-This section steps through the basics of what is involved in determining shipments for an order. There are a lot of pieces that make up this process. They are explained in detail in the [Components of Split Shipments](shipments#components-of-split-shipments) section of this guide.+This section steps through the basics of what is involved in determining shipments for an order. There are a lot of pieces that make up this process. They are explained in detail in the [Components of Split Shipments](#components-of-split-shipments) section of this guide.The process of determining shipments for an order is triggered by calling `create_proposed_shipments` on an `Order` object while transitioning to the `delivery` state during checkout. This process will first delete any existing shipments for an order and then determine the possible shipments available for that order.-`create_proposed_shipments` will initially call `Spree::Stock::Coordinator.new(@order).packages`. This will return an array of packages. In order to determine which items belong in which package when they are being built, Spree uses an object called a `Splitter`, described in more detail [below](shipments#the-packer).+`create_proposed_shipments` will initially call `Spree::Stock::Coordinator.new(@order).packages`. This will return an array of packages. In order to determine which items belong in which package when they are being built, Spree uses an object called a `Splitter`, described in more detail [below](#the-packer).After obtaining the array of available packages, they are converted to shipments on the order object. Shipping rates are determined and inventory units are created during this process as well.@@ -289,7 +290,7 @@ At this point, the checkout process can continue to the delivery step.## Components of Split Shipments-This section describes the four main components that power split shipments: [The Coordinator](shipments#the-coordinator), [The Packer](shipments#the-packer), [The Prioritizer](shipments#the-prioritizer), and [The Estimator](shipments#the-estimator).+This section describes the four main components that power split shipments: [The Coordinator](#the-coordinator), [The Packer](#the-packer), [The Prioritizer](#the-prioritizer), and [The Estimator](#the-estimator).### The Coordinatordiff --git a/docs/developer/core-concepts/stores.mdx b/docs/developer/core-concepts/stores.mdxindex d1e0a142c8..b04d232063 100644--- a/docs/developer/core-concepts/stores.mdx+++ b/docs/developer/core-concepts/stores.mdx@@ -1,5 +1,6 @@---title: Stores+icon: "shop"---## Overview@@ -19,13 +20,12 @@ The `Spree::Store` model is the center of the Spree ecosystem. Each Spree instal| Attribute | Description | Example Value ||--------------------------|-----------------------------------------------------------------------------|---------------|| `name` | The name of the store, typically displayed in the browser title bar and throughout the site. | Spree Demo Site |-| `url` | The URL or domain associated with the store. | shop.example.com |+| `code` | A unique code to identify the store. | `spree-001` || `meta_description` | A brief description of the store for SEO purposes. | An exclusive selection of high-quality products. || `meta_keywords` | Relevant keywords associated with the store for SEO. | fashion, electronics, books || `seo_title` | A custom SEO title for the store. | Shop the Best Deals Online - Spree Store || `mail_from_address` | The email address used for sending emails from the store. | [email protected] || `default_currency` | The default currency for prices within the store. | `USD` |-| `code` | A unique code to identify the store. | `spree-001` || `default` | Indicates if the store is the default store. | `true` || `supported_currencies` | A list of currencies supported by the store, separated by commas. | `USD, EUR, GBP` || `supported_locales` | A list of locales supported by the store, separated by commas. | `en, fr, de` |@@ -103,7 +103,7 @@ As of version 4.6, the `Store` resource allows for translating many of its field* `contact_phone`* `new_order_notifications_email`-Read more about how resource translations work in [Internationalization](../customization/i18n#resource-translations).+Read more about how resource translations work in [Internationalization](i18n#resource-translations).## Checkout configuration@@ -125,3 +125,9 @@ Each Store can have its own resources. For example, a Store can have its own Pro| [**Taxonomy**](products#taxons-and-taxonomies) | One Taxonomy belongs to one Store || [**Promotion**](promotions) | One Promotion can be associated with multiple Stores || **Store Credit** | One Store Credit belongs to and can be used in one Store |++## Custom Domains++Spree supports managing custom domains for Stores. This is useful for multi-store setups where each store has its own domain.++In the Admin Panel, you can manage custom domains for each Store in the **Settings -> Domains** page.\ No newline at end of filediff --git a/docs/developer/core-concepts/taxes.mdx b/docs/developer/core-concepts/taxes.mdxindex e37e2b9eea..321f5f3485 100644--- a/docs/developer/core-concepts/taxes.mdx+++ b/docs/developer/core-concepts/taxes.mdx@@ -1,6 +1,7 @@---title: Taxesdescription: Learn how to configure taxes in Spree+icon: "percent"---diff --git a/docs/developer/core-concepts/users.mdx b/docs/developer/core-concepts/users.mdxindex 7be67b74c9..c8feb64708 100644--- a/docs/developer/core-concepts/users.mdx+++ b/docs/developer/core-concepts/users.mdx@@ -1,5 +1,6 @@---title: Users+icon: "users"---In your Spree application you will usually have 2 types of users:@@ -10,14 +11,14 @@ In your Spree application you will usually have 2 types of users:Customers can have:* **[Addresses](/developer/core-concepts/addresses)**, both billing and shipping-* **[Orders](orders)** - a list of products that the user has purchased+* **[Orders](/developer/core-concepts/orders)** - a list of products that the user has purchased* **Credit Cards** - used on the checkout page to pay for the order* **Store Credits** - assigned by the store owners, to be used to purchase products* **Wishlists** - a list of products that the user has marked as a wishlist## User model-The default user class is `Spree::User` (which is provided by the [Auth Devise](https://github.com/spree/spree_auth_devise) extension).+The default user class is `Spree::User` which is generated during Spree installation.You should however reference Users with an universal `Spree.user_class` to avoid any potential issues, eg.diff --git a/docs/developer/customization/api.mdx b/docs/developer/customization/api.mdxnew file mode 100644index 0000000000..24fba3a544--- /dev/null+++ b/docs/developer/customization/api.mdx@@ -0,0 +1,98 @@+---+title: API+icon: code+description: >-+ This page covers adding new Spree API endpoints and customization of+ existing ones+---++Before you start customizing Spree API endpoints, make sure you reviewed all existing API endpoints in the [Spree API docs](/api-reference).++## Customizing JSON response++Spree uses a library called [JSON API serializers](https://github.com/jsonapi-serializer/jsonapi-serializer) to represent data returned by API endpoints.++You can easily replace existing Spree serializers with your own thanks to [Spree Dependencies](dependencies). Here's a list of all serializers that you can override:++| Key | Value |+|------------------------------------------|-----------------------------------------------------|+| `storefront_address_serializer` | [Spree::V2::Storefront::AddressSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/address_serializer.rb) |+| `storefront_cart_serializer` | [Spree::V2::Storefront::CartSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/cart_serializer.rb) |+| `storefront_credit_card_serializer` | [Spree::V2::Storefront::CreditCardSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/credit_card_serializer.rb) |+| `storefront_country_serializer` | [Spree::V2::Storefront::CountrySerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/country_serializer.rb) |+| `storefront_user_serializer` | [Spree::V2::Storefront::UserSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/user_serializer.rb) |+| `storefront_shipment_serializer` | [Spree::V2::Storefront::ShipmentSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/shipment_serializer.rb) |+| `storefront_taxon_serializer` | [Spree::V2::Storefront::TaxonSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/taxon_serializer.rb) |+| `storefront_payment_method_serializer` | [Spree::V2::Storefront::PaymentMethodSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/payment_method_serializer.rb) |+| `storefront_payment_serializer` | [Spree::V2::Storefront::PaymentSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/payment_serializer.rb) |+| `storefront_product_serializer` | [Spree::V2::Storefront::ProductSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/product_serializer.rb) |+| `storefront_estimated_shipment_serializer` | [Spree::V2::Storefront::EstimatedShippingRateSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb) |+| `storefront_store_serializer` | [Spree::V2::Storefront::StoreSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/store_serializer.rb) |+| `storefront_order_serializer` | [Spree::V2::Storefront::OrderSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/order_serializer.rb) |+| `storefront_variant_serializer` | [Spree::V2::Storefront::VariantSerializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/variant_serializer.rb) |++### Adding custom attributes++<Note>+As a rule of thumb it's recommended to use [Properties](/developer/core-concepts/products#product-properties) and [OptionTypes/Option Values](/developer/core-concepts/products#option-types-and-option-values) for custom attributes and not to modify the Spree database schema+</Note>++Let's say you want to customize the Storefront API's [Product serializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/product_serializer.rb) to include you custom database column `my_newcustom_attribute` that you've added to the `spree_products` database table.++Let's start with creating a new serializer file:++```bash+mkdir -p app/serializers && touch app/serializers/my_product_serializer.rb+```++Place the following code in your new serializer file:++```ruby+class MyProductSerializer < Spree::V2::Storefront::ProductSerializer+ attribute :my_new_custom_attribute+end+```++<Info>+This serializer will inherit from the `Spree::V2::Storefront::ProductSerializer` serializer, so you don't need to rewrite the whole serializer.+</Info>++Now let's tell Spree to use this new serializer, in `config/initializers/spree.rb` please set:++```ruby+Spree::Api::Dependencies.storefront_product_serializer = 'MyProductSerializer'+```++Restart the webserver and hit the [Products API](/api-reference/storefront/products/list-all-products) to notice that the payload now includes your new attribute.++### Adding a new association++Let's say you've created a new model called `Video` that belongs to `Product` (_Product has multiple Videos_).++Let's create a new serializer `app/serializers/video_serializer.rb`:++```ruby+class VideoSerializer < Spree::Api::V2::BaseSerializer+ set_type: :video++ attributes :url+end+```++Now in your `app/serializers/my_product_serializer.rb`++```ruby+class MyProductSerializer < Spree::V2::Storefront::ProductSerializer+ attribute :my_new_custom_attribute++ has_many :videos, serializer: :video+end+```++Hitting the Products API you will notice that in the [relationships](https://jsonapi.org/format/#document-resource-object-relationships) key there will be a new key called `videos`++To include Video response in the Product API add `?includes=videos` in the API URL, eg.++```http+GET https://localhost:3000/api/v2/storefront/products?include=videos+```diff --git a/docs/developer/customization/authentication.mdx b/docs/developer/customization/authentication.mdxindex 6d81000930..7bd0827bec 100644--- a/docs/developer/customization/authentication.mdx+++ b/docs/developer/customization/authentication.mdx@@ -2,6 +2,7 @@title: Authenticationdescription: Learn how to use a custom authentication setup with Spreeversion: v5+icon: user---If you installed Spree following the [Quickstart guide](/developer/quickstart), you can completely this step - you are all set and integrated with the [Devise](https://github.com/plataformatec/devise) gem.diff --git a/docs/developer/customization/checkout.mdx b/docs/developer/customization/checkout.mdxindex f6d163593c..0233438b60 100644--- a/docs/developer/customization/checkout.mdx+++ b/docs/developer/customization/checkout.mdx@@ -2,6 +2,7 @@title: Checkout Flowdescription: Learn how to customize the checkout process in Spree.version: v5+icon: "cart-shopping"---## Overview@@ -81,7 +82,7 @@ This step is disabled by default, but can be enabled by two ways:Spree::Config[:always_include_confirm_step] = true```-2. conditionally for specific orders by overriding the `confirmation_required?` method in `Spree::Order`, eg.+2. conditionally for specific orders by overriding the `confirmation_required?` method in `Spree::Order` with a [decorator](/developer/customization/decorators), eg.`app/models/spree/order_decorator.rb` file:diff --git a/docs/developer/core-concepts/preferences.mdx b/docs/developer/customization/configuration.mdxsimilarity index 53%rename from docs/developer/core-concepts/preferences.mdxrename to docs/developer/customization/configuration.mdxindex 30d9d593b0..1abf8881bb 100644--- a/docs/developer/core-concepts/preferences.mdx+++ b/docs/developer/customization/configuration.mdx@@ -1,10 +1,9 @@-## Runtime Preferences+---+title: "Configuration"+icon: "sliders"+----Runtime preferences are used as a configuration object for your application. They are stored in memory. The main use case is for application-wide preferences. For example, `Spree::Config.track_inventory_levels` is a runtime preference. All Spree preferences are defined in [core/lib/spree/core/configuration.rb](https://github.com/spree/spree/blob/main/core/lib/spree/core/configuration.rb).--### Spree Configuration--Here is a list of all the runtime preferences that are available in Spree.+Here is a list of all the configuration options that are available in Spree.| Configuration Key | Description | Default Value ||------------------------------------|-------------------------------------------------------------------------------------------------------|---------------------|@@ -12,7 +11,7 @@ Here is a list of all the runtime preferences that are available in Spree.| `address_requires_phone` | Determines whether a phone number is required for Addresses. | `true` || `alternative_shipping_phone` | Determines if an alternative phone number should be present for the shipping address on the checkout page. | `false` || `always_include_confirm_step` | Determines if the confirmation step is always included in the checkout process, regardless of the payment method. | `false` |- | `auto_capture` | Depending on whether or not Spree is configured to "auto capture" the credit card, either a purchase or an authorize operation will be performed on the card (via the current credit card gateway). | `false` |+ | `auto_capture` | Depending on whether or not Spree is configured to "auto capture" the credit card, either a purchase or an authorize operation will be performed on the card (via the current credit card gateway). | `true` || `auto_capture_on_dispatch` | Captures payment for each shipment in Shipment#after_ship callback, and makes Shipment.ready when payment authorized. | `false` || `company` | Determines whether or not a field for "Company" displays on the address form. | `false` || `credit_to_new_allocation` | Determines if a new allocation is created anytime store credit is added. If not set, it will update the store credit's amount in place. | `false` |@@ -22,12 +21,11 @@ Here is a list of all the runtime preferences that are available in Spree.| `expedited_exchanges_days_window` | The number of days the customer has to return their item after the expedited exchange is shipped to avoid being charged. | `14` || `restock_inventory` | Determines if inventory should be restocked when an order is canceled or returned | `true` || `return_eligibility_number_of_days` | The number of days after purchase within which a return can be initiated. | `365` |- | `send_core_emails` | Determines if core emails should be sent. This includes order confirmation and shipment tracking emails. | `true` || `show_products_without_price` | Determines if products without a price are shown in the storefront and Storefront API | `false` || `tax_using_ship_address` | Determines if tax information should be based on shipping address, rather than the billing address. | `true` || `track_inventory_levels` | Determines if inventory levels should be tracked when products are purchased at checkout. This option causes new `InventoryUnit` objects to be created when a product is bought. | `true` |-### Spree Initializer+## Spree InitializerTo change values for these preferences, you need to edit your `config/initializers/spree.rb` file.@@ -40,10 +38,10 @@ end```<Note>- Remember to restart your Rails server after changing these values.+ Remember to restart your Rails server after making changes to the `config/initializers/spree.rb` file.</Note>-### Accessing Configuration+## Accessing ConfigurationTo access these preferences in your application, you can use the `Spree::Config` module. For example, to access the `expedited_exchanges` preference, you can do the following:@@ -57,118 +55,4 @@ This will return the current value of the `expedited_exchanges` preference. YouSpree::Config.expedited_exchanges = true```-This will set the `expedited_exchanges` preference to `true` for the current process. After restarting the Rails server, the preference will return to the default value or the one set in the initializer.--## Model Preferences--Model preferences are used to store preferences for a specific model instance. They are stored in the database. The main use case is for user-specific preferences. For example, `user.preferred_language` is a model preference.--### Defining Model Preferences--To define a model preference, you need to add them to your model class.--Firstly generate a migration to add the `preferences` column to the table.--```ruby-rails g migration AddPreferencesToSpreeUsers preferences:text-```--Run the migration.--```ruby-rails db:migrate-```--Define the preference in your model.--```ruby-class Spree::User < ApplicationRecord- # ... you existing code ...-- # include the preferable module- include Spree::Preferences::Preferable- # define the preferences- preference :language, :string, default: "English"- preference :sms_marketing, :boolean, default: false-end-```--This will add a `language` preference to the `User` model. The preference will be stored in the newly created `preferences` column of the `spree_users` table. You can add more preferences to the model in the same way.--### Accessing Model Preferences--Once preferences have been defined for a model, they can be accessed either using the shortcut methods that are generated for each preference or the generic methods that are not specific to a particular preference.--#### Shortcut Methods--There are several shortcut methods that are generated. They are shown below.--Query methods:--```ruby-user.prefers_sms_marketing? # => false-```--Reader methods:--```ruby-user.preferred_sms_marketing # => false-user.preferred_language # => "English"-```--Writer methods:--```ruby-user.prefers_sms_marketing = false # => false-user.preferred_language = "English" # => "English"-```--<Note>- Remember to run `user.save` after setting the preference value to save the changes to the database.-</Note>--Check if a preference is available:--```ruby-user.has_preference? :sms_marketing-```--#### Generic Methods--Each shortcut method is essentially a wrapper for the various generic methods shown below:--Query method:--```ruby-user.prefers?(:sms_marketing) # => false-user.prefers?(:language) # => false-```--Reader methods:--```ruby-user.preferred(:sms_marketing) # => false-user.preferred(:language) # => "English"-```--```ruby-user.get_preference :sms_marketing-user.get_preference :language-```--Writer method:--```ruby-user.set_preference(:sms_marketing, false) # => false-user.set_preference(:language, "English") # => "English"-```--#### Accessing All Preferences--You can get a hash of all stored preferences by accessing the `preferences` helper:--```ruby-user.preferences # => {"language"=>"English", "sms_marketing"=>false}-```--This hash will contain the value for every preference that has been defined for the model instance, whether the value is the default or one that has been previously stored.\ No newline at end of file+This will set the `expedited_exchanges` preference to `true` for the current process. After restarting the Rails server, the preference will return to the default value or the one set in the initializer.\ No newline at end of filediff --git a/docs/developer/customization/decorators.mdx b/docs/developer/customization/decorators.mdxindex e3dccff23e..b71efa03c5 100644--- a/docs/developer/customization/decorators.mdx+++ b/docs/developer/customization/decorators.mdx@@ -1,17 +1,14 @@---title: Decorators-description: Decorators allow you to add behavior to Spree classes in your application.+description: Decorators allow you to add or modify behavior of Spree classes in your application.+icon: "code"----<Warning>- It is highly recommended to use [Dependencies](dependencies) instead of decorators. Decorators should be used as a last resort. They can make upgrading Spree more difficult.-</Warning>-## Overview-All of Spree's models, controllers, helpers, etc can easily be extended or overridden to meet your exact requirements using standard Ruby idioms.+All of Spree's models, controllers, services,helpers, etc can easily be extended or overridden to meet your exact requirements using standard Ruby idioms.-Standard practice for including such changes in your application or extension is to create a file within the relevant **app/models/spree** or **app/controllers/spree** directory with the original class name with **_decorator** appended.+Standard practice for including such changes in your application or extension is to create a file within the relevant **app/models/spree** or **app/controllers/spree** directory with the original class name with **_decorator** appended, eg. for the `Spree::Product` model, create a file called `app/models/spree/product_decorator.rb`.## Decorating Models@@ -43,7 +40,7 @@ Let's say you want to change the behavior of the `available?` in the [Product](h### Adding a new method to the model-You can also add a new method to the model. Or even add validations or any other rails magic methods, see example below.+You can also add a new method to the model. Or even add custom validations, callbacks, etc.```rubymodule Spreediff --git a/docs/developer/customization/dependencies.mdx b/docs/developer/customization/dependencies.mdxindex e6ff67c571..05d48382e9 100644--- a/docs/developer/customization/dependencies.mdx+++ b/docs/developer/customization/dependencies.mdx@@ -1,17 +1,16 @@---title: Dependenciessection: customization+icon: gears---## Overview-With Dependencies, you can easily replace parts of Spree core with your custom classes. You can replace [Services](https://github.com/spree/spree/tree/master/core/app/services/spree), CanCanCan Abilities (user for [Permissions](permissions)), and [API Serializers](https://github.com/spree/spree/tree/master/api/app/serializers/spree/v2) (used for generating JSON API responses).--We plan to expand this feature to include more classes in the future.+With Dependencies, you can easily replace parts of Spree core with your custom code. You can replace [Services](https://github.com/spree/spree/tree/master/core/app/services/spree), CanCanCan Abilities (user for [Permissions](permissions)), and [API Serializers](https://github.com/spree/spree/tree/master/api/app/serializers/spree/v2) (used for generating JSON API responses).## Application (global) customization-This will change every aspect of the application (both APIs, Admin Panel, and default Rails frontend if you're using it).+This will change every aspect of the application (both APIs, Admin Panel, and Storefront).In your `config/initializers/spree.rb` file, you can set the following:@@ -41,14 +40,14 @@ module MyAddToCartService < Spree::Cart::AddItemApplicationRecord.transaction dorun :add_to_line_itemrun Spree::Dependencies.cart_recalculate_service.constantize- run :send_notification+ run :update_in_external_systemendendprivate- def send_notification(new_order_line_item)-+ def update_in_external_system(new_order_line_item)+ # Your custom logic hereendend```@@ -59,19 +58,21 @@ This code will:2. Override the `call` method to add your custom logic3. Call `run :add_to_line_item` to add the item to the cart4. Call `run Spree::Dependencies.cart_recalculate_service.constantize` to recalculate the cart-5. Call `run :send_notification` to send a notification+5. Call `run :update_in_external_system` to execute your custom logic, eg. updating Order in an external system such as ERP<Warning>Values set in the initializer have to be strings, eg. `'MyNewAwesomeAddItemToCart'`</Warning>--## Controller level customization-To replace [serializers](https://github.com/jsonapi-serializer/jsonapi-serializer) or Services in a specific API endpoint you can create a simple decorator:+If you need to replace [serializers](https://github.com/jsonapi-serializer/jsonapi-serializer) or Services in a specific API endpoint you can create a [code decorator](/developer/customization/decorators):++```bash+mkdir app/controllers/spree -f && touch app/controllers/spree/cart_controller_decorator.rb+```-Create a `app/controllers/spree/cart_controller_decorator.rb`+and add the following code to it:```rubymodule Spree@@ -91,11 +92,11 @@ endThis will change the serializer in this API endpoint to `MyNewAwesomeCartSerializer` and also it will swap the default `add_item_service` to `MyNewAwesomeAddItemToCart`.-Different API endpoints can have different dependency injection points. You can review their [source code](https://github.com/spree/spree/tree/master/api/app/controllers/spree/api/v2) to see what you can configure.+Different API endpoints can have different dependency injection points. You can review their [source code](https://github.com/spree/spree/tree/master/api/app/controllers/spree/api/v2) to see what you can replace.## API level customization-Storefront and Platform APIs have separate Dependencies injection points so you can easily customize one without touching the other.+Storefront API and Platform API have separate Dependencies injection points so you can easily customize one without touching the other.In your Spree initializer (`config/initializers/spree.rb`) please add:diff --git a/docs/developer/extending-spree/3rd-party-extensions.mdx b/docs/developer/customization/extensions.mdxsimilarity index 89%rename from docs/developer/extending-spree/3rd-party-extensions.mdxrename to docs/developer/customization/extensions.mdxindex e2aa2f7642..0076bce705 100644--- a/docs/developer/extending-spree/3rd-party-extensions.mdx+++ b/docs/developer/customization/extensions.mdx@@ -1,5 +1,6 @@----title: 3rd Party Extensions+title: Extensions+icon: "plug"description: >-Extensions provide additional features and integrations for your Spreeapplication. Here's a list of the most popular ones.@@ -24,6 +25,12 @@ description: >-</Accordion><Accordion title="Internationalization">+ <Card+ title="Spree I18n"+ href="https://github.com/spree-contrib/spree_i18n"+ >+ Spree I18n is a gem that provides a way to translate Spree Commerce applications into multiple languages. It allows you to translate the UI and have different translations for product descriptions, taxons, etc to improve conversions and customer satisfaction.+ </Card><Cardtitle="Flow Commerce"href="https://github.com/mejuri-inc/flowcommerce_spree"@@ -77,12 +84,6 @@ description: >-</Accordion><Accordion title="Payments">- <Card- title="Affirm"- href="https://github.com/Affirm/spree_affirm"- >- Affirm payment method.- </Card><Cardtitle="Amazon Pay"href="https://github.com/ShopFelixGray/spree_pay_with_amazon"@@ -102,10 +103,10 @@ description: >-official Mollie payment gateway for Spree Commerce. Accept all major payment methods, including iDEAL, Bancontact, Visa, Mastercard, AmEx, and many more.</Card><Card- title="Stripe Terminal"- href="https://github.com/ShopFelixGray/spree_stripe_terminal"+ title="Stripe"+ href="https://github.com/spree/spree_stripe">- Allows you to process payments with the stripe terminal via the backend of spree.+ Official Stripe payment gateway for Spree Commerce. Supports all major credit cards, Apple Pay, Google Pay, buy-now-pay-later (Affirm, Afterpay, Klarna), regional payment methods, and more.</Card></Accordion>diff --git a/docs/developer/customization/metadata.mdx b/docs/developer/customization/metadata.mdxnew file mode 100644index 0000000000..2ea56c78dc--- /dev/null+++ b/docs/developer/customization/metadata.mdx@@ -0,0 +1,44 @@+---+title: Metadata+icon: "tags"+---++## Overview++Metadata is a way to add additional information to Spree objects. There are two types of metadata:++<CardGroup>+ <Card title="Public Metadata">+ Public metadata is available via <a href="/api-reference/storefront">Storefront API</a> without any authentication. It is stored in the <code>public_metadata</code> JSONB column of the table. This kind of metadata should be only used for public information that is visible to all users, eg. additional information about the object.+ </Card>+ <Card title="Private Metadata">+ Private metadata is only available via <a href="/api-reference/platform">Platform API</a> and requires authentication. It is stored in the <code>private_metadata</code> JSONB column of the table. This kind of metadata should be only used for private information that is not visible to the public, eg. IDs in external systems, private notes, etc.+ </Card>+</CardGroup>++## Usage++### Adding metadata to an object++```ruby+taxon = Spree::Taxon.find(1)+taxon.public_metadata = { "google_category_id": "123" }+taxon.save!+```++### Fetching metadata from an object++```ruby+taxon = Spree::Taxon.find(1)+puts taxon.public_metadata["google_category_id"]+```++### Querying objects by metadata++```ruby+Spree::Taxon.where("public_metadata->>'google_category_id' = ?", "123")+```++<Warning>+ For Products it's recommended to use [Properties](/developer/core-concepts/products#product-properties) or [Option Types](/developer/core-concepts/products#option-types-and-option-values) instead of Metadata.+</Warning>diff --git a/docs/developer/customization/model-preferences.mdx b/docs/developer/customization/model-preferences.mdxnew file mode 100644index 0000000000..44b621fbbd--- /dev/null+++ b/docs/developer/customization/model-preferences.mdx@@ -0,0 +1,133 @@+---+title: Model Preferences+icon: "list"+---++Model preferences allow you to easily extend Spree models with configuration options. Thanks to this you can store useful information on Spree models, eg.++```ruby+user.preferred_language = "English"+user.save+```++## Defining Model Preferences++To define a model preference, you need to add them to your model class.++Make sure to generate a migration to add the `preferences` column to the table. This column will store the preferences in a serialized format.++```ruby+rails g migration AddPreferencesToSpreeUsers preferences:text+```++Run the migration.++```ruby+rails db:migrate+```++```ruby+class Spree::User < ApplicationRecord+ # ... you existing code ...++ # include the preferable module+ include Spree::Preferences::Preferable+ # define the preferences+ preference :language, :string, default: "English"+ preference :sms_marketing, :boolean, default: false+end+```++This will add a `language` preference to the `User` model. The preference will be stored in the newly created `preferences` column of the `spree_users` table. You can add more preferences to the model in the same way.++## Accessing Model Preferences++Once preferences have been defined for a model, they can be accessed either using the shortcut methods that are generated for each preference or the generic methods that are not specific to a particular preference.++### Shortcut Methods++There are several shortcut methods that are generated. They are shown below.++Query methods:++```ruby+user.prefers_sms_marketing? # => false+```++Reader methods:++```ruby+user.preferred_sms_marketing # => false+user.preferred_language # => "English"+```++Writer methods:++```ruby+user.prefers_sms_marketing = false # => false+user.preferred_language = "English" # => "English"+```++<Note>+ Remember to run `user.save` after setting the preference value to save the changes to the database.+</Note>++Check if a preference is available:++```ruby+user.has_preference? :sms_marketing+```++### Generic Methods++Each shortcut method is essentially a wrapper for the various generic methods shown below:++Query method:++```ruby+user.prefers?(:sms_marketing) # => false+user.prefers?(:language) # => false+```++Reader methods:++```ruby+user.preferred(:sms_marketing) # => false+user.preferred(:language) # => "English"+```++```ruby+user.get_preference :sms_marketing+user.get_preference :language+```++Writer method:++```ruby+user.set_preference(:sms_marketing, false) # => false+user.set_preference(:language, "English") # => "English"+```++### Accessing All Preferences++You can get a hash of all stored preferences by accessing the `preferences` helper:++```ruby+user.preferences # => {"language"=>"English", "sms_marketing"=>false}+```++This hash will contain the value for every preference that has been defined for the model instance, whether the value is the default or one that has been previously stored.++## Models with preferences++The following Spree models already have preferences defined:++* `Spree::Calculator`+* `Spree::Gateway`+* `Spree::PageBlock`+* `Spree::PageSection`+* `Spree::Page`+* `Spree::PaymentMethod`+* `Spree::PromotionRule`+* `Spree::Store`+* `Spree::Theme`\ No newline at end of filediff --git a/docs/developer/customization/permissions.mdx b/docs/developer/customization/permissions.mdxindex 283389a5e0..ab987831ff 100644--- a/docs/developer/customization/permissions.mdx+++ b/docs/developer/customization/permissions.mdx@@ -1,5 +1,6 @@---title: Permissions+icon: "shield-halved"---## User and Rolesdiff --git a/docs/developer/extending-spree/promotions.mdx b/docs/developer/customization/promotions.mdxsimilarity index 97%rename from docs/developer/extending-spree/promotions.mdxrename to docs/developer/customization/promotions.mdxindex 958106a3cd..78d8a1442d 100644--- a/docs/developer/extending-spree/promotions.mdx+++ b/docs/developer/customization/promotions.mdx@@ -1,3 +1,10 @@+---+title: Custom Promotions+icon: "ticket"+description: >-+ In this guide we will show you how to create custom promotion rules and actions in Spree.+---+## OverviewIn this guide we will show you how to create custom promotion rules and actions in Spree.diff --git a/docs/developer/customization/quickstart.mdx b/docs/developer/customization/quickstart.mdxindex b0a91de2e9..21b2a47259 100644--- a/docs/developer/customization/quickstart.mdx+++ b/docs/developer/customization/quickstart.mdx@@ -2,6 +2,7 @@title: Quickstartog:title: Spree Customization Quickstartdescription: Learn how to customize every part of the Spree stack+icon: wrench---Spree is a very flexible platform allowing you to customize every part of it, to suit your business needs.@@ -14,46 +15,15 @@ There are several ways you can achieve this:Changing currency, shipping zones, languages - it's very easy to do.- Go to `Admin > Configuration > General Settings`+ Go to **Admin > Configuration > General Settings**<img src="/images/spree_admin_store_settings.png" alt="Spree Admin Store Settings" /></Accordion><Accordion title="Configuration">- Configuration allows you to tweak Spree's behavior without having to modify the source code.-- Spree comes with a handful configuration options you can change:-- | Configuration Key | Description | Default Value |- |------------------------------------|-------------------------------------------------------------------------------------------------------|---------------------|- | `allow_checkout_on_gateway_error` | Continues the checkout process even if the payment gateway error failed. | `false` |- | `address_requires_phone` | Determines whether a phone number is required for Addresses. | `true` |- | `alternative_shipping_phone` | Determines if an alternative phone number should be present for the shipping address on the checkout page. | `false` |- | `always_include_confirm_step` | Determines if the confirmation step is always included in the checkout process, regardless of the payment method. | `false` |- | `auto_capture` | Depending on whether or not Spree is configured to "auto capture" the credit card, either a purchase or an authorize operation will be performed on the card (via the current credit card gateway). | `false` |- | `auto_capture_on_dispatch` | Captures payment for each shipment in Shipment#after_ship callback, and makes Shipment.ready when payment authorized. | `false` |- | `company` | Determines whether or not a field for "Company" displays on the address form. | `false` |- | `credit_to_new_allocation` | Determines if a new allocation is created anytime store credit is added. If not set, it will update the store credit's amount in place. | `false` |- | `disable_sku_validation` | Determines if the built-in SKU uniqueness validation is disabled. | `false` |- | `disable_store_presence_validation` | Determines if Store presence validation for Products and Payment Methods is disabled. | `false` |- | `expedited_exchanges` | Determines if an exchange shipment is kicked off upon return authorization save. Requires payment profiles to be supported on your gateway and a configured delayed job handler. | `false` |- | `expedited_exchanges_days_window` | The number of days the customer has to return their item after the expedited exchange is shipped to avoid being charged. | `14` |- | `restock_inventory` | Determines if inventory should be restocked when an order is canceled or returned | `true` |- | `return_eligibility_number_of_days` | The number of days after purchase within which a return can be initiated. | `365` |- | `send_core_emails` | Determines if core emails should be sent. This includes order confirmation and shipment tracking emails. | `true` |- | `show_products_without_price` | Determines if products without a price are shown in the storefront and Storefront API | `false` |- | `tax_using_ship_address` | Determines if tax information should be based on shipping address, rather than the billing address. | `true` |- | `track_inventory_levels` | Determines if inventory levels should be tracked when products are purchased at checkout. This option causes new `InventoryUnit` objects to be created when a product is bought. | `true` |-- To change these you need to edit your `config/initializers/spree.rb` file.-- For example, to disable the `expedited_exchanges` feature, you would add the following line:-- ```ruby- Spree.config do |config|- config.expedited_exchanges = false- end- ```+ Global application configuration allows you to tweak Spree's behavior without having to modify the source code.++ Please see [Preferences](/developer/core-concepts/preferences) section for more information.</Accordion><Accordion title="Authentication">diff --git a/docs/developer/customization/routes.mdx b/docs/developer/customization/routes.mdxindex 49ae9a8355..7b112faa3f 100644--- a/docs/developer/customization/routes.mdx+++ b/docs/developer/customization/routes.mdx@@ -1,6 +1,7 @@---title: Routesdescription: Learn how to customize the routes in Spree+icon: "route"---## Default configurationdiff --git a/docs/developer/customization/v4/deface.mdx b/docs/developer/customization/v4/deface.mdxindex 73f132ac2b..83f1cf8b1b 100644--- a/docs/developer/customization/v4/deface.mdx+++ b/docs/developer/customization/v4/deface.mdx@@ -69,7 +69,7 @@ module Spreeend```-Now, when we head to `http://localhost:3000/admin/products` and edit a product, we should be able to set a sale price for the product and be able to view it on our sale page, `http://localhost:3000/sale`. Note that you will likely need to restart our example Spree application created in the [Getting Started tutorial](../getting-started/installation).+Now, when we head to `http://localhost:3000/admin/products` and edit a product, we should be able to set a sale price for the product and be able to view it on our sale page, `http://localhost:3000/sale`. Note that you will likely need to restart our example Spree application created in the [Getting Started tutorial](/developer/getting-started/quickstart).### Available actionsdiff --git a/docs/developer/deployment/assets.mdx b/docs/developer/deployment/assets.mdxindex a2f6ba1388..ff6f1cf153 100644--- a/docs/developer/deployment/assets.mdx+++ b/docs/developer/deployment/assets.mdx@@ -1,5 +1,6 @@---title: Assets+icon: "images"---Spree uses [Active Storage](https://guides.rubyonrails.org/active_storage_overview.html) to handle file uploads (eg. product images). By default, Active Storage uses local disk storage for attachments. This isn't suitable for production environments.diff --git a/docs/developer/deployment/caching.mdx b/docs/developer/deployment/caching.mdxindex c4d85b3e9b..639ddc2b32 100644--- a/docs/developer/deployment/caching.mdx+++ b/docs/developer/deployment/caching.mdx@@ -1,7 +1,9 @@---+title: Cachingdescription: >-This guide will cover all sorts of topics related to Spree applicationperformance+icon: "database"---Caching is a great way to improve the performance of your Spree application. In all modern web applications, usually the most time consuming operations are database queries and rendering templates. Caching allows you to store the results of these operations in memory and serve them from there.diff --git a/docs/developer/deployment/cdn.mdx b/docs/developer/deployment/cdn.mdxindex 7340cb93d5..71177c1d58 100644--- a/docs/developer/deployment/cdn.mdx+++ b/docs/developer/deployment/cdn.mdx@@ -2,6 +2,7 @@title: CDNdescription: >-Learn how to improve performance of your Spree application by using a CDN (Content Delivery Network).+icon: "cloud"---To improve performance of your Spree application, we recommend using a CDN (Content Delivery Network) to cache images and static files.diff --git a/docs/developer/deployment/docker.mdx b/docs/developer/deployment/docker.mdxindex 130da22be0..72fbd452fc 100644--- a/docs/developer/deployment/docker.mdx+++ b/docs/developer/deployment/docker.mdx@@ -1,6 +1,7 @@---title: Dockerdescription: Learn how to build a Docker image of your Spree application.+icon: "docker"---Spree (when using Spree Starter template) comes with a Dockerfile that can be used to build a Docker image of your application.diff --git a/docs/developer/deployment/render.mdx b/docs/developer/deployment/render.mdxindex 9af3a1f8d0..48b0fb91a0 100644--- a/docs/developer/deployment/render.mdx+++ b/docs/developer/deployment/render.mdx@@ -1,6 +1,7 @@---title: Renderdescription: Deploy your Spree application to [Render.com](https://render.com) Platform as a Service platform+icon: "server"---## Overview@@ -36,7 +37,7 @@ Now clone the repository to your local machine.git clone https://github.com/your-username/my_spree_app.git```-Now you can start working on your application. Make sure your environment is set up correctly (follow the [Getting Started](/developer/getting_started) guide).+Now you can start working on your application. Make sure your environment is set up correctly (follow the [Getting Started](/developer/getting-started/quickstart) guide).Running the `bin/setup` script should set your credentials correctly.diff --git a/docs/developer/extending-spree/api_v2.mdx b/docs/developer/extending-spree/api_v2.mdxdeleted file mode 100644index 6b7701314b..0000000000--- a/docs/developer/extending-spree/api_v2.mdx+++ /dev/null@@ -1,74 +0,0 @@-----title: API v2-section: customization-order: 6-description: >-- This page covers adding new Storefront API endpoints and customization of- existing ones------# Storefront API--## Customizing existing API endpoints--### Customizing JSON response--Spree uses J[SON API serializers](https://github.com/jsonapi-serializer/jsonapi-serializer) to represent data returned by API endpoints.--You can easily swap OOTB Spree serializers with your own thanks to [Spree Dependencies](dependencies).--#### Adding custom attributes--<Note>-Generally it's recommended to use [Properties](/developer/core-concepts/products#product-properties) and [OptionTypes/Option Values](/developer/core-concepts/products#option-types-and-option-values) for custom attributes and not to modify the Spree database schema-</Note>--Let's say you want to customize the Storefront API's [Product serializer](https://github.com/spree/spree/blob/main/api/app/serializers/spree/v2/storefront/product_serializer.rb) to include you custom database column `my_newcustom_attribute` that you've added to the `spree_products` database table.--Let's start with creating a new serializer file in your project's `app/serializers` directory, that is `app/serializers/my_product_serializer.rb`:--```ruby-class MyProductSerializer < Spree::V2::Storefront::ProductSerializer- attribute :my_new_custom_attribute-end-```--Now let's tell Spree to use this new serializer, in `config/initializers/spree.rb` please set:--```ruby-Spree::Api::Dependencies.storefront_product_serializer = 'MyProductSerializer'-```--Restart the webserver and hit the [Products API ](https://api.spreecommerce.org/docs/api-v2/b3A6MzE0Mjc2Mg-list-of-products)to notice that the payload now includes your new attribute. alongside the standard output.--#### Adding a new association--Let's say you've created a new model called `Video` that belongs to `Product` (_Product has multiple Videos_).--Let's create a new serializer `app/serializers/video_serializer.rb`:--```ruby-class VideoSerializer < Spree::Api::V2::BaseSerializer- set_type: :video-- attributes :url-end-```--Now in your `app/serializers/my_product_serializer.rb`--```ruby-class MyProductSerializer < Spree::V2::Storefront::ProductSerializer- attribute :my_new_custom_attribute-- has_many :videos, serializer: :video-end-```--Hitting the Products API you will notice that in the [relationships](https://jsonapi.org/format/#document-resource-object-relationships) key there will be a new key called `videos`--To include Video response in the Product API add `?includes=videos` in the API URL, eg.--```http-GET https://localhost:3000/api/v2/storefront/products?include=videos-```diff --git a/docs/developer/getting-started/quickstart.mdx b/docs/developer/getting-started/quickstart.mdxindex eda41041b3..9490c55cb9 100644--- a/docs/developer/getting-started/quickstart.mdx+++ b/docs/developer/getting-started/quickstart.mdx@@ -1,17 +1,14 @@---title: "Quickstart"description: "Start building awesome eCommerce applications with Spree open-source eg. multi-store, multi-vendor, multi-tenant, multi-language, multi-currency. B2B or B2C."+icon: "rocket"---<img alt="Spree Commerce - Open Source e-commerce platform" classname="block dark:hidden" src="https://vendo-production-res.cloudinary.com/image/upload/w_1920/q_auto/v1733327023/docs/Spree_Commerce_open_source_eCommerce_platform_Ruby_on_Rails_API_headless_tsnvap.png" />## Getting Started with Spree Commerce-Welcome to the Spree Commerce [open-source eCommerce](https://github.com/spree/spree) documentation guide. Follow the instructions below to learn how to build and deploy your Spree Commerce store.--<Info>- If you want to add Spree to your existing Rails application, you can skip this page and go to the [Adding to an existing Rails app](adding_spree_to_rails_app) section.-</Info>+Welcome to the Spree Commerce [open-source eCommerce](https://spreecommerce.org) documentation guide. Follow the instructions below to learn how to build and deploy your Spree Commerce store.### 1. Installing Spreediff --git a/docs/developer/storefront/storefront-overview.mdx b/docs/developer/storefront/storefront-overview.mdxnew file mode 100644index 0000000000..f1f5982542--- /dev/null+++ b/docs/developer/storefront/storefront-overview.mdx@@ -0,0 +1,34 @@+---+title: "Storefront Overview"+---++Spree 5 ships with a new mobile-first storefront that is fully customizable & themeable.++## Architecture++New Storefront consists of:++* Themes++ Themes are a collection of styles, scripts and templates that are used to style and layout the storefront.++* Pages++ Pages are the main building blocks of the storefront. They are used to create the structure of the storefront. Each Theme comes with a set of default pages such as Home Page, Product Listing Page, Product Page, etc, but you can create your own custom landing pages as well.++* Sections++ Sections are the building blocks of the pages. They are used to create the structure of the pages. Each Section is a collection of Blocks.++* Blocks++ Blocks are the smallest building blocks of the storefront. They are used to create the content of the pages.++## Page Builder++++The new storefront comes with a Page Builder that allows you to build pages using a drag-and-drop interface, as a part of Spree Admin Dashboard (provided via `spree_admin` gem). This allows you to create new pages and sections, modify existing ones, and add new blocks to the pages in a no-code way.++You can learn more about the Page Builder in the [User Documentation](/user/storefront/theme-editor).+diff --git a/docs/developer/storefronts/next.js-commerce.mdx b/docs/developer/storefronts/next.js-commerce.mdxdeleted file mode 100644index 9834301dbb..0000000000--- a/docs/developer/storefronts/next.js-commerce.mdx+++ /dev/null@@ -1,22 +0,0 @@-# Next.js Commerce--[Next.js Commerce](https://nextjs.org/commerce) is an all-in-one React starter kit for high-performance e-commerce sites.--See the live demo: [https://spree.vercel.store/](https://spree.vercel.store/)--### Installation--1. Clone the git repository:-- ```- git clone https://github.com/spree/nextjs-commerce.git- ```-2. Copy the `framework/spree/.env.template` file to `.env.local` in the main directory:-- ```- cp framework/spree/.env.template .env.local- ```-3. Adjust the `NEXT_PUBLIC_SPREE_CATEGORIES_TAXONOMY_PERMALINK` and `NEXT_PUBLIC_SPREE_BRANDS_TAXONOMY_PERMALINK` environment variables inside `.env.local`:- * They rely on [taxonomies](https://developer/core-concepts/products#taxons-and-taxonomies) `permalink` values set in Spree.- * Go to the Spree admin panel and create `Categories` and `Brands` taxonomies if they don't exist. Copy their permalinks into `.env.local` in NextJS Commerce.-4. Finally, run `yarn install` and `yarn run dev`.diff --git a/docs/developer/storefronts/vue-storefront.mdx b/docs/developer/storefronts/vue-storefront.mdxdeleted file mode 100644index 78433e0732..0000000000--- a/docs/developer/storefronts/vue-storefront.mdx+++ /dev/null@@ -1,43 +0,0 @@-# Vue Storefront--<Note>-This integration was built by the awesome Team at [Upside](https://upsidelab.io/) [❤️](https://emojipedia.org/red-heart/)-</Note>--[Vue Storefront](https://www.vuestorefront.io/) is a lightning-fast frontend platform for headless eCommerce solutions. It comes with both reusable components to build custom storefronts and a default theme that allows developers to effortlessly create an eCommerce frontend.--See the live demo: [https://vuestorefront-spree.upsidelab.io/](https://vuestorefront-spree.upsidelab.io/)--### Installation--1. Clone the git repository:--```bash-git clone https://github.com/upsidelab/vue-storefront-spree.git-```--2\. Install the required dependencies:--```bash-yarn install-```--3\. Set the backend URL via env variable:--```bash-export BACKEND_URL=https://localhost:4000-```--4\. (optional) Then you can verify if everything works properly by building all three projects:--```bash-yarn build-```--5\. If everything is built properly, you can start working on your new frontend with:--```bash-yarn dev-```--For more configurtion options please visit the Spree [VueStorefront GitHub repository](https://github.com/vuestorefront/spree).diff --git a/docs/developer/upgrades/4.5-to-4.6.mdx b/docs/developer/upgrades/4.5-to-4.6.mdxindex d0daeeb358..e6adc29505 100644--- a/docs/developer/upgrades/4.5-to-4.6.mdx+++ b/docs/developer/upgrades/4.5-to-4.6.mdx@@ -30,7 +30,7 @@ If your application used the spree_globalize extension, you can remove it from yWe've configured Mobility to use [a strategy that uses a separate table to store translations](https://dejimata.com/2017/3/3/translating-with-mobility#strategy-2), just like how spree_globalize did. This means, you won't need to make any changes to the database structure or migrate data.-During the upgrade process, you may need to review your custom queries that rely on translations, as there are minor differences in how Mobility handles them. Spree 4.6 includes a few [built-in concerns](../../customization/i18n) to make it easier to work with translatable models.+During the upgrade process, you may need to review your custom queries that rely on translations, as there are minor differences in how Mobility handles them. Spree 4.6 includes a few [built-in concerns](/developer/core-concepts/i18n#resource-translations-implementation) to make it easier to work with translatable models.Run the following command to remove spree_globalize from your Gemfile:@@ -74,7 +74,7 @@ bin/rails g spree:frontend:install### Update migrations for translation tables with additional columns-If you want to translate more fields in [translated resources](/developer/customization/i18n#resource-translations), you have to alter copied migrations or add new ones.+If you want to translate more fields in [translated resources](/developer/core-concepts/i18n#resource-translations), you have to alter copied migrations or add new ones.We're using the [Spree::TranslationMigrations](https://github.com/spree/spree/blob/main/core/lib/spree/translation_migrations.rb) to help with migrating data.### Add or update the behavior of the translated model@@ -86,7 +86,7 @@ If you overwrote Spree models in your application, you have to define this block- `Spree::TranslatableResource` - required for all translated models- `Spree::TranslatableResourceSlug` - required for translated models with slugs/permalinks-[Read more](/developer/customization/i18n#resource-translations-implementation) how Spree handles resource translations.+[Read more](/developer/core-concepts/i18n#resource-translations-implementation) how Spree handles resource translations.### Generating slugs with `friendly_id`@@ -98,7 +98,7 @@ Currently, it's not possible to translate encrypted data. If you're already encr### Full text search with pg_search scopes-If you use the [pg_search](https://github.com/Casecommons/pg_search) for the full text search in [translated resources](/developer/customization/i18n#resource-translations), you need to move your scopes to the translated model, eg. from the `Spree::Product` to the `Spree::Product::Translation`.+If you use the [pg_search](https://github.com/Casecommons/pg_search) for the full text search in [translated resources](/developer/core-concepts/i18n#resource-translations), you need to move your scopes to the translated model, eg. from the `Spree::Product` to the `Spree::Product::Translation`.If you still want to have the original scope, you need to rewrite it, from:diff --git a/docs/docs.json b/docs/docs.jsonnew file mode 100644index 0000000000..84d0f06e78--- /dev/null+++ b/docs/docs.json@@ -0,0 +1,1816 @@+{+ "$schema": "https://mintlify.com/docs.json",+ "name": "Spree Commerce documentation",+ "theme": "mint",+ "colors": {+ "primary": "#0A2242",+ "light": "#D7DFE9",+ "dark": "#0A2242"+ },+ "favicon": "/favicon.png",+ "navigation": {+ "versions": [+ {+ "version": "v5",+ "default": true,+ "tabs": [+ {+ "tab": "Developer Docs",+ "groups": [+ {+ "group": "Getting started",+ "pages": [+ "developer/getting-started/quickstart",+ "developer/core-concepts/architecture",+ "developer/core-concepts/stores",+ "developer/core-concepts/orders",+ "developer/core-concepts/users",+ "developer/core-concepts/products",+ "developer/core-concepts/inventory",+ "developer/core-concepts/payments",+ "developer/core-concepts/taxes",+ "developer/core-concepts/promotions",+ "developer/core-concepts/shipments",+ "developer/core-concepts/calculators",+ "developer/core-concepts/adjustments",+ "developer/core-concepts/addresses",+ "developer/core-concepts/i18n"+ ]+ },+ {+ "group": "Customizing Spree",+ "pages": [+ "developer/customization/quickstart",+ "developer/customization/configuration",+ "developer/customization/authentication",+ "developer/customization/checkout",+ "developer/customization/permissions",+ "developer/customization/dependencies",+ "developer/customization/decorators",+ "developer/customization/model-preferences",+ "developer/customization/metadata",+ "developer/customization/routes",+ "developer/customization/api",+ "developer/customization/promotions",+ "developer/customization/extensions"+ ]+ },+ {+ "group": "Deployment",+ "pages": [+ "developer/deployment/render",+ "developer/deployment/docker",+ "developer/deployment/assets",+ "developer/deployment/cdn",+ "developer/deployment/caching"+ ]+ },+ {+ "group": "Upgrading",+ "pages": [+ "developer/upgrades/quickstart",+ {+ "group": "Upgrade Guides",+ "pages": [+ "developer/upgrades/4.8-to-4.9",+ "developer/upgrades/4.x-to-4.8",+ "developer/upgrades/4.6-to-4.7",+ "developer/upgrades/4.5-to-4.6",+ "developer/upgrades/4.4-to-4.5",+ "developer/upgrades/4.3-to-4.4",+ "developer/upgrades/4.2-to-4.3",+ "developer/upgrades/4.1-to-4.2",+ "developer/upgrades/4.0-to-4.1",+ "developer/upgrades/3.7-to-4.0",+ "developer/upgrades/3.6-to-3.7",+ "developer/upgrades/3.5-to-3.6",+ "developer/upgrades/3.4-to-3.5",+ "developer/upgrades/3.3-to-3.4",+ "developer/upgrades/3.2-to-3.3",+ "developer/upgrades/3.1-to-3.2",+ "developer/upgrades/3.0-to-3.1",+ "developer/upgrades/2.3-to-2.4",+ "developer/upgrades/2.2-to-2.3",+ "developer/upgrades/2.1-to-2.2",+ "developer/upgrades/2.0-to-2.1"+ ]+ }+ ]+ },+ {+ "group": "Contributing",+ "pages": [+ "developer/contributing/quickstart",+ "developer/contributing/developing-spree",+ "developer/contributing/creating-an-extension"+ ]+ },+ {+ "group": "Security",+ "pages": [+ "developer/security/security_policy",+ "developer/security/pci_compliance"+ ]+ },+ {+ "group": "Advanced",+ "pages": [+ "developer/advanced/adding_spree_to_rails_app"+ ]+ }+ ]+ },+ {+ "tab": "Ecommerce API",+ "groups": [+ {+ "group": "API basics",+ "pages": [+ "api-reference/introduction",+ "api-reference/pagination",+ "api-reference/filtering-and-sorting",+ "api-reference/fetching-multiple-resources"+ ]+ },+ {+ "group": "Storefront API",+ "pages": [+ "api-reference/storefront/authentication",+ {+ "group": "Account",+ "pages": [+ "api-reference/storefront/account/retrieve-an-account",+ "api-reference/storefront/account/create-an-account",+ "api-reference/storefront/account/update-an-account"+ ]+ },+ {+ "group": "Account / Address",+ "pages": [+ "api-reference/storefront/account-address/list-all-addresses",+ "api-reference/storefront/account-address/create-an-address",+ "api-reference/storefront/account-address/remove-an-address",+ "api-reference/storefront/account-address/update-an-address"+ ]+ },+ {+ "group": "Account / Credit Cards",+ "pages": [+ "api-reference/storefront/account-credit-cards/list-all-credit-cards",+ "api-reference/storefront/account-credit-cards/remove-a-credit-card",+ "api-reference/storefront/account-credit-cards/retrieve-the-default-credit-card"+ ]+ },+ {+ "group": "Account / Orders",+ "pages": [+ "api-reference/storefront/account-orders/list-all-orders",+ "api-reference/storefront/account-orders/retrieve-an-order"+ ]+ },+ {+ "group": "Order Status",+ "pages": [+ "api-reference/storefront/order-status/retrieve-an-order-status"+ ]+ },+ {+ "group": "Cart",+ "pages": [+ "api-reference/storefront/cart/retrieve-a-cart",+ "api-reference/storefront/cart/create-a-cart",+ "api-reference/storefront/cart/delete-a-cart"+ ]+ },+ {+ "group": "Cart / Line Items",+ "pages": [+ "api-reference/storefront/cart-line-items/add-an-item-to-cart",+ "api-reference/storefront/cart-line-items/set-line-item-quantity",+ "api-reference/storefront/cart-line-items/remove-a-line-item"+ ]+ },+ {+ "group": "Cart / Other",+ "pages": [+ "api-reference/storefront/cart-other/empty-the-cart",+ "api-reference/storefront/cart-other/list-estimated-shipping-rates",+ "api-reference/storefront/cart-other/associate-a-cart-with-a-user",+ "api-reference/storefront/cart-other/change-cart-currency"+ ]+ },+ {+ "group": "Cart / Coupons",+ "pages": [+ "api-reference/storefront/cart-coupons/apply-a-coupon-code",+ "api-reference/storefront/cart-coupons/remove-a-coupon",+ "api-reference/storefront/cart-coupons/remove-all-coupons"+ ]+ },+ {+ "group": "Checkout",+ "pages": [+ "api-reference/storefront/checkout/update-checkout",+ "api-reference/storefront/checkout/validate-order-payment"+ ]+ },+ {+ "group": "Checkout / State",+ "pages": [+ "api-reference/storefront/checkout-state/next-checkout-step",+ "api-reference/storefront/checkout-state/advance-checkout",+ "api-reference/storefront/checkout-state/complete-checkout"+ ]+ },+ {+ "group": "Checkout / Shipments",+ "pages": [+ "api-reference/storefront/checkout-shipments/selects-shipping-method-for-shipments",+ "api-reference/storefront/checkout-shipments/list-shipping-rates"+ ]+ },+ {+ "group": "Checkout / Payments",+ "pages": [+ "api-reference/storefront/checkout-payments/create-new-payment",+ "api-reference/storefront/checkout-payments/list-payment-methods"+ ]+ },+ {+ "group": "Checkout / Store Credit",+ "pages": [+ "api-reference/storefront/checkout-store-credit/add-store-credit",+ "api-reference/storefront/checkout-store-credit/remove-store-credit"+ ]+ },+ {+ "group": "Stripe",+ "pages": [+ "api-reference/storefront/stripe/return-a-stripe-payment-intent",+ "api-reference/storefront/stripe/create-a-stripe-payment-intent",+ "api-reference/storefront/stripe/create-a-stripe-payment-intent-1",+ "api-reference/storefront/stripe/create-a-stripe-setup-intent"+ ]+ },+ {+ "group": "Products",+ "pages": [+ "api-reference/storefront/products/list-all-products",+ "api-reference/storefront/products/retrieve-a-product"+ ]+ },+ {+ "group": "Vendors",+ "pages": [+ "api-reference/storefront/vendors/list-all-vendors-available-on-this-store-marketplace",+ "api-reference/storefront/vendors/retrieve-a-vendor"+ ]+ },+ {+ "group": "Stores",+ "pages": [+ "api-reference/storefront/stores/return-the-current-store"+ ]+ },+ {+ "group": "Taxons",+ "pages": [+ "api-reference/storefront/taxons/list-all-taxons",+ "api-reference/storefront/taxons/retrieve-a-taxon"+ ]+ },+ {+ "group": "Countries",+ "pages": [+ "api-reference/storefront/countries/list-all-countries",+ "api-reference/storefront/countries/retrieve-a-country",+ "api-reference/storefront/countries/get-default-country"+ ]+ },+ {+ "group": "CMS Pages",+ "pages": [+ "api-reference/storefront/cms-pages/list-all-cms-pages",+ "api-reference/storefront/cms-pages/retrieve-a-cms-page"+ ]+ },+ {+ "group": "Menus",+ "pages": [+ "api-reference/storefront/menus/list-all-menus",+ "api-reference/storefront/menus/retrieve-a-menu"+ ]+ },+ {+ "group": "Wishlists",+ "pages": [+ "api-reference/storefront/wishlists/list-all-wishlists",+ "api-reference/storefront/wishlists/create-a-wishlist",+ "api-reference/storefront/wishlists/retrieve-a-wishlist",+ "api-reference/storefront/wishlists/delete-a-wishlist",+ "api-reference/storefront/wishlists/update-a-wishlist",+ "api-reference/storefront/wishlists/retrieve-the-default-wishlist"+ ]+ },+ {+ "group": "Wishlists / Wished Items",+ "pages": [+ "api-reference/storefront/wishlists-wished-items/add-item-to-wishlist",+ "api-reference/storefront/wishlists-wished-items/add-items-to-wishlist",+ "api-reference/storefront/wishlists-wished-items/set-wished-item-quantity",+ "api-reference/storefront/wishlists-wished-items/delete-item-from-wishlist",+ "api-reference/storefront/wishlists-wished-items/delete-items-from-wishlist"+ ]+ },+ {+ "group": "Digital Downloads",+ "pages": [+ "api-reference/storefront/digital-downloads/download-a-digital-asset"+ ]+ }+ ]+ },+ {+ "group": "Platform API",+ "pages": [+ "api-reference/platform/authentication",+ {+ "group": "Addresses",+ "pages": [+ "api-reference/platform/addresses/return-a-list-of-addresses",+ "api-reference/platform/addresses/create-an-address",+ "api-reference/platform/addresses/return-an-address",+ "api-reference/platform/addresses/delete-an-address",+ "api-reference/platform/addresses/update-an-address"+ ]+ },+ {+ "group": "Adjustments",+ "pages": [+ "api-reference/platform/adjustments/return-a-list-of-adjustments",+ "api-reference/platform/adjustments/create-an-adjustment",+ "api-reference/platform/adjustments/return-an-adjustment",+ "api-reference/platform/adjustments/delete-an-adjustment",+ "api-reference/platform/adjustments/update-an-adjustment"+ ]+ },+ {+ "group": "Classifications",+ "pages": [+ "api-reference/platform/classifications/return-a-list-of-classifications",+ "api-reference/platform/classifications/create-a-classification",+ "api-reference/platform/classifications/return-a-classification",+ "api-reference/platform/classifications/delete-a-classification",+ "api-reference/platform/classifications/update-a-classification"+ ]+ },+ {+ "group": "CMS Pages",+ "pages": [+ "api-reference/platform/cms-pages/return-a-list-of-cms-pages",+ "api-reference/platform/cms-pages/create-a-cms-page",+ "api-reference/platform/cms-pages/return-a-cms-page",+ "api-reference/platform/cms-pages/delete-a-cms-page",+ "api-reference/platform/cms-pages/update-a-cms-page"+ ]+ },+ {+ "group": "CMS Sections",+ "pages": [+ "api-reference/platform/cms-sections/return-a-list-of-cms-sections",+ "api-reference/platform/cms-sections/create-a-cms-section",+ "api-reference/platform/cms-sections/return-a-cms-section",+ "api-reference/platform/cms-sections/delete-a-cms-section",+ "api-reference/platform/cms-sections/update-a-cms-section"+ ]+ },+ {+ "group": "Countries",+ "pages": [+ "api-reference/platform/countries/returns-a-list-of-countries",+ "api-reference/platform/countries/returns-a-country"+ ]+ },+ {+ "group": "Data Feeds",+ "pages": [+ "api-reference/platform/data-feeds/return-a-list-of-data-feeds",+ "api-reference/platform/data-feeds/create-a-data-feed",+ "api-reference/platform/data-feeds/return-a-data-feed",+ "api-reference/platform/data-feeds/delete-a-data-feed",+ "api-reference/platform/data-feeds/update-a-data-feed"+ ]+ },+ {+ "group": "Digital Links",+ "pages": [+ "api-reference/platform/digital-links/return-a-list-of-digital-links",+ "api-reference/platform/digital-links/create-a-digital-link",+ "api-reference/platform/digital-links/return-a-digital-link",+ "api-reference/platform/digital-links/delete-a-digital-link",+ "api-reference/platform/digital-links/update-a-digital-link",+ "api-reference/platform/digital-links/reset-a-digital-link"+ ]+ },+ {+ "group": "Digital Assets",+ "pages": [+ "api-reference/platform/digital-assets/return-a-list-of-digital-assets",+ "api-reference/platform/digital-assets/create-a-digital-asset",+ "api-reference/platform/digital-assets/return-a-digital-asset",+ "api-reference/platform/digital-assets/delete-a-digital-asset",+ "api-reference/platform/digital-assets/update-a-digital-asset"+ ]+ },+ {+ "group": "Line Items",+ "pages": [+ "api-reference/platform/line-items/return-a-list-of-line-items",+ "api-reference/platform/line-items/create-a-line-item",+ "api-reference/platform/line-items/return-a-line-item",+ "api-reference/platform/line-items/delete-a-line-item",+ "api-reference/platform/line-items/update-a-line-item"+ ]+ },+ {+ "group": "Menu Items",+ "pages": [+ "api-reference/platform/menu-items/return-a-list-of-menu-items",+ "api-reference/platform/menu-items/create-a-menu-item",+ "api-reference/platform/menu-items/return-a-menu-item",+ "api-reference/platform/menu-items/delete-a-menu-item",+ "api-reference/platform/menu-items/update-a-menu-item",+ "api-reference/platform/menu-items/reposition-a-menu-item"+ ]+ },+ {+ "group": "Menus",+ "pages": [+ "api-reference/platform/menus/return-a-list-of-menus",+ "api-reference/platform/menus/create-a-menu",+ "api-reference/platform/menus/return-a-menu",+ "api-reference/platform/menus/delete-a-menu",+ "api-reference/platform/menus/update-a-menu"+ ]+ },+ {+ "group": "Option Types",+ "pages": [+ "api-reference/platform/option-types/return-a-list-of-option-types",+ "api-reference/platform/option-types/create-an-option-type",+ "api-reference/platform/option-types/return-an-option-type",+ "api-reference/platform/option-types/delete-an-option-type",+ "api-reference/platform/option-types/update-an-option-type"+ ]+ },+ {+ "group": "Option Values",+ "pages": [+ "api-reference/platform/option-values/return-a-list-of-option-values",+ "api-reference/platform/option-values/create-an-option-value",+ "api-reference/platform/option-values/return-an-option-value",+ "api-reference/platform/option-values/delete-an-option-value",+ "api-reference/platform/option-values/update-an-option-value"+ ]+ },+ {+ "group": "Orders",+ "pages": [+ "api-reference/platform/orders/return-a-list-of-orders",+ "api-reference/platform/orders/creates-an-order",+ "api-reference/platform/orders/return-an-order",+ "api-reference/platform/orders/delete-an-order",+ "api-reference/platform/orders/update-an-order",+ "api-reference/platform/orders/advances-an-order",+ "api-reference/platform/orders/next-an-order",+ "api-reference/platform/orders/completes-an-order",+ "api-reference/platform/orders/empties-an-order",+ "api-reference/platform/orders/approves-an-order",+ "api-reference/platform/orders/cancels-an-order",+ "api-reference/platform/orders/use-store-credit-for-an-order",+ "api-reference/platform/orders/apply-coupon-code-for-an-order"+ ]+ },+ {+ "group": "Payment Methods",+ "pages": [+ "api-reference/platform/payment-methods/return-a-list-of-payment-methods",+ "api-reference/platform/payment-methods/create-a-payment-method",+ "api-reference/platform/payment-methods/return-a-payment-method",+ "api-reference/platform/payment-methods/delete-a-payment-method",+ "api-reference/platform/payment-methods/update-a-payment-method"+ ]+ },+ {+ "group": "Payments",+ "pages": [+ "api-reference/platform/payments/return-a-list-of-payments",+ "api-reference/platform/payments/return-a-payment",+ "api-reference/platform/payments/delete-a-payment"+ ]+ },+ {+ "group": "Products",+ "pages": [+ "api-reference/platform/products/return-a-list-of-products",+ "api-reference/platform/products/create-a-product",+ "api-reference/platform/products/return-a-product",+ "api-reference/platform/products/delete-a-product",+ "api-reference/platform/products/update-a-product"+ ]+ },+ {+ "group": "Promotion Actions",+ "pages": [+ "api-reference/platform/promotion-actions/return-a-list-of-promotion-actions",+ "api-reference/platform/promotion-actions/create-a-promotion-action",+ "api-reference/platform/promotion-actions/return-a-promotion-action",+ "api-reference/platform/promotion-actions/delete-a-promotion-action",+ "api-reference/platform/promotion-actions/update-a-promotion-action"+ ]+ },+ {+ "group": "Promotion Categories",+ "pages": [+ "api-reference/platform/promotion-categories/return-a-list-of-promotion-categories",+ "api-reference/platform/promotion-categories/create-a-promotion-category",+ "api-reference/platform/promotion-categories/return-a-promotion-category",+ "api-reference/platform/promotion-categories/delete-a-promotion-category",+ "api-reference/platform/promotion-categories/update-a-promotion-category"+ ]+ },+ {+ "group": "Promotion Rules",+ "pages": [+ "api-reference/platform/promotion-rules/return-a-list-of-promotion-rules",+ "api-reference/platform/promotion-rules/create-a-promotion-rule",+ "api-reference/platform/promotion-rules/return-a-promotion-rule",+ "api-reference/platform/promotion-rules/delete-a-promotion-rule",+ "api-reference/platform/promotion-rules/update-a-promotion-rule"+ ]+ },+ {+ "group": "Promotions",+ "pages": [+ "api-reference/platform/promotions/return-a-list-of-promotions",+ "api-reference/platform/promotions/create-a-promotion",+ "api-reference/platform/promotions/return-a-promotion",+ "api-reference/platform/promotions/delete-a-promotion",+ "api-reference/platform/promotions/update-a-promotion"+ ]+ },+ {+ "group": "Roles",+ "pages": [+ "api-reference/platform/roles/return-a-list-of-roles",+ "api-reference/platform/roles/create-a-role",+ "api-reference/platform/roles/return-a-role",+ "api-reference/platform/roles/delete-a-role",+ "api-reference/platform/roles/update-a-role"+ ]+ },+ {+ "group": "Shipments",+ "pages": [+ "api-reference/platform/shipments/return-a-list-of-shipments",+ "api-reference/platform/shipments/create-a-shipment",+ "api-reference/platform/shipments/return-a-shipment",+ "api-reference/platform/shipments/delete-a-shipment",+ "api-reference/platform/shipments/update-a-shipment",+ "api-reference/platform/shipments/adds-item-variant-to-an-existing-shipment",+ "api-reference/platform/shipments/removes-item-variant-from-shipment",+ "api-reference/platform/shipments/mark-shipment-as-ready-to-be-shipped",+ "api-reference/platform/shipments/mark-shipment-as-shipped",+ "api-reference/platform/shipments/cancels-the-shipment",+ "api-reference/platform/shipments/resumes-the-shipment",+ "api-reference/platform/shipments/moves-shipment-back-to-pending-state"+ ]+ },+ {+ "group": "Shipping Categories",+ "pages": [+ "api-reference/platform/shipping-categories/return-a-list-of-shipping-categories",+ "api-reference/platform/shipping-categories/create-a-shipping-category",+ "api-reference/platform/shipping-categories/return-a-shipping-category",+ "api-reference/platform/shipping-categories/delete-a-shipping-category",+ "api-reference/platform/shipping-categories/update-a-shipping-category"+ ]+ },+ {+ "group": "Shipping Methods",+ "pages": [+ "api-reference/platform/shipping-methods/return-a-list-of-shipping-methods",+ "api-reference/platform/shipping-methods/create-a-shipping-method",+ "api-reference/platform/shipping-methods/return-a-shipping-method",+ "api-reference/platform/shipping-methods/delete-a-shipping-method",+ "api-reference/platform/shipping-methods/update-a-shipping-method"+ ]+ },+ {+ "group": "States",+ "pages": [+ "api-reference/platform/states/returns-a-list-of-states",+ "api-reference/platform/states/returns-a-state"+ ]+ },+ {+ "group": "Stock Items",+ "pages": [+ "api-reference/platform/stock-items/return-a-list-of-stock-items",+ "api-reference/platform/stock-items/create-a-stock-item",+ "api-reference/platform/stock-items/return-a-stock-item",+ "api-reference/platform/stock-items/delete-a-stock-item",+ "api-reference/platform/stock-items/update-a-stock-item"+ ]+ },+ {+ "group": "Stock Locations",+ "pages": [+ "api-reference/platform/stock-locations/return-a-list-of-stock-locations",+ "api-reference/platform/stock-locations/create-a-stock-location",+ "api-reference/platform/stock-locations/return-a-stock-location",+ "api-reference/platform/stock-locations/delete-a-stock-location",+ "api-reference/platform/stock-locations/update-a-stock-location"+ ]+ },+ {+ "group": "Store Credit Categories",+ "pages": [+ "api-reference/platform/store-credit-categories/return-a-list-of-store-credit-categories",+ "api-reference/platform/store-credit-categories/create-a-store-credit-category",+ "api-reference/platform/store-credit-categories/return-a-store-credit-category",+ "api-reference/platform/store-credit-categories/delete-a-store-credit-category",+ "api-reference/platform/store-credit-categories/update-a-store-credit-category"+ ]+ },+ {+ "group": "Store Credit Types",+ "pages": [+ "api-reference/platform/store-credit-types/return-a-list-of-store-credit-types",+ "api-reference/platform/store-credit-types/create-a-store-credit-type",+ "api-reference/platform/store-credit-types/return-a-store-credit-type",+ "api-reference/platform/store-credit-types/delete-a-store-credit-type",+ "api-reference/platform/store-credit-types/update-a-store-credit-type"+ ]+ },+ {+ "group": "Store Credits",+ "pages": [+ "api-reference/platform/store-credits/return-a-list-of-store-credits",+ "api-reference/platform/store-credits/create-a-store-credit",+ "api-reference/platform/store-credits/return-a-store-credit",+ "api-reference/platform/store-credits/delete-a-store-credit",+ "api-reference/platform/store-credits/update-a-store-credit"+ ]+ },+ {+ "group": "Tax Categories",+ "pages": [+ "api-reference/platform/tax-categories/return-a-list-of-tax-categories",+ "api-reference/platform/tax-categories/create-a-tax-category",+ "api-reference/platform/tax-categories/return-a-tax-category",+ "api-reference/platform/tax-categories/delete-a-tax-category",+ "api-reference/platform/tax-categories/update-a-tax-category"+ ]+ },+ {+ "group": "Tax Rates",+ "pages": [+ "api-reference/platform/tax-rates/return-a-list-of-tax-rates",+ "api-reference/platform/tax-rates/create-a-tax-rate",+ "api-reference/platform/tax-rates/return-a-tax-rate",+ "api-reference/platform/tax-rates/delete-a-tax-rate",+ "api-reference/platform/tax-rates/update-a-tax-rate"+ ]+ },+ {+ "group": "Taxonomies",+ "pages": [+ "api-reference/platform/taxonomies/return-a-list-of-taxonomies",+ "api-reference/platform/taxonomies/create-a-taxonomy",+ "api-reference/platform/taxonomies/return-a-taxonomy",+ "api-reference/platform/taxonomies/delete-a-taxonomy",+ "api-reference/platform/taxonomies/update-a-taxonomy"+ ]+ },+ {+ "group": "Taxons",+ "pages": [+ "api-reference/platform/taxons/return-a-list-of-taxons",+ "api-reference/platform/taxons/create-a-taxon",+ "api-reference/platform/taxons/return-a-taxon",+ "api-reference/platform/taxons/delete-a-taxon",+ "api-reference/platform/taxons/update-a-taxon",+ "api-reference/platform/taxons/reposition-a-taxon"+ ]+ },+ {+ "group": "Users",+ "pages": [+ "api-reference/platform/users/return-a-list-of-users",+ "api-reference/platform/users/create-a-user",+ "api-reference/platform/users/return-a-user",+ "api-reference/platform/users/delete-a-user",+ "api-reference/platform/users/update-a-user"+ ]+ },+ {+ "group": "Variants",+ "pages": [+ "api-reference/platform/variants/return-a-list-of-variants",+ "api-reference/platform/variants/return-a-variant",+ "api-reference/platform/variants/delete-a-variant"+ ]+ },+ {+ "group": "Vendors",+ "pages": [+ "api-reference/platform/vendors/return-a-list-of-vendors",+ "api-reference/platform/vendors/create-a-vendor",+ "api-reference/platform/vendors/return-a-vendor",+ "api-reference/platform/vendors/delete-a-vendor",+ "api-reference/platform/vendors/update-a-vendor",+ "api-reference/platform/vendors/invites-vendor-to-the-platform",+ "api-reference/platform/vendors/start-onboarding-process",+ "api-reference/platform/vendors/completes-onboarding-process",+ "api-reference/platform/vendors/approves-vendor",+ "api-reference/platform/vendors/rejects-vendor",+ "api-reference/platform/vendors/suspends-vendor"+ ]+ },+ {+ "group": "Webhook Events",+ "pages": [+ "api-reference/platform/webhook-events/return-a-list-of-webhook-events"+ ]+ },+ {+ "group": "Webhook Subscribers",+ "pages": [+ "api-reference/platform/webhook-subscribers/return-a-list-of-webhook-subscribers",+ "api-reference/platform/webhook-subscribers/create-a-webhook-subscriber",+ "api-reference/platform/webhook-subscribers/return-a-webhook-subscriber",+ "api-reference/platform/webhook-subscribers/delete-a-webhook-subscriber",+ "api-reference/platform/webhook-subscribers/update-a-webhook-subscriber"+ ]+ },+ {+ "group": "Wished Items",+ "pages": [+ "api-reference/platform/wished-items/return-a-list-of-wished-items",+ "api-reference/platform/wished-items/create-a-wished-item",+ "api-reference/platform/wished-items/return-a-wished-item",+ "api-reference/platform/wished-items/delete-a-wished-item",+ "api-reference/platform/wished-items/update-a-wished-item"+ ]+ },+ {+ "group": "Wishlists",+ "pages": [+ "api-reference/platform/wishlists/return-a-list-of-wishlists",+ "api-reference/platform/wishlists/create-a-wishlist",+ "api-reference/platform/wishlists/return-a-wishlist",+ "api-reference/platform/wishlists/delete-a-wishlist",+ "api-reference/platform/wishlists/update-a-wishlist"+ ]+ },+ {+ "group": "Zones",+ "pages": [+ "api-reference/platform/zones/return-a-list-of-zones",+ "api-reference/platform/zones/create-a-zone",+ "api-reference/platform/zones/return-a-zone",+ "api-reference/platform/zones/delete-a-zone",+ "api-reference/platform/zones/update-a-zone"+ ]+ }+ ]+ }+ ]+ },+ {+ "tab": "User Docs",+ "groups": [+ {+ "group": "Introduction",+ "pages": [+ "user/what-is-spree-commerce",+ "user/using-spree",+ "user/user-quickstart-guide"+ ]+ },+ {+ "group": "Products",+ "pages": [+ {+ "group": "Create & Edit Products",+ "pages": [+ "user/products/creating-products",+ "user/products/deleting-products",+ "user/products/editing-products",+ "user/products/editing-multi-variant-products",+ "user/products/cloning-products"+ ]+ },+ {+ "group": "Manage Products",+ "pages": [+ "user/manage-products/search-products",+ "user/manage-products/bulk-product-operations",+ "user/manage-products/import-products",+ "user/manage-products/product-import-file-template",+ "user/manage-products/export-products",+ "user/manage-products/stock-levels",+ "user/manage-products/stock-transfers",+ "user/manage-products/product-taxonomies",+ "user/manage-products/product-options",+ "user/manage-products/product-properties"+ ]+ }+ ]+ },+ {+ "group": "Orders",+ "pages": [+ "user/orders/order-states",+ "user/orders/processing-orders",+ "user/orders/creating-orders",+ "user/orders/editing-orders",+ "user/orders/exporting-orders",+ "user/orders/cancelling-orders",+ "user/orders/refunding-orders",+ "user/orders/searching-orders"+ ]+ },+ {+ "group": "Storefront",+ "pages": [+ {+ "group": "Storefront Themes",+ "pages": [+ "user/storefront/theme-editor",+ "user/storefront/create-new-theme",+ "user/storefront/delete-theme"+ ]+ },+ {+ "group": "Storefront Pages",+ "pages": [+ "user/storefront/create-page",+ "user/storefront/edit-page",+ "user/storefront/delete-page"+ ]+ },+ {+ "group": "Storefront Posts",+ "pages": [+ "user/storefront/create-post",+ "user/storefront/edit-post",+ "user/storefront/search-posts",+ "user/storefront/delete-post",+ "user/storefront/import-posts"+ ]+ },+ "user/storefront/storefront-settings",+ "user/storefront/create-new-store"+ ]+ }+ ]+ }+ ]+ },+ {+ "version": "v4",+ "tabs": [+ {+ "tab": "Developer Docs",+ "groups": [+ {+ "group": "Getting started",+ "pages": [+ "developer/getting-started/quickstart"+ ]+ },+ {+ "group": "Core Concepts",+ "pages": [+ "developer/core-concepts/architecture",+ "developer/core-concepts/stores",+ "developer/core-concepts/orders",+ "developer/core-concepts/users",+ "developer/core-concepts/products",+ "developer/core-concepts/inventory",+ "developer/core-concepts/payments",+ "developer/core-concepts/taxes",+ "developer/core-concepts/promotions",+ "developer/core-concepts/shipments",+ "developer/core-concepts/addresses",+ "developer/core-concepts/i18n",+ "developer/core-concepts/preferences"+ ]+ },+ {+ "group": "Customizing Spree",+ "pages": [+ "developer/customization/quickstart",+ "developer/customization/v4/authentication",+ "developer/customization/v4/images",+ "developer/customization/v4/checkout",+ "developer/customization/v4/admin-panel",+ "developer/customization/v4/storefront",+ "developer/customization/v4/deface",+ "developer/customization/permissions",+ "developer/customization/dependencies",+ "developer/customization/decorators",+ "developer/customization/routes"+ ]+ },+ {+ "group": "Extending Spree",+ "pages": [+ "developer/extending-spree/promotions",+ "developer/customization/extensions"+ ]+ },+ {+ "group": "Deployment",+ "pages": [+ "developer/deployment/render",+ "developer/deployment/docker",+ "developer/deployment/assets",+ "developer/deployment/cdn",+ "developer/deployment/caching"+ ]+ },+ {+ "group": "Upgrading",+ "pages": [+ "developer/upgrades/quickstart",+ {+ "group": "Upgrade Guides",+ "pages": [+ "developer/upgrades/4.8-to-4.9",+ "developer/upgrades/4.x-to-4.8",+ "developer/upgrades/4.6-to-4.7",+ "developer/upgrades/4.5-to-4.6",+ "developer/upgrades/4.4-to-4.5",+ "developer/upgrades/4.3-to-4.4",+ "developer/upgrades/4.2-to-4.3",+ "developer/upgrades/4.1-to-4.2",+ "developer/upgrades/4.0-to-4.1",+ "developer/upgrades/3.7-to-4.0",+ "developer/upgrades/3.6-to-3.7",+ "developer/upgrades/3.5-to-3.6",+ "developer/upgrades/3.4-to-3.5",+ "developer/upgrades/3.3-to-3.4",+ "developer/upgrades/3.2-to-3.3",+ "developer/upgrades/3.1-to-3.2",+ "developer/upgrades/3.0-to-3.1",+ "developer/upgrades/2.3-to-2.4",+ "developer/upgrades/2.2-to-2.3",+ "developer/upgrades/2.1-to-2.2",+ "developer/upgrades/2.0-to-2.1"+ ]+ }+ ]+ },+ {+ "group": "Contributing",+ "pages": [+ "developer/contributing/quickstart",+ "developer/contributing/developing-spree",+ "developer/contributing/creating-an-extension"+ ]+ },+ {+ "group": "Security",+ "pages": [+ "developer/security/security_policy",+ "developer/security/pci_compliance"+ ]+ },+ {+ "group": "Advanced",+ "pages": [+ "developer/advanced/adding_spree_to_rails_app"+ ]+ }+ ]+ },+ {+ "tab": "Ecommerce API",+ "groups": [+ {+ "group": "API basics",+ "pages": [+ "api-reference/introduction",+ "api-reference/pagination",+ "api-reference/filtering-and-sorting",+ "api-reference/fetching-multiple-resources"+ ]+ },+ {+ "group": "Storefront API",+ "pages": [+ "api-reference/storefront/authentication",+ {+ "group": "Account",+ "pages": [+ "api-reference/storefront/account/retrieve-an-account",+ "api-reference/storefront/account/create-an-account",+ "api-reference/storefront/account/update-an-account"+ ]+ },+ {+ "group": "Account / Address",+ "pages": [+ "api-reference/storefront/account-address/list-all-addresses",+ "api-reference/storefront/account-address/create-an-address",+ "api-reference/storefront/account-address/remove-an-address",+ "api-reference/storefront/account-address/update-an-address"+ ]+ },+ {+ "group": "Account / Credit Cards",+ "pages": [+ "api-reference/storefront/account-credit-cards/list-all-credit-cards",+ "api-reference/storefront/account-credit-cards/remove-a-credit-card",+ "api-reference/storefront/account-credit-cards/retrieve-the-default-credit-card"+ ]+ },+ {+ "group": "Account / Orders",+ "pages": [+ "api-reference/storefront/account-orders/list-all-orders",+ "api-reference/storefront/account-orders/retrieve-an-order"+ ]+ },+ {+ "group": "Order Status",+ "pages": [+ "api-reference/storefront/order-status/retrieve-an-order-status"+ ]+ },+ {+ "group": "Cart",+ "pages": [+ "api-reference/storefront/cart/retrieve-a-cart",+ "api-reference/storefront/cart/create-a-cart",+ "api-reference/storefront/cart/delete-a-cart"+ ]+ },+ {+ "group": "Cart / Line Items",+ "pages": [+ "api-reference/storefront/cart-line-items/add-an-item-to-cart",+ "api-reference/storefront/cart-line-items/set-line-item-quantity",+ "api-reference/storefront/cart-line-items/remove-a-line-item"+ ]+ },+ {+ "group": "Cart / Other",+ "pages": [+ "api-reference/storefront/cart-other/empty-the-cart",+ "api-reference/storefront/cart-other/list-estimated-shipping-rates",+ "api-reference/storefront/cart-other/associate-a-cart-with-a-user",+ "api-reference/storefront/cart-other/change-cart-currency"+ ]+ },+ {+ "group": "Cart / Coupons",+ "pages": [+ "api-reference/storefront/cart-coupons/apply-a-coupon-code",+ "api-reference/storefront/cart-coupons/remove-a-coupon",+ "api-reference/storefront/cart-coupons/remove-all-coupons"+ ]+ },+ {+ "group": "Checkout",+ "pages": [+ "api-reference/storefront/checkout/update-checkout",+ "api-reference/storefront/checkout/validate-order-payment"+ ]+ },+ {+ "group": "Checkout / State",+ "pages": [+ "api-reference/storefront/checkout-state/next-checkout-step",+ "api-reference/storefront/checkout-state/advance-checkout",+ "api-reference/storefront/checkout-state/complete-checkout"+ ]+ },+ {+ "group": "Checkout / Shipments",+ "pages": [+ "api-reference/storefront/checkout-shipments/selects-shipping-method-for-shipments",+ "api-reference/storefront/checkout-shipments/list-shipping-rates"+ ]+ },+ {+ "group": "Checkout / Payments",+ "pages": [+ "api-reference/storefront/checkout-payments/create-new-payment",+ "api-reference/storefront/checkout-payments/list-payment-methods"+ ]+ },+ {+ "group": "Checkout / Store Credit",+ "pages": [+ "api-reference/storefront/checkout-store-credit/add-store-credit",+ "api-reference/storefront/checkout-store-credit/remove-store-credit"+ ]+ },+ {+ "group": "Stripe",+ "pages": [+ "api-reference/storefront/stripe/return-a-stripe-payment-intent",+ "api-reference/storefront/stripe/create-a-stripe-payment-intent",+ "api-reference/storefront/stripe/create-a-stripe-payment-intent-1",+ "api-reference/storefront/stripe/create-a-stripe-setup-intent"+ ]+ },+ {+ "group": "Products",+ "pages": [+ "api-reference/storefront/products/list-all-products",+ "api-reference/storefront/products/retrieve-a-product"+ ]+ },+ {+ "group": "Vendors",+ "pages": [+ "api-reference/storefront/vendors/list-all-vendors-available-on-this-store-marketplace",+ "api-reference/storefront/vendors/retrieve-a-vendor"+ ]+ },+ {+ "group": "Stores",+ "pages": [+ "api-reference/storefront/stores/return-the-current-store"+ ]+ },+ {+ "group": "Taxons",+ "pages": [+ "api-reference/storefront/taxons/list-all-taxons",+ "api-reference/storefront/taxons/retrieve-a-taxon"+ ]+ },+ {+ "group": "Countries",+ "pages": [+ "api-reference/storefront/countries/list-all-countries",+ "api-reference/storefront/countries/retrieve-a-country",+ "api-reference/storefront/countries/get-default-country"+ ]+ },+ {+ "group": "CMS Pages",+ "pages": [+ "api-reference/storefront/cms-pages/list-all-cms-pages",+ "api-reference/storefront/cms-pages/retrieve-a-cms-page"+ ]+ },+ {+ "group": "Menus",+ "pages": [+ "api-reference/storefront/menus/list-all-menus",+ "api-reference/storefront/menus/retrieve-a-menu"+ ]+ },+ {+ "group": "Wishlists",+ "pages": [+ "api-reference/storefront/wishlists/list-all-wishlists",+ "api-reference/storefront/wishlists/create-a-wishlist",+ "api-reference/storefront/wishlists/retrieve-a-wishlist",+ "api-reference/storefront/wishlists/delete-a-wishlist",+ "api-reference/storefront/wishlists/update-a-wishlist",+ "api-reference/storefront/wishlists/retrieve-the-default-wishlist"+ ]+ },+ {+ "group": "Wishlists / Wished Items",+ "pages": [+ "api-reference/storefront/wishlists-wished-items/add-item-to-wishlist",+ "api-reference/storefront/wishlists-wished-items/add-items-to-wishlist",+ "api-reference/storefront/wishlists-wished-items/set-wished-item-quantity",+ "api-reference/storefront/wishlists-wished-items/delete-item-from-wishlist",+ "api-reference/storefront/wishlists-wished-items/delete-items-from-wishlist"+ ]+ },+ {+ "group": "Digital Downloads",+ "pages": [+ "api-reference/storefront/digital-downloads/download-a-digital-asset"+ ]+ }+ ]+ },+ {+ "group": "Platform API",+ "pages": [+ "api-reference/platform/authentication",+ {+ "group": "Addresses",+ "pages": [+ "api-reference/platform/addresses/return-a-list-of-addresses",+ "api-reference/platform/addresses/create-an-address",+ "api-reference/platform/addresses/return-an-address",+ "api-reference/platform/addresses/delete-an-address",+ "api-reference/platform/addresses/update-an-address"+ ]+ },+ {+ "group": "Adjustments",+ "pages": [+ "api-reference/platform/adjustments/return-a-list-of-adjustments",+ "api-reference/platform/adjustments/create-an-adjustment",+ "api-reference/platform/adjustments/return-an-adjustment",+ "api-reference/platform/adjustments/delete-an-adjustment",+ "api-reference/platform/adjustments/update-an-adjustment"+ ]+ },+ {+ "group": "Classifications",+ "pages": [+ "api-reference/platform/classifications/return-a-list-of-classifications",+ "api-reference/platform/classifications/create-a-classification",+ "api-reference/platform/classifications/return-a-classification",+ "api-reference/platform/classifications/delete-a-classification",+ "api-reference/platform/classifications/update-a-classification"+ ]+ },+ {+ "group": "CMS Pages",+ "pages": [+ "api-reference/platform/cms-pages/return-a-list-of-cms-pages",+ "api-reference/platform/cms-pages/create-a-cms-page",+ "api-reference/platform/cms-pages/return-a-cms-page",+ "api-reference/platform/cms-pages/delete-a-cms-page",+ "api-reference/platform/cms-pages/update-a-cms-page"+ ]+ },+ {+ "group": "CMS Sections",+ "pages": [+ "api-reference/platform/cms-sections/return-a-list-of-cms-sections",+ "api-reference/platform/cms-sections/create-a-cms-section",+ "api-reference/platform/cms-sections/return-a-cms-section",+ "api-reference/platform/cms-sections/delete-a-cms-section",+ "api-reference/platform/cms-sections/update-a-cms-section"+ ]+ },+ {+ "group": "Countries",+ "pages": [+ "api-reference/platform/countries/returns-a-list-of-countries",+ "api-reference/platform/countries/returns-a-country"+ ]+ },+ {+ "group": "Data Feeds",+ "pages": [+ "api-reference/platform/data-feeds/return-a-list-of-data-feeds",+ "api-reference/platform/data-feeds/create-a-data-feed",+ "api-reference/platform/data-feeds/return-a-data-feed",+ "api-reference/platform/data-feeds/delete-a-data-feed",+ "api-reference/platform/data-feeds/update-a-data-feed"+ ]+ },+ {+ "group": "Digital Links",+ "pages": [+ "api-reference/platform/digital-links/return-a-list-of-digital-links",+ "api-reference/platform/digital-links/create-a-digital-link",+ "api-reference/platform/digital-links/return-a-digital-link",+ "api-reference/platform/digital-links/delete-a-digital-link",+ "api-reference/platform/digital-links/update-a-digital-link",+ "api-reference/platform/digital-links/reset-a-digital-link"+ ]+ },+ {+ "group": "Digital Assets",+ "pages": [+ "api-reference/platform/digital-assets/return-a-list-of-digital-assets",+ "api-reference/platform/digital-assets/create-a-digital-asset",+ "api-reference/platform/digital-assets/return-a-digital-asset",+ "api-reference/platform/digital-assets/delete-a-digital-asset",+ "api-reference/platform/digital-assets/update-a-digital-asset"+ ]+ },+ {+ "group": "Line Items",+ "pages": [+ "api-reference/platform/line-items/return-a-list-of-line-items",+ "api-reference/platform/line-items/create-a-line-item",+ "api-reference/platform/line-items/return-a-line-item",+ "api-reference/platform/line-items/delete-a-line-item",+ "api-reference/platform/line-items/update-a-line-item"+ ]+ },+ {+ "group": "Menu Items",+ "pages": [+ "api-reference/platform/menu-items/return-a-list-of-menu-items",+ "api-reference/platform/menu-items/create-a-menu-item",+ "api-reference/platform/menu-items/return-a-menu-item",+ "api-reference/platform/menu-items/delete-a-menu-item",+ "api-reference/platform/menu-items/update-a-menu-item",+ "api-reference/platform/menu-items/reposition-a-menu-item"+ ]+ },+ {+ "group": "Menus",+ "pages": [+ "api-reference/platform/menus/return-a-list-of-menus",+ "api-reference/platform/menus/create-a-menu",+ "api-reference/platform/menus/return-a-menu",+ "api-reference/platform/menus/delete-a-menu",+ "api-reference/platform/menus/update-a-menu"+ ]+ },+ {+ "group": "Option Types",+ "pages": [+ "api-reference/platform/option-types/return-a-list-of-option-types",+ "api-reference/platform/option-types/create-an-option-type",+ "api-reference/platform/option-types/return-an-option-type",+ "api-reference/platform/option-types/delete-an-option-type",+ "api-reference/platform/option-types/update-an-option-type"+ ]+ },+ {+ "group": "Option Values",+ "pages": [+ "api-reference/platform/option-values/return-a-list-of-option-values",+ "api-reference/platform/option-values/create-an-option-value",+ "api-reference/platform/option-values/return-an-option-value",+ "api-reference/platform/option-values/delete-an-option-value",+ "api-reference/platform/option-values/update-an-option-value"+ ]+ },+ {+ "group": "Orders",+ "pages": [+ "api-reference/platform/orders/return-a-list-of-orders",+ "api-reference/platform/orders/creates-an-order",+ "api-reference/platform/orders/return-an-order",+ "api-reference/platform/orders/delete-an-order",+ "api-reference/platform/orders/update-an-order",+ "api-reference/platform/orders/advances-an-order",+ "api-reference/platform/orders/next-an-order",+ "api-reference/platform/orders/completes-an-order",+ "api-reference/platform/orders/empties-an-order",+ "api-reference/platform/orders/approves-an-order",+ "api-reference/platform/orders/cancels-an-order",+ "api-reference/platform/orders/use-store-credit-for-an-order",+ "api-reference/platform/orders/apply-coupon-code-for-an-order"+ ]+ },+ {+ "group": "Payment Methods",+ "pages": [+ "api-reference/platform/payment-methods/return-a-list-of-payment-methods",+ "api-reference/platform/payment-methods/create-a-payment-method",+ "api-reference/platform/payment-methods/return-a-payment-method",+ "api-reference/platform/payment-methods/delete-a-payment-method",+ "api-reference/platform/payment-methods/update-a-payment-method"+ ]+ },+ {+ "group": "Payments",+ "pages": [+ "api-reference/platform/payments/return-a-list-of-payments",+ "api-reference/platform/payments/return-a-payment",+ "api-reference/platform/payments/delete-a-payment"+ ]+ },+ {+ "group": "Products",+ "pages": [+ "api-reference/platform/products/return-a-list-of-products",+ "api-reference/platform/products/create-a-product",+ "api-reference/platform/products/return-a-product",+ "api-reference/platform/products/delete-a-product",+ "api-reference/platform/products/update-a-product"+ ]+ },+ {+ "group": "Promotion Actions",+ "pages": [+ "api-reference/platform/promotion-actions/return-a-list-of-promotion-actions",+ "api-reference/platform/promotion-actions/create-a-promotion-action",+ "api-reference/platform/promotion-actions/return-a-promotion-action",+ "api-reference/platform/promotion-actions/delete-a-promotion-action",+ "api-reference/platform/promotion-actions/update-a-promotion-action"+ ]+ },+ {+ "group": "Promotion Categories",+ "pages": [+ "api-reference/platform/promotion-categories/return-a-list-of-promotion-categories",+ "api-reference/platform/promotion-categories/create-a-promotion-category",+ "api-reference/platform/promotion-categories/return-a-promotion-category",+ "api-reference/platform/promotion-categories/delete-a-promotion-category",+ "api-reference/platform/promotion-categories/update-a-promotion-category"+ ]+ },+ {+ "group": "Promotion Rules",+ "pages": [+ "api-reference/platform/promotion-rules/return-a-list-of-promotion-rules",+ "api-reference/platform/promotion-rules/create-a-promotion-rule",+ "api-reference/platform/promotion-rules/return-a-promotion-rule",+ "api-reference/platform/promotion-rules/delete-a-promotion-rule",+ "api-reference/platform/promotion-rules/update-a-promotion-rule"+ ]+ },+ {+ "group": "Promotions",+ "pages": [+ "api-reference/platform/promotions/return-a-list-of-promotions",+ "api-reference/platform/promotions/create-a-promotion",+ "api-reference/platform/promotions/return-a-promotion",+ "api-reference/platform/promotions/delete-a-promotion",+ "api-reference/platform/promotions/update-a-promotion"+ ]+ },+ {+ "group": "Roles",+ "pages": [+ "api-reference/platform/roles/return-a-list-of-roles",+ "api-reference/platform/roles/create-a-role",+ "api-reference/platform/roles/return-a-role",+ "api-reference/platform/roles/delete-a-role",+ "api-reference/platform/roles/update-a-role"+ ]+ },+ {+ "group": "Shipments",+ "pages": [+ "api-reference/platform/shipments/return-a-list-of-shipments",+ "api-reference/platform/shipments/create-a-shipment",+ "api-reference/platform/shipments/return-a-shipment",+ "api-reference/platform/shipments/delete-a-shipment",+ "api-reference/platform/shipments/update-a-shipment",+ "api-reference/platform/shipments/adds-item-variant-to-an-existing-shipment",+ "api-reference/platform/shipments/removes-item-variant-from-shipment",+ "api-reference/platform/shipments/mark-shipment-as-ready-to-be-shipped",+ "api-reference/platform/shipments/mark-shipment-as-shipped",+ "api-reference/platform/shipments/cancels-the-shipment",+ "api-reference/platform/shipments/resumes-the-shipment",+ "api-reference/platform/shipments/moves-shipment-back-to-pending-state"+ ]+ },+ {+ "group": "Shipping Categories",+ "pages": [+ "api-reference/platform/shipping-categories/return-a-list-of-shipping-categories",+ "api-reference/platform/shipping-categories/create-a-shipping-category",+ "api-reference/platform/shipping-categories/return-a-shipping-category",+ "api-reference/platform/shipping-categories/delete-a-shipping-category",+ "api-reference/platform/shipping-categories/update-a-shipping-category"+ ]+ },+ {+ "group": "Shipping Methods",+ "pages": [+ "api-reference/platform/shipping-methods/return-a-list-of-shipping-methods",+ "api-reference/platform/shipping-methods/create-a-shipping-method",+ "api-reference/platform/shipping-methods/return-a-shipping-method",+ "api-reference/platform/shipping-methods/delete-a-shipping-method",+ "api-reference/platform/shipping-methods/update-a-shipping-method"+ ]+ },+ {+ "group": "States",+ "pages": [+ "api-reference/platform/states/returns-a-list-of-states",+ "api-reference/platform/states/returns-a-state"+ ]+ },+ {+ "group": "Stock Items",+ "pages": [+ "api-reference/platform/stock-items/return-a-list-of-stock-items",+ "api-reference/platform/stock-items/create-a-stock-item",+ "api-reference/platform/stock-items/return-a-stock-item",+ "api-reference/platform/stock-items/delete-a-stock-item",+ "api-reference/platform/stock-items/update-a-stock-item"+ ]+ },+ {+ "group": "Stock Locations",+ "pages": [+ "api-reference/platform/stock-locations/return-a-list-of-stock-locations",+ "api-reference/platform/stock-locations/create-a-stock-location",+ "api-reference/platform/stock-locations/return-a-stock-location",+ "api-reference/platform/stock-locations/delete-a-stock-location",+ "api-reference/platform/stock-locations/update-a-stock-location"+ ]+ },+ {+ "group": "Store Credit Categories",+ "pages": [+ "api-reference/platform/store-credit-categories/return-a-list-of-store-credit-categories",+ "api-reference/platform/store-credit-categories/create-a-store-credit-category",+ "api-reference/platform/store-credit-categories/return-a-store-credit-category",+ "api-reference/platform/store-credit-categories/delete-a-store-credit-category",+ "api-reference/platform/store-credit-categories/update-a-store-credit-category"+ ]+ },+ {+ "group": "Store Credit Types",+ "pages": [+ "api-reference/platform/store-credit-types/return-a-list-of-store-credit-types",+ "api-reference/platform/store-credit-types/create-a-store-credit-type",+ "api-reference/platform/store-credit-types/return-a-store-credit-type",+ "api-reference/platform/store-credit-types/delete-a-store-credit-type",+ "api-reference/platform/store-credit-types/update-a-store-credit-type"+ ]+ },+ {+ "group": "Store Credits",+ "pages": [+ "api-reference/platform/store-credits/return-a-list-of-store-credits",+ "api-reference/platform/store-credits/create-a-store-credit",+ "api-reference/platform/store-credits/return-a-store-credit",+ "api-reference/platform/store-credits/delete-a-store-credit",+ "api-reference/platform/store-credits/update-a-store-credit"+ ]+ },+ {+ "group": "Tax Categories",+ "pages": [+ "api-reference/platform/tax-categories/return-a-list-of-tax-categories",+ "api-reference/platform/tax-categories/create-a-tax-category",+ "api-reference/platform/tax-categories/return-a-tax-category",+ "api-reference/platform/tax-categories/delete-a-tax-category",+ "api-reference/platform/tax-categories/update-a-tax-category"+ ]+ },+ {+ "group": "Tax Rates",+ "pages": [+ "api-reference/platform/tax-rates/return-a-list-of-tax-rates",+ "api-reference/platform/tax-rates/create-a-tax-rate",+ "api-reference/platform/tax-rates/return-a-tax-rate",+ "api-reference/platform/tax-rates/delete-a-tax-rate",+ "api-reference/platform/tax-rates/update-a-tax-rate"+ ]+ },+ {+ "group": "Taxonomies",+ "pages": [+ "api-reference/platform/taxonomies/return-a-list-of-taxonomies",+ "api-reference/platform/taxonomies/create-a-taxonomy",+ "api-reference/platform/taxonomies/return-a-taxonomy",+ "api-reference/platform/taxonomies/delete-a-taxonomy",+ "api-reference/platform/taxonomies/update-a-taxonomy"+ ]+ },+ {+ "group": "Taxons",+ "pages": [+ "api-reference/platform/taxons/return-a-list-of-taxons",+ "api-reference/platform/taxons/create-a-taxon",+ "api-reference/platform/taxons/return-a-taxon",+ "api-reference/platform/taxons/delete-a-taxon",+ "api-reference/platform/taxons/update-a-taxon",+ "api-reference/platform/taxons/reposition-a-taxon"+ ]+ },+ {+ "group": "Users",+ "pages": [+ "api-reference/platform/users/return-a-list-of-users",+ "api-reference/platform/users/create-a-user",+ "api-reference/platform/users/return-a-user",+ "api-reference/platform/users/delete-a-user",+ "api-reference/platform/users/update-a-user"+ ]+ },+ {+ "group": "Variants",+ "pages": [+ "api-reference/platform/variants/return-a-list-of-variants",+ "api-reference/platform/variants/return-a-variant",+ "api-reference/platform/variants/delete-a-variant"+ ]+ },+ {+ "group": "Vendors",+ "pages": [+ "api-reference/platform/vendors/return-a-list-of-vendors",+ "api-reference/platform/vendors/create-a-vendor",+ "api-reference/platform/vendors/return-a-vendor",+ "api-reference/platform/vendors/delete-a-vendor",+ "api-reference/platform/vendors/update-a-vendor",+ "api-reference/platform/vendors/invites-vendor-to-the-platform",+ "api-reference/platform/vendors/start-onboarding-process",+ "api-reference/platform/vendors/completes-onboarding-process",+ "api-reference/platform/vendors/approves-vendor",+ "api-reference/platform/vendors/rejects-vendor",+ "api-reference/platform/vendors/suspends-vendor"+ ]+ },+ {+ "group": "Webhook Events",+ "pages": [+ "api-reference/platform/webhook-events/return-a-list-of-webhook-events"+ ]+ },+ {+ "group": "Webhook Subscribers",+ "pages": [+ "api-reference/platform/webhook-subscribers/return-a-list-of-webhook-subscribers",+ "api-reference/platform/webhook-subscribers/create-a-webhook-subscriber",+ "api-reference/platform/webhook-subscribers/return-a-webhook-subscriber",+ "api-reference/platform/webhook-subscribers/delete-a-webhook-subscriber",+ "api-reference/platform/webhook-subscribers/update-a-webhook-subscriber"+ ]+ },+ {+ "group": "Wished Items",+ "pages": [+ "api-reference/platform/wished-items/return-a-list-of-wished-items",+ "api-reference/platform/wished-items/create-a-wished-item",+ "api-reference/platform/wished-items/return-a-wished-item",+ "api-reference/platform/wished-items/delete-a-wished-item",+ "api-reference/platform/wished-items/update-a-wished-item"+ ]+ },+ {+ "group": "Wishlists",+ "pages": [+ "api-reference/platform/wishlists/return-a-list-of-wishlists",+ "api-reference/platform/wishlists/create-a-wishlist",+ "api-reference/platform/wishlists/return-a-wishlist",+ "api-reference/platform/wishlists/delete-a-wishlist",+ "api-reference/platform/wishlists/update-a-wishlist"+ ]+ },+ {+ "group": "Zones",+ "pages": [+ "api-reference/platform/zones/return-a-list-of-zones",+ "api-reference/platform/zones/create-a-zone",+ "api-reference/platform/zones/return-a-zone",+ "api-reference/platform/zones/delete-a-zone",+ "api-reference/platform/zones/update-a-zone"+ ]+ }+ ]+ }+ ]+ },+ {+ "tab": "User Docs",+ "groups": [+ {+ "group": "Introduction",+ "pages": [+ "user/what-is-spree-commerce",+ "user/using-spree",+ "user/user-quickstart-guide"+ ]+ },+ {+ "group": "Products",+ "pages": [+ {+ "group": "Create & Edit Products",+ "pages": [+ "user/products/creating-products",+ "user/products/deleting-products",+ "user/products/editing-products",+ "user/products/editing-multi-variant-products",+ "user/products/cloning-products"+ ]+ },+ {+ "group": "Manage Products",+ "pages": [+ "user/manage-products/search-products",+ "user/manage-products/bulk-product-operations",+ "user/manage-products/import-products",+ "user/manage-products/product-import-file-template",+ "user/manage-products/export-products",+ "user/manage-products/stock-levels",+ "user/manage-products/stock-transfers",+ "user/manage-products/product-taxonomies",+ "user/manage-products/product-options",+ "user/manage-products/product-properties"+ ]+ }+ ]+ },+ {+ "group": "Orders",+ "pages": [+ "user/orders/order-states",+ "user/orders/processing-orders",+ "user/orders/creating-orders",+ "user/orders/editing-orders",+ "user/orders/exporting-orders",+ "user/orders/cancelling-orders",+ "user/orders/refunding-orders",+ "user/orders/searching-orders"+ ]+ },+ {+ "group": "Storefront",+ "pages": [+ {+ "group": "Storefront Themes",+ "pages": [+ "user/storefront/theme-editor",+ "user/storefront/create-new-theme",+ "user/storefront/delete-theme"+ ]+ },+ {+ "group": "Storefront Pages",+ "pages": [+ "user/storefront/create-page",+ "user/storefront/edit-page",+ "user/storefront/delete-page"+ ]+ },+ {+ "group": "Storefront Posts",+ "pages": [+ "user/storefront/create-post",+ "user/storefront/edit-post",+ "user/storefront/search-posts",+ "user/storefront/delete-post",+ "user/storefront/import-posts"+ ]+ },+ "user/storefront/storefront-settings",+ "user/storefront/create-new-store"+ ]+ }+ ]+ }+ ]+ }+ ],+ "global": {+ "anchors": [+ {+ "anchor": "Community",+ "href": "http://slack.spreecommerce.org/",+ "icon": "slack"+ },+ {+ "anchor": "Github",+ "href": "https://github.com/spree/spree",+ "icon": "github"+ }+ ]+ }+ },+ "logo": {+ "light": "/logo/logo_light.png",+ "dark": "/logo/logo_dark.png",+ "href": "https://spreecommerce.org"+ },+ "api": {+ "openapi": [+ "api-reference/storefront.yaml",+ "api-reference/platform.yaml"+ ],+ "mdx": {+ "server": [+ "http://localhost:3000",+ "https://demo.spreecommerce.org"+ ]+ }+ },+ "navbar": {+ "links": [+ {+ "label": "Support",+ "href": "mailto:[email protected]"+ }+ ],+ "primary": {+ "type": "button",+ "label": "Get started",+ "href": "https://spreecommerce.org/contact/"+ }+ },+ "footer": {+ "socials": {+ "github": "https://github.com/spree/spree",+ "x": "https://x.com/spreecommerce"+ }+ },+ "integrations": {+ "ga4": {+ "measurementId": "G-NCVLCVHL5Y"+ }+ }+}\ No newline at end of filediff --git a/docs/mint.json b/docs/mint.jsondeleted file mode 100644index df83764e44..0000000000--- a/docs/mint.json+++ /dev/null@@ -1,969 +0,0 @@-{- "$schema": "https://mintlify.com/schema.json",- "name": "Spree Commerce documentation",- "logo": {- "dark": "/logo/logo_dark.png",- "light": "/logo/logo_light.png",- "href": "https://spreecommerce.org"- },- "favicon": "/favicon.png",- "colors": {- "primary": "#0A2242",- "light": "#D7DFE9",- "dark": "#0A2242",- "anchors": {- "from": "#233855",- "to": "#233855"- },- "background": {- "light": "#F3F3F3"- }- },- "versions": [- {- "name": "v5",- "default": true- },- {- "name": "v4"- }- ],- "api": {- "baseUrl": ["http://localhost:3000", "https://demo.spreecommerce.org"]- },- "openapi": [- "/api-reference/storefront.yaml",- "/api-reference/platform.yaml"- ],- "topbarLinks": [- {- "name": "Support",- "url": "mailto:[email protected]"- }- ],- "topbarCtaButton": {- "type": "link",- "name": "Get started",- "url": "https://spreecommerce.org/contact/"- },- "tabs": [- {- "name": "Ecommerce API",- "url": "api-reference"- },- {- "name": "User Docs",- "url": "user"- }- ],- "primaryTab": {- "name": "Developer Docs"- },- "anchors": [- {- "name": "Community",- "icon": "slack",- "url": "http://slack.spreecommerce.org/"- },- {- "name": "Github",- "icon": "github",- "url": "https://github.com/spree/spree"- }- ],- "navigation": [- {- "group": "Getting started",- "pages": [- "developer/getting-started/quickstart"- ]- },- {- "group": "Core Concepts",- "pages": [- "developer/core-concepts/architecture",- "developer/core-concepts/stores",- "developer/core-concepts/orders",- "developer/core-concepts/users",- "developer/core-concepts/products",- "developer/core-concepts/inventory",- "developer/core-concepts/payments",- "developer/core-concepts/taxes",- "developer/core-concepts/promotions",- "developer/core-concepts/shipments",- "developer/core-concepts/addresses",- "developer/core-concepts/i18n",- "developer/core-concepts/preferences"- ]- },-- {- "group": "Customizing Spree",- "version": "v5",- "pages": [- "developer/customization/quickstart",- "developer/customization/authentication",- "developer/customization/checkout",- "developer/customization/permissions",- "developer/customization/dependencies",- "developer/customization/decorators",- "developer/customization/routes"- ]- },-- {- "group": "Customizing Spree",- "version": "v4",- "pages": [- "developer/customization/quickstart",- "developer/customization/v4/authentication",- "developer/customization/v4/images",- "developer/customization/v4/checkout",- "developer/customization/v4/admin-panel",- "developer/customization/v4/storefront",- "developer/customization/v4/deface",- "developer/customization/permissions",- "developer/customization/dependencies",- "developer/customization/decorators",- "developer/customization/routes"- ]- },-- {- "group": "Extending Spree",- "pages": [- "developer/extending-spree/promotions",- "developer/extending-spree/3rd-party-extensions"- ]- },-- {- "group": "Deployment",- "pages": [- "developer/deployment/render",- "developer/deployment/docker",- "developer/deployment/assets",- "developer/deployment/cdn",- "developer/deployment/caching"- ]- },-- {- "group": "Upgrading",- "pages": [- "developer/upgrades/quickstart",- {- "group": "Upgrade Guides",- "pages": [- "developer/upgrades/4.8-to-4.9",- "developer/upgrades/4.x-to-4.8",- "developer/upgrades/4.6-to-4.7",- "developer/upgrades/4.5-to-4.6",- "developer/upgrades/4.4-to-4.5",- "developer/upgrades/4.3-to-4.4",- "developer/upgrades/4.2-to-4.3",- "developer/upgrades/4.1-to-4.2",- "developer/upgrades/4.0-to-4.1",- "developer/upgrades/3.7-to-4.0",- "developer/upgrades/3.6-to-3.7",- "developer/upgrades/3.5-to-3.6",- "developer/upgrades/3.4-to-3.5",- "developer/upgrades/3.3-to-3.4",- "developer/upgrades/3.2-to-3.3",- "developer/upgrades/3.1-to-3.2",- "developer/upgrades/3.0-to-3.1",- "developer/upgrades/2.3-to-2.4",- "developer/upgrades/2.2-to-2.3",- "developer/upgrades/2.1-to-2.2",- "developer/upgrades/2.0-to-2.1"- ]- }- ]- },- {- "group": "Contributing",- "pages": [- "developer/contributing/quickstart",- "developer/contributing/developing-spree",- "developer/contributing/creating-an-extension"- ]- },- {- "group": "Security",- "pages": [- "developer/security/security_policy",- "developer/security/pci_compliance"- ]- },- {- "group": "Advanced",- "pages": [- "developer/advanced/adding_spree_to_rails_app"- ]- },-- {- "group": "API basics",- "pages": [- "api-reference/introduction",- "api-reference/pagination",- "api-reference/filtering-and-sorting",- "api-reference/fetching-multiple-resources"- ]- },- {- "group": "Storefront API",- "pages": [- "api-reference/storefront/authentication",- {- "group": "Account",- "pages": [- "api-reference/storefront/account/retrieve-an-account",- "api-reference/storefront/account/create-an-account",- "api-reference/storefront/account/update-an-account"- ]- },- {- "group": "Account / Address",- "pages": [- "api-reference/storefront/account-address/list-all-addresses",- "api-reference/storefront/account-address/create-an-address",- "api-reference/storefront/account-address/remove-an-address",- "api-reference/storefront/account-address/update-an-address"- ]- },- {- "group": "Account / Credit Cards",- "pages": [- "api-reference/storefront/account-credit-cards/list-all-credit-cards",- "api-reference/storefront/account-credit-cards/remove-a-credit-card",- "api-reference/storefront/account-credit-cards/retrieve-the-default-credit-card"- ]- },- {- "group": "Account / Orders",- "pages": [- "api-reference/storefront/account-orders/list-all-orders",- "api-reference/storefront/account-orders/retrieve-an-order"- ]- },- {- "group": "Order Status",- "pages": [- "api-reference/storefront/order-status/retrieve-an-order-status"- ]- },- {- "group": "Cart",- "pages": [- "api-reference/storefront/cart/retrieve-a-cart",- "api-reference/storefront/cart/create-a-cart",- "api-reference/storefront/cart/delete-a-cart"- ]- },- {- "group": "Cart / Line Items",- "pages": [- "api-reference/storefront/cart-line-items/add-an-item-to-cart",- "api-reference/storefront/cart-line-items/set-line-item-quantity",- "api-reference/storefront/cart-line-items/remove-a-line-item"- ]- },- {- "group": "Cart / Other",- "pages": [- "api-reference/storefront/cart-other/empty-the-cart",- "api-reference/storefront/cart-other/list-estimated-shipping-rates",- "api-reference/storefront/cart-other/associate-a-cart-with-a-user",- "api-reference/storefront/cart-other/change-cart-currency"- ]- },- {- "group": "Cart / Coupons",- "pages": [- "api-reference/storefront/cart-coupons/apply-a-coupon-code",- "api-reference/storefront/cart-coupons/remove-a-coupon",- "api-reference/storefront/cart-coupons/remove-all-coupons"- ]- },- {- "group": "Checkout",- "pages": [- "api-reference/storefront/checkout/update-checkout",- "api-reference/storefront/checkout/validate-order-payment"- ]- },- {- "group": "Checkout / State",- "pages": [- "api-reference/storefront/checkout-state/next-checkout-step",- "api-reference/storefront/checkout-state/advance-checkout",- "api-reference/storefront/checkout-state/complete-checkout"- ]- },- {- "group": "Checkout / Shipments",- "pages": [- "api-reference/storefront/checkout-shipments/selects-shipping-method-for-shipments",- "api-reference/storefront/checkout-shipments/list-shipping-rates"- ]- },- {- "group": "Checkout / Payments",- "pages": [- "api-reference/storefront/checkout-payments/create-new-payment",- "api-reference/storefront/checkout-payments/list-payment-methods"- ]- },- {- "group": "Checkout / Store Credit",- "pages": [- "api-reference/storefront/checkout-store-credit/add-store-credit",- "api-reference/storefront/checkout-store-credit/remove-store-credit"- ]- },- {- "group": "Stripe",- "pages": [- "api-reference/storefront/stripe/return-a-stripe-payment-intent",- "api-reference/storefront/stripe/create-a-stripe-payment-intent",- "api-reference/storefront/stripe/create-a-stripe-payment-intent-1",- "api-reference/storefront/stripe/create-a-stripe-setup-intent"- ]- },- {- "group": "Products",- "pages": [- "api-reference/storefront/products/list-all-products",- "api-reference/storefront/products/retrieve-a-product"- ]- },- {- "group": "Vendors",- "pages": [- "api-reference/storefront/vendors/list-all-vendors-available-on-this-store-marketplace",- "api-reference/storefront/vendors/retrieve-a-vendor"- ]- },- {- "group": "Stores",- "pages": [- "api-reference/storefront/stores/return-the-current-store"- ]- },- {- "group": "Taxons",- "pages": [- "api-reference/storefront/taxons/list-all-taxons",- "api-reference/storefront/taxons/retrieve-a-taxon"- ]- },- {- "group": "Countries",- "pages": [- "api-reference/storefront/countries/list-all-countries",- "api-reference/storefront/countries/retrieve-a-country",- "api-reference/storefront/countries/get-default-country"- ]- },- {- "group": "CMS Pages",- "pages": [- "api-reference/storefront/cms-pages/list-all-cms-pages",- "api-reference/storefront/cms-pages/retrieve-a-cms-page"- ]- },- {- "group": "Menus",- "pages": [- "api-reference/storefront/menus/list-all-menus",- "api-reference/storefront/menus/retrieve-a-menu"- ]- },- {- "group": "Wishlists",- "pages": [- "api-reference/storefront/wishlists/list-all-wishlists",- "api-reference/storefront/wishlists/create-a-wishlist",- "api-reference/storefront/wishlists/retrieve-a-wishlist",- "api-reference/storefront/wishlists/delete-a-wishlist",- "api-reference/storefront/wishlists/update-a-wishlist",- "api-reference/storefront/wishlists/retrieve-the-default-wishlist"- ]- },- {- "group": "Wishlists / Wished Items",- "pages": [- "api-reference/storefront/wishlists-wished-items/add-item-to-wishlist",- "api-reference/storefront/wishlists-wished-items/add-items-to-wishlist",- "api-reference/storefront/wishlists-wished-items/set-wished-item-quantity",- "api-reference/storefront/wishlists-wished-items/delete-item-from-wishlist",- "api-reference/storefront/wishlists-wished-items/delete-items-from-wishlist"- ]- },- {- "group": "Digital Downloads",- "pages": [- "api-reference/storefront/digital-downloads/download-a-digital-asset"- ]- }- ]- },-- {- "group": "Platform API",- "pages": [- "api-reference/platform/authentication",- {- "group": "Addresses",- "pages": [- "api-reference/platform/addresses/return-a-list-of-addresses",- "api-reference/platform/addresses/create-an-address",- "api-reference/platform/addresses/return-an-address",- "api-reference/platform/addresses/delete-an-address",- "api-reference/platform/addresses/update-an-address"- ]- },- {- "group": "Adjustments",- "pages": [- "api-reference/platform/adjustments/return-a-list-of-adjustments",- "api-reference/platform/adjustments/create-an-adjustment",- "api-reference/platform/adjustments/return-an-adjustment",- "api-reference/platform/adjustments/delete-an-adjustment",- "api-reference/platform/adjustments/update-an-adjustment"- ]- },- {- "group": "Classifications",- "pages": [- "api-reference/platform/classifications/return-a-list-of-classifications",- "api-reference/platform/classifications/create-a-classification",- "api-reference/platform/classifications/return-a-classification",- "api-reference/platform/classifications/delete-a-classification",- "api-reference/platform/classifications/update-a-classification"- ]- },- {- "group": "CMS Pages",- "pages": [- "api-reference/platform/cms-pages/return-a-list-of-cms-pages",- "api-reference/platform/cms-pages/create-a-cms-page",- "api-reference/platform/cms-pages/return-a-cms-page",- "api-reference/platform/cms-pages/delete-a-cms-page",- "api-reference/platform/cms-pages/update-a-cms-page"- ]- },- {- "group": "CMS Sections",- "pages": [- "api-reference/platform/cms-sections/return-a-list-of-cms-sections",- "api-reference/platform/cms-sections/create-a-cms-section",- "api-reference/platform/cms-sections/return-a-cms-section",- "api-reference/platform/cms-sections/delete-a-cms-section",- "api-reference/platform/cms-sections/update-a-cms-section"- ]- },- {- "group": "Countries",- "pages": [- "api-reference/platform/countries/returns-a-list-of-countries",- "api-reference/platform/countries/returns-a-country"- ]- },- {- "group": "Data Feeds",- "pages": [- "api-reference/platform/data-feeds/return-a-list-of-data-feeds",- "api-reference/platform/data-feeds/create-a-data-feed",- "api-reference/platform/data-feeds/return-a-data-feed",- "api-reference/platform/data-feeds/delete-a-data-feed",- "api-reference/platform/data-feeds/update-a-data-feed"- ]- },- {- "group": "Digital Links",- "pages": [- "api-reference/platform/digital-links/return-a-list-of-digital-links",- "api-reference/platform/digital-links/create-a-digital-link",- "api-reference/platform/digital-links/return-a-digital-link",- "api-reference/platform/digital-links/delete-a-digital-link",- "api-reference/platform/digital-links/update-a-digital-link",- "api-reference/platform/digital-links/reset-a-digital-link"- ]- },- {- "group": "Digital Assets",- "pages": [- "api-reference/platform/digital-assets/return-a-list-of-digital-assets",- "api-reference/platform/digital-assets/create-a-digital-asset",- "api-reference/platform/digital-assets/return-a-digital-asset",- "api-reference/platform/digital-assets/delete-a-digital-asset",- "api-reference/platform/digital-assets/update-a-digital-asset"- ]- },- {- "group": "Line Items",- "pages": [- "api-reference/platform/line-items/return-a-list-of-line-items",- "api-reference/platform/line-items/create-a-line-item",- "api-reference/platform/line-items/return-a-line-item",- "api-reference/platform/line-items/delete-a-line-item",- "api-reference/platform/line-items/update-a-line-item"- ]- },- {- "group": "Menu Items",- "pages": [- "api-reference/platform/menu-items/return-a-list-of-menu-items",- "api-reference/platform/menu-items/create-a-menu-item",- "api-reference/platform/menu-items/return-a-menu-item",- "api-reference/platform/menu-items/delete-a-menu-item",- "api-reference/platform/menu-items/update-a-menu-item",- "api-reference/platform/menu-items/reposition-a-menu-item"- ]- },- {- "group": "Menus",- "pages": [- "api-reference/platform/menus/return-a-list-of-menus",- "api-reference/platform/menus/create-a-menu",- "api-reference/platform/menus/return-a-menu",- "api-reference/platform/menus/delete-a-menu",- "api-reference/platform/menus/update-a-menu"- ]- },- {- "group": "Option Types",- "pages": [- "api-reference/platform/option-types/return-a-list-of-option-types",- "api-reference/platform/option-types/create-an-option-type",- "api-reference/platform/option-types/return-an-option-type",- "api-reference/platform/option-types/delete-an-option-type",- "api-reference/platform/option-types/update-an-option-type"- ]- },- {- "group": "Option Values",- "pages": [- "api-reference/platform/option-values/return-a-list-of-option-values",- "api-reference/platform/option-values/create-an-option-value",- "api-reference/platform/option-values/return-an-option-value",- "api-reference/platform/option-values/delete-an-option-value",- "api-reference/platform/option-values/update-an-option-value"- ]- },- {- "group": "Orders",- "pages": [- "api-reference/platform/orders/return-a-list-of-orders",- "api-reference/platform/orders/creates-an-order",- "api-reference/platform/orders/return-an-order",- "api-reference/platform/orders/delete-an-order",- "api-reference/platform/orders/update-an-order",- "api-reference/platform/orders/advances-an-order",- "api-reference/platform/orders/next-an-order",- "api-reference/platform/orders/completes-an-order",- "api-reference/platform/orders/empties-an-order",- "api-reference/platform/orders/approves-an-order",- "api-reference/platform/orders/cancels-an-order",- "api-reference/platform/orders/use-store-credit-for-an-order",- "api-reference/platform/orders/apply-coupon-code-for-an-order"- ]- },- {- "group": "Payment Methods",- "pages": [- "api-reference/platform/payment-methods/return-a-list-of-payment-methods",- "api-reference/platform/payment-methods/create-a-payment-method",- "api-reference/platform/payment-methods/return-a-payment-method",- "api-reference/platform/payment-methods/delete-a-payment-method",- "api-reference/platform/payment-methods/update-a-payment-method"- ]- },- {- "group": "Payments",- "pages": [- "api-reference/platform/payments/return-a-list-of-payments",- "api-reference/platform/payments/return-a-payment",- "api-reference/platform/payments/delete-a-payment"- ]- },- {- "group": "Products",- "pages": [- "api-reference/platform/products/return-a-list-of-products",- "api-reference/platform/products/create-a-product",- "api-reference/platform/products/return-a-product",- "api-reference/platform/products/delete-a-product",- "api-reference/platform/products/update-a-product"- ]- },- {- "group": "Promotion Actions",- "pages": [- "api-reference/platform/promotion-actions/return-a-list-of-promotion-actions",- "api-reference/platform/promotion-actions/create-a-promotion-action",- "api-reference/platform/promotion-actions/return-a-promotion-action",- "api-reference/platform/promotion-actions/delete-a-promotion-action",- "api-reference/platform/promotion-actions/update-a-promotion-action"- ]- },- {- "group": "Promotion Categories",- "pages": [- "api-reference/platform/promotion-categories/return-a-list-of-promotion-categories",- "api-reference/platform/promotion-categories/create-a-promotion-category",- "api-reference/platform/promotion-categories/return-a-promotion-category",- "api-reference/platform/promotion-categories/delete-a-promotion-category",- "api-reference/platform/promotion-categories/update-a-promotion-category"- ]- },- {- "group": "Promotion Rules",- "pages": [- "api-reference/platform/promotion-rules/return-a-list-of-promotion-rules",- "api-reference/platform/promotion-rules/create-a-promotion-rule",- "api-reference/platform/promotion-rules/return-a-promotion-rule",- "api-reference/platform/promotion-rules/delete-a-promotion-rule",- "api-reference/platform/promotion-rules/update-a-promotion-rule"- ]- },- {- "group": "Promotions",- "pages": [- "api-reference/platform/promotions/return-a-list-of-promotions",- "api-reference/platform/promotions/create-a-promotion",- "api-reference/platform/promotions/return-a-promotion",- "api-reference/platform/promotions/delete-a-promotion",- "api-reference/platform/promotions/update-a-promotion"- ]- },- {- "group": "Roles",- "pages": [- "api-reference/platform/roles/return-a-list-of-roles",- "api-reference/platform/roles/create-a-role",- "api-reference/platform/roles/return-a-role",- "api-reference/platform/roles/delete-a-role",- "api-reference/platform/roles/update-a-role"- ]- },- {- "group": "Shipments",- "pages": [- "api-reference/platform/shipments/return-a-list-of-shipments",- "api-reference/platform/shipments/create-a-shipment",- "api-reference/platform/shipments/return-a-shipment",- "api-reference/platform/shipments/delete-a-shipment",- "api-reference/platform/shipments/update-a-shipment",- "api-reference/platform/shipments/adds-item-variant-to-an-existing-shipment",- "api-reference/platform/shipments/removes-item-variant-from-shipment",- "api-reference/platform/shipments/mark-shipment-as-ready-to-be-shipped",- "api-reference/platform/shipments/mark-shipment-as-shipped",- "api-reference/platform/shipments/cancels-the-shipment",- "api-reference/platform/shipments/resumes-the-shipment",- "api-reference/platform/shipments/moves-shipment-back-to-pending-state"- ]- },- {- "group": "Shipping Categories",- "pages": [- "api-reference/platform/shipping-categories/return-a-list-of-shipping-categories",- "api-reference/platform/shipping-categories/create-a-shipping-category",- "api-reference/platform/shipping-categories/return-a-shipping-category",- "api-reference/platform/shipping-categories/delete-a-shipping-category",- "api-reference/platform/shipping-categories/update-a-shipping-category"- ]- },- {- "group": "Shipping Methods",- "pages": [- "api-reference/platform/shipping-methods/return-a-list-of-shipping-methods",- "api-reference/platform/shipping-methods/create-a-shipping-method",- "api-reference/platform/shipping-methods/return-a-shipping-method",- "api-reference/platform/shipping-methods/delete-a-shipping-method",- "api-reference/platform/shipping-methods/update-a-shipping-method"- ]- },- {- "group": "States",- "pages": [- "api-reference/platform/states/returns-a-list-of-states",- "api-reference/platform/states/returns-a-state"- ]- },- {- "group": "Stock Items",- "pages": [- "api-reference/platform/stock-items/return-a-list-of-stock-items",- "api-reference/platform/stock-items/create-a-stock-item",- "api-reference/platform/stock-items/return-a-stock-item",- "api-reference/platform/stock-items/delete-a-stock-item",- "api-reference/platform/stock-items/update-a-stock-item"- ]- },- {- "group": "Stock Locations",- "pages": [- "api-reference/platform/stock-locations/return-a-list-of-stock-locations",- "api-reference/platform/stock-locations/create-a-stock-location",- "api-reference/platform/stock-locations/return-a-stock-location",- "api-reference/platform/stock-locations/delete-a-stock-location",- "api-reference/platform/stock-locations/update-a-stock-location"- ]- },- {- "group": "Store Credit Categories",- "pages": [- "api-reference/platform/store-credit-categories/return-a-list-of-store-credit-categories",- "api-reference/platform/store-credit-categories/create-a-store-credit-category",- "api-reference/platform/store-credit-categories/return-a-store-credit-category",- "api-reference/platform/store-credit-categories/delete-a-store-credit-category",- "api-reference/platform/store-credit-categories/update-a-store-credit-category"- ]- },- {- "group": "Store Credit Types",- "pages": [- "api-reference/platform/store-credit-types/return-a-list-of-store-credit-types",- "api-reference/platform/store-credit-types/create-a-store-credit-type",- "api-reference/platform/store-credit-types/return-a-store-credit-type",- "api-reference/platform/store-credit-types/delete-a-store-credit-type",- "api-reference/platform/store-credit-types/update-a-store-credit-type"- ]- },- {- "group": "Store Credits",- "pages": [- "api-reference/platform/store-credits/return-a-list-of-store-credits",- "api-reference/platform/store-credits/create-a-store-credit",- "api-reference/platform/store-credits/return-a-store-credit",- "api-reference/platform/store-credits/delete-a-store-credit",- "api-reference/platform/store-credits/update-a-store-credit"- ]- },- {- "group": "Tax Categories",- "pages": [- "api-reference/platform/tax-categories/return-a-list-of-tax-categories",- "api-reference/platform/tax-categories/create-a-tax-category",- "api-reference/platform/tax-categories/return-a-tax-category",- "api-reference/platform/tax-categories/delete-a-tax-category",- "api-reference/platform/tax-categories/update-a-tax-category"- ]- },- {- "group": "Tax Rates",- "pages": [- "api-reference/platform/tax-rates/return-a-list-of-tax-rates",- "api-reference/platform/tax-rates/create-a-tax-rate",- "api-reference/platform/tax-rates/return-a-tax-rate",- "api-reference/platform/tax-rates/delete-a-tax-rate",- "api-reference/platform/tax-rates/update-a-tax-rate"- ]- },- {- "group": "Taxonomies",- "pages": [- "api-reference/platform/taxonomies/return-a-list-of-taxonomies",- "api-reference/platform/taxonomies/create-a-taxonomy",- "api-reference/platform/taxonomies/return-a-taxonomy",- "api-reference/platform/taxonomies/delete-a-taxonomy",- "api-reference/platform/taxonomies/update-a-taxonomy"- ]- },- {- "group": "Taxons",- "pages": [- "api-reference/platform/taxons/return-a-list-of-taxons",- "api-reference/platform/taxons/create-a-taxon",- "api-reference/platform/taxons/return-a-taxon",- "api-reference/platform/taxons/delete-a-taxon",- "api-reference/platform/taxons/update-a-taxon",- "api-reference/platform/taxons/reposition-a-taxon"- ]- },- {- "group": "Users",- "pages": [- "api-reference/platform/users/return-a-list-of-users",- "api-reference/platform/users/create-a-user",- "api-reference/platform/users/return-a-user",- "api-reference/platform/users/delete-a-user",- "api-reference/platform/users/update-a-user"- ]- },- {- "group": "Variants",- "pages": [- "api-reference/platform/variants/return-a-list-of-variants",- "api-reference/platform/variants/return-a-variant",- "api-reference/platform/variants/delete-a-variant"- ]- },- {- "group": "Vendors",- "pages": [- "api-reference/platform/vendors/return-a-list-of-vendors",- "api-reference/platform/vendors/create-a-vendor",- "api-reference/platform/vendors/return-a-vendor",- "api-reference/platform/vendors/delete-a-vendor",- "api-reference/platform/vendors/update-a-vendor",- "api-reference/platform/vendors/invites-vendor-to-the-platform",- "api-reference/platform/vendors/start-onboarding-process",- "api-reference/platform/vendors/completes-onboarding-process",- "api-reference/platform/vendors/approves-vendor",- "api-reference/platform/vendors/rejects-vendor",- "api-reference/platform/vendors/suspends-vendor"- ]- },- {- "group": "Webhook Events",- "pages": [- "api-reference/platform/webhook-events/return-a-list-of-webhook-events"- ]- },- {- "group": "Webhook Subscribers",- "pages": [- "api-reference/platform/webhook-subscribers/return-a-list-of-webhook-subscribers",- "api-reference/platform/webhook-subscribers/create-a-webhook-subscriber",- "api-reference/platform/webhook-subscribers/return-a-webhook-subscriber",- "api-reference/platform/webhook-subscribers/delete-a-webhook-subscriber",- "api-reference/platform/webhook-subscribers/update-a-webhook-subscriber"- ]- },- {- "group": "Wished Items",- "pages": [- "api-reference/platform/wished-items/return-a-list-of-wished-items",- "api-reference/platform/wished-items/create-a-wished-item",- "api-reference/platform/wished-items/return-a-wished-item",- "api-reference/platform/wished-items/delete-a-wished-item",- "api-reference/platform/wished-items/update-a-wished-item"- ]- },- {- "group": "Wishlists",- "pages": [- "api-reference/platform/wishlists/return-a-list-of-wishlists",- "api-reference/platform/wishlists/create-a-wishlist",- "api-reference/platform/wishlists/return-a-wishlist",- "api-reference/platform/wishlists/delete-a-wishlist",- "api-reference/platform/wishlists/update-a-wishlist"- ]- },- {- "group": "Zones",- "pages": [- "api-reference/platform/zones/return-a-list-of-zones",- "api-reference/platform/zones/create-a-zone",- "api-reference/platform/zones/return-a-zone",- "api-reference/platform/zones/delete-a-zone",- "api-reference/platform/zones/update-a-zone"- ]- }- ]- },-- {- "group": "Introduction",- "pages": [- "user/what-is-spree-commerce",- "user/using-spree",- "user/user-quickstart-guide"- ]- },- {- "group": "Products",- "pages": [- {- "group": "Create & Edit Products",- "pages": [- "user/products/creating-products",- "user/products/deleting-products",- "user/products/editing-products",- "user/products/editing-multi-variant-products",- "user/products/cloning-products"- ]- },- {- "group": "Manage Products",- "pages": [- "user/manage-products/search-products",- "user/manage-products/bulk-product-operations",- "user/manage-products/import-products",- "user/manage-products/product-import-file-template",- "user/manage-products/export-products",- "user/manage-products/stock-levels",- "user/manage-products/stock-transfers",- "user/manage-products/product-taxonomies",- "user/manage-products/product-options",- "user/manage-products/product-properties"- ]- }- ]- },- {- "group": "Orders",- "pages": [- "user/orders/order-states",- "user/orders/processing-orders",- "user/orders/creating-orders",- "user/orders/editing-orders",- "user/orders/exporting-orders",- "user/orders/cancelling-orders",- "user/orders/refunding-orders",- "user/orders/searching-orders"- ]- },- {- "group": "Storefront",- "pages": [- {- "group": "Storefront Themes",- "pages": [- "user/storefront/theme-editor",- "user/storefront/create-new-theme",- "user/storefront/delete-theme"- ]- },- {- "group": "Storefront Pages",- "pages": [- "user/storefront/create-page",- "user/storefront/edit-page",- "user/storefront/delete-page"- ]- },- {- "group": "Storefront Posts",- "pages": [- "user/storefront/create-post",- "user/storefront/edit-post",- "user/storefront/search-posts",- "user/storefront/delete-post",- "user/storefront/import-posts"- ]- },- "user/storefront/storefront-settings",- "user/storefront/create-new-store"- ]- }- ],- "footerSocials": {- "github": "https://github.com/spree/spree",- "x": "https://x.com/spreecommerce"- },- "feedback": {- "thumbsRating": true,- "suggestEdit": true,- "raiseIssue": true- },- "analytics": {- "ga4": {- "measurementId": "G-NCVLCVHL5Y"- }- }-}\ No newline at end of file