diff --git a/docs/commerce/commerce.md b/docs/commerce/commerce.md deleted file mode 100644 index 2c11496c..00000000 --- a/docs/commerce/commerce.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -description: Use the Commerce solution to let end-users place orders for products and perform actions related to payment and shipping. -edition: commerce ---- - -# Commerce - -[[= product_name =]] provides a Commerce solution that consists of several modules. -You can use them to create a unified and streamlined e-commerce platform. -Modules interact with each other, for example, to decrease stock following a sale, reduce prices when the cart reaches a certain value, or cancel shipments and payments when orders are cancelled. - -The solution complements functionalities provided by the [product catalog](products.md) offering, and allows you to sell products through the website. -With Commerce, you can build your own storefront from a set of generic components, which you can then customize to cover all aspects of the e-commerce experience. - -Out of the box, Commerce is configured to follow a specific workflow and support a certain number of processing method types, for example, flat rate, free shipping methods, and offline payment methods. -Contact your administrator or development team about customization options. -For more information, see [Developer Documentation]([[= developer_doc =]]/commerce/commerce/). - -The following diagram includes statuses and actions that may occur on the order's way along the fulfilment path. - -![Order processing workflow](img/commerce_workflow.png "Order processing workflow") - -From the end-user perspective, once it's properly configured to grant the right permissions to [user roles](../permission_management/permissions_and_users.md), the Commerce solution gives store managers control over the whole order fulfilment process, while allowing customers to monitor the progress of their transactions. - -Once the order is placed, users can interact with it by working with the following back office pages: - -[[= cards([ - "commerce/order_management/order_management", - "commerce/payment/payment_management", - "commerce/shipping_management/shipping_management", - "commerce/discounts/discounts" -], columns=3) =]] diff --git a/docs/commerce/discounts/discounts.md b/docs/commerce/discounts/discounts.md deleted file mode 100644 index 053b0ec7..00000000 --- a/docs/commerce/discounts/discounts.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: Increase conversion and attract customers by offering them products at discounted prices. -editions: - - commerce -month_change: false ---- - -# Discounts - -Discounts help store managers improve stock rotation, increase customer attachment or invite new customers, by offering reductions of prices on all or selected products, either at catalog or cart level. - -![Cart with discount](discount_cart.png) - -Depending on the permissions assigned to your [user role](permissions_and_users.md), you might be able to view existing discounts or define new ones to shape the pricing policy of your store. - -For example, you can create time-limited offers on selected products, ones that apply only to specified regions, currencies, products or customers, or reward your newsletter subscribers with special discount codes. - -## Interaction with other modules - -The **Discounts** module interacts with other parts of the system, so that store customers can: - -- in the product catalog, see base prices of products together with prices reduced according to active catalog discounts -- in the cart, see prices reduced according to catalog and/or cart discounts, apply discount codes, and observe as prices change when various cart discount conditions are met -- at checkout, see a total value of all applied discounts and prices reduced as a result of those discounts - -For more information about discounts, see [Work with discounts](work_with_discounts.md). diff --git a/docs/commerce/discounts/work_with_discounts.md b/docs/commerce/discounts/work_with_discounts.md deleted file mode 100644 index eb15d12c..00000000 --- a/docs/commerce/discounts/work_with_discounts.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -description: Create and edit discounts, toggle discount status. -editions: - - commerce -month_change: false ---- - -# Work with discounts - -In [[= product_name =]], on the **Discounts** screen, you can either view a list of discounts, or update existing discounts and create new ones depending on permissions assigned to your [user role](work_with_permissions.md). - -## View discount information in discounts list - -1. In the left panel, go to **Commerce** -> **Discounts**. - - Here, you can see a list of discounts, together with information about their validity period, status, type, and their authors. - -2. Narrow down the list of displayed discounts in one of the following ways: - - - search for a discount by typing in a part of its name or identifier in the search field - - filter discounts by selecting one or more of the following filters: - - **Discount type**: applicable to catalog or cart products - - **Status**: active, inactive or disabled - - **Created**: start and end of date range within which the discount was created - - **Validity period**: start and end of date range within which the discount is in force - - ![Discount filters](discount_filters.png) - -3. Click **Apply** to confirm your choices. - -4. To clear all the filters, click **Clear filters**. - -### Instantly disable discount - -When working with discounts it may happen that a discount has been created or enabled in error and you notice that it has negative impact on your business. - -To disable the offending discount, find it in the discount list and, in its line, click the **Disable** icon. - -![Discount filters](discount_disable_icon.png) - -### View discount details - -To view the details of a discount, click its line in the discount list. -On the discount details screen, you can see an overview of the discount's details. - -Discount details include basic information about the discount: - -- validity period and value of the discount -- region and currency that the discount applies to -- whether the discount applies to all customers or a selected customer group, -- whether any conditions apply - -![Discount detail view](discount_detail_view.png) - -On other tabs within this screen you can see: - -- products subject to the discount -- users who have authored or modified the discount -- translations created for the discount - -### Add translations - -If your store supports multiple languages and you want different discount names and/or descriptions to appear to customers from different markets, while [viewing discount details](#view-discount-details), you can go to the **Translations** tab and [add translations](../../content_management/translate_content.md#add-translations). - -## Create new discount - -When you create discounts, you must first decide whether they apply to all [products](../../product_catalog/products.md) from the catalog, or the products that the customer has put into their cart. -You are then taken through a series of steps, where you define the discount, for example, decide if it applies to selected [customer groups]([[= developer_doc =]]/users/customer_groups/) and specific products. -Cart discount applicability can be further limited by setting a number of conditions, such as: - -- a number of products in the cart -- total purchase value -- a discount code - -!!! note "Navigating through the steps" - - When you define discount details, you can go back to change your choices. - To do it, click a step header at the top of the screen. - - ![Discount creator steps](discount_creator_headers.png) - -1. In the left panel, go to **Commerce** -> **Discounts**, and click **Create**. - -2. Select whether the discount applies to catalog or cart products and the discount's type. - - Choose **Fixed amount** to deduct a specific amount of money from the base price of the product, or **Percentage** to calculate the deducted amount based on a specific percent value. - - ![New discount](new_discount.png) - -3. In the **General properties** screen, provide general information about the new discount: - - 1. In the **Global properties** area, provide an internal name of the discount and set the validity period. - Toggle the **Permanent discount** on to make the discount valid until you manually disable it. - 1. Then, select discount priority to help the system choose between discounts to apply when calculating the final price. - - !!! note "Only one discount at a time" - - When two or more discounts could be applied to the base price of the product, the system uses only one, based on a number of rules. - For example, cart discounts surpass catalog discounts. - - For more information, see [the product guide]([[= developer_doc =]]/discounts/discounts_guide/#discounts-priority). - - 1. If your store supports multiple markets, you can select a region that the discount applies to. - 1. If you are creating a fixed-amount discount, select a currency of the discount. - - ![Creating a new discount](create_new_discount.png) - - 1. In the **Promotion information** area, provide a name and description of the promotional campaign, as they should be shown to customers. - - ![Adding information about the promotion](discounts_promo_info.png) - - 1. Click **Next** to go to the next screen. - -4. In the **Target group** screen, select customers that the new discount is targeted at. -You can choose everyone, or select one or more customer groups. - - ![Customer selection](discounts_select_customers.png) - -5. In the **Products** screen, select products that the discount applies to. You can choose between: - - - all products from the catalog, for example, to clear stock before the end of year - - products from a specific category, for example, promotional gadgets for company partners - - specific products or even product variants, to activate slow-moving inventory - - In the latter case, you select products by using a Product picker, where you can use search and filters to pinpoint the exact product or product variant that you want the discount to apply to. - - ![Product picker](product_picker.png) - -6. If you are creating a cart discount, in the **Conditions** screen, you can set the conditions that limit the discount's availability to customers who have: - - - added to cart no less than a specific number of certain items - - added products to a cart for no less than a specified total value - - entered a specified discount code - - If you set the discount code, you can set the number of times that the code can be used: - - - by a certain customer - - in total, by all customers - - ![Cart discount conditions](cart_discount_conditions.png) - -7. In the **Discount value** screen, if you are creating a percentage-based discount, in **Customer gets discount value**, enter a percent value that the system uses to calculate the amount deducted from the base price of the product. -Otherwise, enter a monetary value to be deducted from the base price. - -8. In the **Summary** screen, review the details of the discount that you are creating, and click **Save and close** to save the discount. -Depending on the settings, you may see a warning message. - - ![Discount summary screen notice](discounts_summary_notice.png) - -## Edit existing discount - -You may find that an existing discount needs to be modified, for example, to change its validity period or target group. - -1. In the left panel, go to **Commerce** -> **Discounts**. - - ![Discounts list](discount_list.png) - -2. Use the search field and filters to find the discount that you want to edit. - -3. Click the **Edit** button next to the discount in the list. - -4. Edit the necessary details as described in [Create new discount](#create-new-discount). - -5. **Save and close** to save your changes. - -## Delete existing discount - -When there are too many discounts in the system, you may want to delete historic, unused ones. -You can only delete disabled discounts. - -1. In the left panel, go to **Commerce** -> **Discounts**. - -2. Use the search field and filters to find the discount that you want to delete. - -3. If the discount that you want to delete is not disabled, use the **Disable** icon to [disable it](#instantly-disable-discount). - -4. Select a box next to the discount's name and click **Delete**. diff --git a/docs/commerce/img/cart_discount_conditions.png b/docs/commerce/img/cart_discount_conditions.png deleted file mode 100644 index 922c4f6d..00000000 Binary files a/docs/commerce/img/cart_discount_conditions.png and /dev/null differ diff --git a/docs/commerce/img/commerce_workflow.png b/docs/commerce/img/commerce_workflow.png deleted file mode 100644 index 1e5f46e6..00000000 Binary files a/docs/commerce/img/commerce_workflow.png and /dev/null differ diff --git a/docs/commerce/img/commerce_workflow.xml b/docs/commerce/img/commerce_workflow.xml deleted file mode 100644 index e6264cf1..00000000 --- a/docs/commerce/img/commerce_workflow.xml +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/commerce/img/create_new_discount.png b/docs/commerce/img/create_new_discount.png deleted file mode 100644 index eca3b1e9..00000000 Binary files a/docs/commerce/img/create_new_discount.png and /dev/null differ diff --git a/docs/commerce/img/create_new_payment_method.png b/docs/commerce/img/create_new_payment_method.png deleted file mode 100644 index b4c74472..00000000 Binary files a/docs/commerce/img/create_new_payment_method.png and /dev/null differ diff --git a/docs/commerce/img/create_new_shipping_method.png b/docs/commerce/img/create_new_shipping_method.png deleted file mode 100644 index fa48a4b5..00000000 Binary files a/docs/commerce/img/create_new_shipping_method.png and /dev/null differ diff --git a/docs/commerce/img/discount_cart.png b/docs/commerce/img/discount_cart.png deleted file mode 100644 index 1d74a98a..00000000 Binary files a/docs/commerce/img/discount_cart.png and /dev/null differ diff --git a/docs/commerce/img/discount_creator_headers.png b/docs/commerce/img/discount_creator_headers.png deleted file mode 100644 index 1313210d..00000000 Binary files a/docs/commerce/img/discount_creator_headers.png and /dev/null differ diff --git a/docs/commerce/img/discount_detail_view.png b/docs/commerce/img/discount_detail_view.png deleted file mode 100644 index cf25a317..00000000 Binary files a/docs/commerce/img/discount_detail_view.png and /dev/null differ diff --git a/docs/commerce/img/discount_disable_icon.png b/docs/commerce/img/discount_disable_icon.png deleted file mode 100644 index 3775ad4b..00000000 Binary files a/docs/commerce/img/discount_disable_icon.png and /dev/null differ diff --git a/docs/commerce/img/discount_filters.png b/docs/commerce/img/discount_filters.png deleted file mode 100644 index 2fcb4ca1..00000000 Binary files a/docs/commerce/img/discount_filters.png and /dev/null differ diff --git a/docs/commerce/img/discount_list.png b/docs/commerce/img/discount_list.png deleted file mode 100644 index 119abfa4..00000000 Binary files a/docs/commerce/img/discount_list.png and /dev/null differ diff --git a/docs/commerce/img/discounts_promo_info.png b/docs/commerce/img/discounts_promo_info.png deleted file mode 100644 index dfc9dc45..00000000 Binary files a/docs/commerce/img/discounts_promo_info.png and /dev/null differ diff --git a/docs/commerce/img/discounts_select_customers.png b/docs/commerce/img/discounts_select_customers.png deleted file mode 100644 index 1c7fb0b4..00000000 Binary files a/docs/commerce/img/discounts_select_customers.png and /dev/null differ diff --git a/docs/commerce/img/discounts_summary_notice.png b/docs/commerce/img/discounts_summary_notice.png deleted file mode 100644 index 0ab05f32..00000000 Binary files a/docs/commerce/img/discounts_summary_notice.png and /dev/null differ diff --git a/docs/commerce/img/free_shipping.png b/docs/commerce/img/free_shipping.png deleted file mode 100644 index c4be8a24..00000000 Binary files a/docs/commerce/img/free_shipping.png and /dev/null differ diff --git a/docs/commerce/img/new_discount.png b/docs/commerce/img/new_discount.png deleted file mode 100644 index ef4c9bae..00000000 Binary files a/docs/commerce/img/new_discount.png and /dev/null differ diff --git a/docs/commerce/img/order_detail_items.png b/docs/commerce/img/order_detail_items.png deleted file mode 100644 index c6c53ece..00000000 Binary files a/docs/commerce/img/order_detail_items.png and /dev/null differ diff --git a/docs/commerce/img/order_detail_view.png b/docs/commerce/img/order_detail_view.png deleted file mode 100644 index 9eb6b4c7..00000000 Binary files a/docs/commerce/img/order_detail_view.png and /dev/null differ diff --git a/docs/commerce/img/order_list.png b/docs/commerce/img/order_list.png deleted file mode 100644 index 016b4727..00000000 Binary files a/docs/commerce/img/order_list.png and /dev/null differ diff --git a/docs/commerce/img/payment_detail_view.png b/docs/commerce/img/payment_detail_view.png deleted file mode 100644 index 8051b865..00000000 Binary files a/docs/commerce/img/payment_detail_view.png and /dev/null differ diff --git a/docs/commerce/img/payment_list.png b/docs/commerce/img/payment_list.png deleted file mode 100644 index 53d95f3c..00000000 Binary files a/docs/commerce/img/payment_list.png and /dev/null differ diff --git a/docs/commerce/img/payment_methods_list.png b/docs/commerce/img/payment_methods_list.png deleted file mode 100644 index abc9d72f..00000000 Binary files a/docs/commerce/img/payment_methods_list.png and /dev/null differ diff --git a/docs/commerce/img/product_picker.png b/docs/commerce/img/product_picker.png deleted file mode 100644 index 6c8ed4dc..00000000 Binary files a/docs/commerce/img/product_picker.png and /dev/null differ diff --git a/docs/commerce/img/shipment_detail_view.png b/docs/commerce/img/shipment_detail_view.png deleted file mode 100644 index 70483a37..00000000 Binary files a/docs/commerce/img/shipment_detail_view.png and /dev/null differ diff --git a/docs/commerce/img/shipment_filters.png b/docs/commerce/img/shipment_filters.png deleted file mode 100644 index 2653984c..00000000 Binary files a/docs/commerce/img/shipment_filters.png and /dev/null differ diff --git a/docs/commerce/img/shipment_list.png b/docs/commerce/img/shipment_list.png deleted file mode 100644 index 2a374434..00000000 Binary files a/docs/commerce/img/shipment_list.png and /dev/null differ diff --git a/docs/commerce/img/shipment_status.png b/docs/commerce/img/shipment_status.png deleted file mode 100644 index 99c9c491..00000000 Binary files a/docs/commerce/img/shipment_status.png and /dev/null differ diff --git a/docs/commerce/img/shipping_methods_list.png b/docs/commerce/img/shipping_methods_list.png deleted file mode 100644 index bf1056d4..00000000 Binary files a/docs/commerce/img/shipping_methods_list.png and /dev/null differ diff --git a/docs/commerce/order_management/order_management.md b/docs/commerce/order_management/order_management.md deleted file mode 100644 index 12b356af..00000000 --- a/docs/commerce/order_management/order_management.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: Order management module handles orders and allows managing orders in the system. -edition: commerce ---- - -# Order management - -The **Order management** module allows users to review order details, track order completion status, and cancel orders that are created when store customers purchase products. - -Depending on the permissions assigned to your [user role](permissions_and_users.md), you might be able to track and manage orders placed by all the store customers, or only your own ones. - -With the back office **Orders** screen, you can search for orders and filter search results. - -![Orders list](order_list.png "Orders list") - -The **Order management** package interacts with other packages of the system, so that: - -- when store customers pass the checkout stage, stock is decreased and payment and shipment workflows are initiated -- when store customers cancel their orders, the decreased stock is restored and payment and shipment are cancelled - -[[= cards([ - "commerce/order_management/work_with_orders" -], columns=3) =]] diff --git a/docs/commerce/order_management/work_with_orders.md b/docs/commerce/order_management/work_with_orders.md deleted file mode 100644 index 849f466e..00000000 --- a/docs/commerce/order_management/work_with_orders.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -description: Review order information, change order status. -edition: commerce ---- - -# Work with orders - -In [[= product_name =]], you can view a list of orders and modify their statuses on the **Orders** screen. -By default, depending on your permissions, you can access your own orders, or all the orders that exist in the system. - -## Filter orders in order list - -1. In the left panel, go to **Commerce** -> **Orders**. -2. Narrow down the list of displayed orders in one of the following ways: - - search for orders by typing part of customer or company name, or order identifier in the search box - - filter orders by selecting one or more filters - -Available filters are: - -- Statuses - multiselect list of order statuses, by default: Pending, Processing, Completed, Cancelled - -!!! note "Order statuses" - - Order statuses visible in the **Status** filter field are defined in the [Order workflow]([[= developer_doc =]]/commerce/order_management/configure_order_management/#configure-order-processing-workflow). - -- Created - a range of dates between which the order was created -- Client type - either B2B or B2C client -- Order source - the store from which the order comes -- Total value - a range of values that includes the total value of the order, in a selected currency -- Currency - the currency in which the order was made - -![Order list](order_list.png) - -## View order details - -To view the details of an order, click its line in the order list. - -On the order details screen, you can view more information about the order, such as customer, payment, and shipment details. - -![Order detail view](order_detail_view.png) - -In the **Items** tab you can see a list of products included in the order. - -![Viewing products included in the order](order_detail_items.png) - -The fields have the following meaning: - -- **Subtotal (net)** - a sum of all product prices without taxes -- **Shipping cost** - a net cost of the selected shipping method -- **Taxes** - a total value of all taxes, including those that apply to the selected shipping method and the products -- **Total value (gross)** - a total value of the order, including all discounts, taxes, and service charges - -!!! note "Ordering virtual products" - - If the order includes only virtual products then the Shipment and Shipping address sections aren't available. - Virtual products don't require shipment when they're the only product in a purchase. - -## Change order status - -If your [user role](work_with_permissions.md) includes the `Order/Update` permission, you can change the status of an existing order: confirm it if the order has "Pending" status, or complete it when it's in "Processing" status. -With the `Order/Cancel` permission, you can cancel an existing order. - -!!! note "Canceling orders" - - When you create an order, stocks are reduced for the products on that order. - When you cancel an order, the stocks are reverted back to their original values. diff --git a/docs/commerce/payment/payment_management.md b/docs/commerce/payment/payment_management.md deleted file mode 100644 index 61f1c9f8..00000000 --- a/docs/commerce/payment/payment_management.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -description: Payment management module handles payment methods and payments, and allows interacting with them in the system. -edition: commerce ---- - -# Payment management - -The **Payment management** module allows users to track the status of payments for orders placed by store customers. - -On the back office **Payments** screen, you can search for payments, filter the search results, and review payment details. -Depending on configuration and permissions, you may also be allowed to cancel payments. - -If the permissions assigned to your [user role](permissions_and_users.md) allow, you may also have access to the **Payment methods** screen, where you define, enable, or disable offline payment methods. - -![Payments list](payment_list.png "Payments list") - -The **Payment management** module interacts with other packages of the system, so that payment processing is cancelled automatically when you cancel your order. - -[[= cards([ - "commerce/payment/work_with_payments", - "commerce/payment/work_with_payment_methods" -], columns=3) =]] diff --git a/docs/commerce/payment/work_with_payment_methods.md b/docs/commerce/payment/work_with_payment_methods.md deleted file mode 100644 index 5a873d25..00000000 --- a/docs/commerce/payment/work_with_payment_methods.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -description: Define new payment methods or modify existing ones. -edition: commerce ---- - -# Work with payment methods - -If your [user role](work_with_permissions.md) has the `Payment method/Create` permission, you can create payment methods. -With the `Payment method/Edit` permission, you can modify existing ones. - -Payment methods describe the way store customers pay for their orders during the checkout process. - -!!! note "Payment method limitations" - - By default, you can only create payment methods of `Offline` type. - If your organization needs other payment method types, contact your administrator or development team about [creating a custom payment method type]([[= developer_doc =]]/commerce/payment/extend_payment/#define-custom-payment-method-type). - - Payment methods created in legacy Commerce cannot be migrated when you upgrade. You have to define them from scratch. - -## Create new payment method - -1\. In the left panel, go to **Commerce** -> **Payment methods**, and click **Create**. - -2\. Select the language for the new payment method and its type. - -![New payment method](new_payment_method.png) - -3\. In the next screen provide information about the new payment method. - -![Creating a new payment method](create_new_payment_method.png) - -4\. Toggle the **Availability** switch on, so that store customers can select this shipping method during checkout. - -5\. Click **Create** to save your changes. - -## Edit existing payment method - -1\. In the left panel, go to **Commerce** -> **Payment methods**. - -![Payment methods list](payment_methods_list.png) - -2\. Use the search field and filters to find the payment method that you want to edit. - -3\. Click the **Edit** button next to the method in the list. - -4\. Edit the necessary details. - -5\. Click **Update** to save your changes. - -## Delete existing payment method - -1\. In the left panel, go to **Commerce** -> **Payment methods**. - -2\. Use the search field and filters to find the payment method that you want to delete. - -3\. Select a box next to its name and click **Delete**. - -!!! note "Payment methods for existing orders" - - You cannot delete a payment method if it's active or if it's used by unpaid orders. - You must first deactivate the method that you want to delete by toggling the **Availability** switch off. - -## Filter payment methods - -1. In the left panel, go to **Commerce** -> **Payment methods**. -2. Narrow down the list of displayed payment methods in one of the following ways: - - - search for payment method by typing part of its name or identifier in the search box - - filter payment methods by selecting one or more filters - - Available filters are: - - - Method type - method of the payment - - Availability - payment method availability: Active, Inactive - -3. Click **Apply** to confirm. diff --git a/docs/commerce/payment/work_with_payments.md b/docs/commerce/payment/work_with_payments.md deleted file mode 100644 index 0baf5470..00000000 --- a/docs/commerce/payment/work_with_payments.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: Review payment information, change payment status. -edition: commerce ---- - -# Work with payments - -In [[= product_name =]], you can view a list of payments and modify their statuses on the **Payments** screen. -By default, depending on your permissions, you can access payments for your own orders, or all the payments that exist in the system. - -## Filter payments in payment list - -1. In the left panel, go to **Commerce** -> **Payments**. -2. Narrow down the list of displayed payments in one of the following ways: - - - search for payments by typing part of order ID or identifier in the search box - - filter payments by selecting one or more filters - -Available filters are: - -- Payment method - method used for the payment -- Status - payment status, by default: Pending, Failed, Paid, Cancelled - -!!! note "Payment statuses" - - Payment statuses visible in the **Status** filter field are defined in the [Payment workflow]([[= developer_doc =]]/commerce/payment/configure_payment/#default-payment-workflow-configuration). - -- Created - a range of dates between which the payment was created -- Updated - a range of dates between which payment status has last changed - -![Payment list](payment_list.png) - -## View payment details - -To view the details of a payment, click its line in the payment list. - -On the payment details screen, you can view a summary of information about the payment. -Payment details include information about the payment method used, total value and current status of the payment. - -![Payment detail view](payment_detail_view.png) - -## Change payment details - -If your [user role](work_with_permissions.md) includes the `Payment/Edit` permission, you can change the status of an existing payment: confirm it if the payment has "Pending" status. diff --git a/docs/commerce/shipping_management/shipping_management.md b/docs/commerce/shipping_management/shipping_management.md deleted file mode 100644 index 5631db75..00000000 --- a/docs/commerce/shipping_management/shipping_management.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -description: Shipping management module handles shipping methods. -edition: commerce ---- - -# Shipping management - -Shipping processes are present in almost every e-commerce business. -[[= product_name =]] comes with a number of storefront and backend features to help users manage shipping. - -No two businesses are identical, and [[= product_name =]] ensures the flexibility that you need to configure shipping methods in a way that is optimal for your business and store customers. - -If the permissions assigned to your [user role](permissions_and_users.md) allow, the **Shipping management** module enables you to define and manage shipping methods of different types on the **Shipping methods** screen. - -![Shipping methods list](shipping_methods_list.png "Shipping methods list") - -The **Shipping management** module interacts with other packages of the system, so that shipment processing is cancelled automatically when the customer cancels their order. - -[[= cards([ - "commerce/shipping_management/work_with_shipping_methods", - "commerce/shipping_management/work_with_shipments" -], columns=2) =]] diff --git a/docs/commerce/shipping_management/work_with_shipments.md b/docs/commerce/shipping_management/work_with_shipments.md deleted file mode 100644 index ee9deae8..00000000 --- a/docs/commerce/shipping_management/work_with_shipments.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -description: Work with shipments and view shipment details. -edition: commerce ---- - -# Work with shipments - -In [[= product_name =]], on the **Shipments** screen, you can view a list of shipments and modify their statuses. -You can access shipments for your own orders or all the shipments that exist in the system, depending on your permissions. - -## View shipment status - -Each shipment has a status due to the stage it's currently at. - -Available statuses are: - -- Pending -- Ready to ship -- Shipped -- Delivered -- Cancelled - -![Shipment list](shipment_list.png) - -!!! note "Shipment statuses" - - Shipment statuses visible in the **Status** filter field are defined in the [Shipment workflow]([[= developer_doc =]]/commerce/shipping_management/configure_shipment/#configure-shipment-workflow). - -To view shipment status: - -1\. In the left panel, go to **Commerce** -> **Shipments**. - -2\. Narrow down the list of displayed shipments in one of the following ways: - -- search for shipments by typing part of order ID or identifier in the search box -- filter shipments by selecting one or more filters - -## Filter shipments in shipment list - -You can use filters to narrow down the list of shipments. - -Available filters are: - -- Shipping method - method used for the shipment -- Status - shipment status -- Created - a range of dates between which the shipment was created -- Updated - a range of dates between which shipment status has last changed - -![Shipment filters](shipment_filters.png) - -To filter the list, set one of the filters and click `Apply` button. - -You can also clear all chosen filters - to do it, click `Clear filters`. - -## View shipment details - -To view the details of a shipment, click its line in the shipment list. - -On the shipment details screen, you can see an overview of the shipment's details. - -Shipment details include basic information about the shipment, customer details, shipping address, total value, order ID, and the date of the last update. - -![Shipment detail view](shipment_detail_view.png) - -## Change shipment status - -If your [user role](work_with_permissions.md) has the `Shipment/Edit` permission, you can change the status of an existing shipment: - -- "Pending" -> "Ready to ship" - click **Prepare** button, then click **Change** to confirm. -- "Ready to ship" -> "Shipped" - click **Send** button, then click **Change** to confirm. -- "Shipped" -> "Delivered" - click **Deliver** button, then click **Change** to confirm. diff --git a/docs/commerce/shipping_management/work_with_shipping_methods.md b/docs/commerce/shipping_management/work_with_shipping_methods.md deleted file mode 100644 index 787ac344..00000000 --- a/docs/commerce/shipping_management/work_with_shipping_methods.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -description: Define new shipping methods or modify existing ones. -edition: commerce ---- - -# Work with shipping methods - -If your [user role](work_with_permissions.md) includes the `Shipping method/Create` permission, you can create shipping methods. -With the `Shipping method/Edit` permission, you can modify existing ones. - -Shipping methods describe how goods can be shipped to a store customer, with different rates for different geographic locations. -Example shipping methods are overnight delivery, self-pickup, or DHL. - -!!! note "Shipping method limitations" - - By default, you can only create shipping methods of 'Flat rate' and 'Free shipping' type. - - Shipping methods created in legacy Commerce cannot be migrated when you upgrade. You have to define them from scratch. - -"Flat rate" shipping means delivering goods at a fixed, predefined cost, regardless of the number, and type of items in the cart. - -## Create new shipping method - -1\. In the left panel, go to **Commerce** -> **Shipping methods**, and click **Create**. - -2\. Select the language for the new shipping method, its type, and region that it applies to. - -3\. In the next screen provide information about the new shipping method. - -![Creating a new shipping method](create_new_shipping_method.png) - -Details about shipping cost differ between shipping methods: - -- Flat rate requires setting a specific fixed cost for shipping, expressed as net value in a given currency. -This value is then displayed during checkout and added to the total order amount when the store customer selects a specific shipping method. -- Free shipping requires setting the minimum order value (in a given currency) above which the shipping is free. - -![Configuring free shipping](free_shipping.png) - -4\. Toggle the **Availability** switch on, so that store customers can select this shipping method during checkout. - -5\. Click **Create** to save your changes. - -## Edit existing shipping method - -1\. In the left panel, go to **Commerce** -> **Shipping methods**. - -![Shipping methods list](shipping_methods_list.png) - -2\. Use the search field and filters to find the shipping method that you intend to edit or delete. - -3\. Click the **Edit** button next to the method in the list. - -4\. Edit the necessary details. - -5\. Click **Update** to save your changes. - -## Delete existing shipping method - -1\. In the left panel, go to **Commerce** -> **Shipping methods**. - -2\. Use the search field and filters to find the shipping method that you want to delete. - -3\. Select a box next to its name and click **Delete**. - -!!! note "Shipping methods for existing orders" - - You cannot delete a shipping method if it's active or if it's used by open orders. - You must first deactivate the method that you want to delete by toggling the **Availability** switch off. - -## Filter shipping methods - -1. In the left panel, go to **Commerce** -> **Shipping methods**. -2. Narrow down the list of displayed shipping methods in one of the following ways: - - - search for shipping method by typing part of its name or identifier in the search box - - filter shipping methods by selecting one or more filters - - Available filters are: - - - Method type - method of the shipping - - Availability - shipping method availability: Active, Inactive - - Region - region that the shipping method applies to - -3. Click **Apply** to confirm. diff --git a/docs/content_management/block_reference.md b/docs/content_management/block_reference.md index 4fe1d7b8..f6b3864d 100644 --- a/docs/content_management/block_reference.md +++ b/docs/content_management/block_reference.md @@ -21,7 +21,6 @@ The following blocks are provided with a clean installation of [[= product_name |[Form](#form-block)|Embeds a Form content item that you select from the content structure. | |[Gallery](#gallery-block)|Displays all images contained in a selected folder. | |[[[= product_name_connect =]]](#ibexa-connect-block)|Retrieves and displays data from an [[= product_name_connect =]] webhook. | -|[Orders](#orders-block)|Displays a list of orders associated with a particular company or individual customer. | |[Product collection](#product-collection-block)|Displays a list of specifically selected products.| |[Product embed](#product-embed)|Displays a specific product.| |[RSS](#rss-block)|Loads and displays news from RSS feeds (channels). | @@ -187,18 +186,6 @@ On the **Properties** tab, set values in the following fields: For more information about using [[= product_name_connect =]] scenario block, see [[[= product_name_connect =]] scenario block]([[= developer_doc =]]/content_management/pages/ibexa_connect_scenario_block/) in Developer Documentation. -### Orders block - -Showcases a list of orders linked to a specific company or individual customer. -Helps track purchase history for streamlined customer service and personalized interactions. -On the **Properties** tab, set values in the following fields: - -- **Name** – Enter a name for the page block. -- **Columns** — Select columns that should be displayed in the orders table. Some columns are preselected, for example, Order ID, Customer name, or Total value. -- **Statuses** — Set the statuses of orders that should be included in the list. -- **Number of orders** — Set the number of orders to be displayed. -- **Sort order** — Set the sort order for the displayed orders. - ### Product collection block Presents curated collections of items for easier exploration and discovery. diff --git a/docs/content_management/content_organization/classify_content.md b/docs/content_management/content_organization/classify_content.md index 4b0e9384..87ddba47 100644 --- a/docs/content_management/content_organization/classify_content.md +++ b/docs/content_management/content_organization/classify_content.md @@ -53,7 +53,7 @@ Click **Bookmarks** in the left menu to view a list of all of them.
-## Segments [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Segments [[% include 'snippets/experience_badge.md' %]] With segments you can target content at specific groups of your users. You can use them to display different content to different page visitors. diff --git a/docs/content_management/create_edit_content_items.md b/docs/content_management/create_edit_content_items.md index c3eb6c81..6015a354 100644 --- a/docs/content_management/create_edit_content_items.md +++ b/docs/content_management/create_edit_content_items.md @@ -27,7 +27,7 @@ month_change: true !!! note - If you're using [[= product_name_exp =]] or [[= product_name_com =]], the options include forms and pages. + If you're using [[= product_name_exp =]], the options include forms and pages. You then [build forms](work_with_forms.md) and [create pages](create_edit_pages.md) in their respective specialist tools. 1. [Fill in the fields](#edit-new-or-existing-content-items) of the content item. diff --git a/docs/content_management/schedule_publishing.md b/docs/content_management/schedule_publishing.md index cc4f19d6..0116430a 100644 --- a/docs/content_management/schedule_publishing.md +++ b/docs/content_management/schedule_publishing.md @@ -11,7 +11,7 @@ To do it, use one of the three options: - [Content Scheduler block](#content-scheduler-block) on a Page - [Publish later option](#date-based-publishing) when editing content -## Scheduler tab [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Scheduler tab [[% include 'snippets/experience_badge.md' %]] The **Scheduler** tab is available in the configuration of all Page blocks. You can use it to set the date and time when the block becomes visible and when it disappears from a Page. @@ -20,7 +20,7 @@ This way you can see what content is planned to be available in the future. ![Schedule tab](img/schedule_tab.png) -## Content Scheduler block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Content Scheduler block [[% include 'snippets/experience_badge.md' %]] In the Content Scheduler block you can select content items to be displayed at a selected time. @@ -62,7 +62,7 @@ Then, navigate to the content item that you want to hide and click **Hide** in t Once a content item is hidden, it's unavailable on the front page and inactive in the content tree. This change affects the content item in all of its [locations](content_organization/manage_locations_urls.md#content-locations). -## Timeline [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Timeline [[% include 'snippets/experience_badge.md' %]] The timeline in page mode shows all changes that happen to the page in the future. diff --git a/docs/content_management/translate_content.md b/docs/content_management/translate_content.md index 57f53183..963b06d1 100644 --- a/docs/content_management/translate_content.md +++ b/docs/content_management/translate_content.md @@ -76,7 +76,7 @@ The screen refreshes to display the side by side view of its fields. For more information, see [Work with versions](work_with_versions.md#compare-versions). -## Edit page for different language versions of a website [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Edit page for different language versions of a website [[% include 'snippets/experience_badge.md' %]] When you edit a page, a bar at the top of the screen lists the most recently used [SiteAccesses](multisite.md#siteaccess) on your website. Use this bar to switch between the different versions and work on them. diff --git a/docs/css/pills.css b/docs/css/pills.css index 67b2c18e..a2bb1204 100644 --- a/docs/css/pills.css +++ b/docs/css/pills.css @@ -21,13 +21,6 @@ .pill--experience::after { content: "Experience"; } -.pill--commerce { - color: #A32768; - border-color: #A32768; -} -.pill--commerce::after { - content: "Commerce"; -} .pill--lts-update { color: #5DA7C0; border-color: #5DA7C0; diff --git a/docs/getting_started/dashboard/dashboard.md b/docs/getting_started/dashboard/dashboard.md index 67d47d46..2db2af24 100644 --- a/docs/getting_started/dashboard/dashboard.md +++ b/docs/getting_started/dashboard/dashboard.md @@ -21,7 +21,7 @@ You can return to the **Dashboard** screen from any other page by clicking the [ ![Dashboard icon](dashboard_icon.png) -## Customizable dashboard [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Customizable dashboard [[% include 'snippets/experience_badge.md' %]] You can customize the dashboard depending on your needs. A customized dashboard contains a set of widgets selected by the user. @@ -31,7 +31,7 @@ Customization allows you to quickly visit the areas that are used more often and - Selected widgets boost productivity by highlighting vital data and helping in decision making - Predefined and custom layouts improve visibility for efficient task and deadline management -By default, dashboard in [[= product_name_exp =]] and [[= product_name_com =]] contains the following blocks: +By default, dashboard in [[= product_name_exp =]] contains the following blocks: - [Quick actions](dashboard_block_reference.md#quick-actions-block) - [Recent activity](dashboard_block_reference.md#recent-activity-block) @@ -40,6 +40,6 @@ By default, dashboard in [[= product_name_exp =]] and [[= product_name_com =]] c - [My content](dashboard_block_reference.md#my-content-block) - [Common content](dashboard_block_reference.md#common-content-block) -![Dashboard - Experience and Commerce edition](dashboard.png "Default dashboard in Experience and Commerce edition") +![Dashboard - Experience edition](dashboard.png "Default dashboard in Experience edition") For more information, see [Work with dashboard](work_with_dashboard.md). diff --git a/docs/getting_started/dashboard/dashboard_block_reference.md b/docs/getting_started/dashboard/dashboard_block_reference.md index 6ba3a9df..1e5465e3 100644 --- a/docs/getting_started/dashboard/dashboard_block_reference.md +++ b/docs/getting_started/dashboard/dashboard_block_reference.md @@ -11,12 +11,10 @@ The following blocks are provided with a clean installation of [[= product_name |[Common content](#common-content-block)|Displays a list of content items created by all members of the organization that the user belongs to.| |[Ibexa News](#ibexa-news-block)|Displays a list of recent blog posts or articles published at [ibexa.co blog](https://www.ibexa.co/blog) (product related).| |[My content](#my-content-block)|Displays a list of content items created by the user who is currently logged in.| -|[Orders by status](#orders-by-status-block)|Displays a chart presenting orders and their status.| |[Products by category](#products-by-category-block)|Displays a chart presenting products by their category.| |[Products with lowest stock](#products-by-category-block)|Displays a table presenting products with the lowest stock.| |[Quick actions](#quick-actions-block)|Displays selected mostly used actions and shortcuts.| |[Recent activity](#recent-activity-block)|Displays a list of recent activity of all or selected users.| -|[Recent orders](#recent-orders-block)|Displays a table presenting recent orders and their status.| |[Review queue](#review-queue-block)|Displays a list of content items which user or user group can review.| !!! note @@ -34,7 +32,7 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, select the layout to be used to present a list of content and submit your changes. -## Ibexa News block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Ibexa News block [[% include 'snippets/experience_badge.md' %]] Presents a list of recent blog posts or articles published at `ibexa.co` blog (product related). It includes title, image, publication date, and link to article details. @@ -57,19 +55,7 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, select the layout to be used to present a list of content and submit your changes. -## Orders by status block [[% include 'snippets/commerce_badge.md' %]] - -Displays a chart presenting orders split by status, with their number and percentage. - -On the **Properties** tab, set values in the following fields: - -- **Name** - Enter a name for the block. -- **Statuses** - Set the statuses of orders that should be included in the list. Default value = All. The list of statuses depends on configured [order workflow]([[= developer_doc =]]/commerce/order_management/configure_order_management/) and can be customized. -- **Time period** - Set the time period: All time, Last day, Last week, Last month. Default value = Last month. - -On the **Design** tab, in the **View** field, select the layout to be used to present a list of orders and submit your changes. - -## Products by category block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Products by category block [[% include 'snippets/experience_badge.md' %]] Displays a chart presenting the products split by category, together with the percentage. @@ -83,7 +69,7 @@ On the **Design** tab, in the **View** field, select the layout to be used to pr This block is not supported when you use [[[= pim_product_name =]]](../../product_catalog/quable_integration.md) as the source of product information. -## Products with lowest stock block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Products with lowest stock block [[% include 'snippets/experience_badge.md' %]] Displays a table of products with the lowest stock. Products are sorted based on Stock value (sorted from lowest to highest stock). @@ -100,7 +86,7 @@ On the **Design** tab, in the **View** field, select the layout to be used to pr This block is not supported when you use [[[= pim_product_name =]]](../../product_catalog/quable_integration.md) as the source of product information. -## Quick actions block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Quick actions block [[% include 'snippets/experience_badge.md' %]] Displays selected mostly used actions and shortcuts, for example, **Create content**. @@ -111,7 +97,7 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, select the layout to be used to present a list of quick actions and submit your changes. -## Recent activity block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +## Recent activity block [[% include 'snippets/experience_badge.md' %]] Displays a list of recent activity of all or selected users. It also includes a link to view all activities available in Admin tab. @@ -131,20 +117,6 @@ On the **Properties** tab, set values in the following fields: On the **Design** tab, in the **View** field, select the layout to be used to present a list of content items for review and submit your changes. -## Recent orders block [[% include 'snippets/commerce_badge.md' %]] - -Displays a table presenting recent orders with the newest creation date/recently placed. - -Table contains following columns: Order ID, Company name, Customer name, Unique items, Total value, Status, Created. - -On the **Properties** tab, set values in the following fields: - -- **Name** - Enter a name for the block. -- **Statuses** - Set the statuses of orders that should be included in the list: Pending, Processing, Cancelled, Completed. Default value = All. -- **Number of orders** - Set a maximum number of orders to be displayed. Default value = 10. - -On the **Design** tab, in the **View** field, select the layout to be used to present a list of orders and submit your changes. - ## Review queue block Displays a list of content items which user or user group can review. diff --git a/docs/getting_started/discover_ui.md b/docs/getting_started/discover_ui.md index 648a5436..fed2d8b5 100644 --- a/docs/getting_started/discover_ui.md +++ b/docs/getting_started/discover_ui.md @@ -62,7 +62,7 @@ Depending on the product edition and your [permissions](../permission_management - **Content**, which gives you access to the content repository. It lets you navigate the content tree, and, for example, create, edit, move, copy, or delete content. -- [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] **Site management**, which enables you to create and edit block-based pages and manage multiple websites. +- [[% include 'snippets/experience_badge.md' %]] **Site management**, which enables you to create and edit block-based pages and manage multiple websites. - **Product catalog**, which enables you to handle products presented on the website, including their specifications and pricing. - **Admin**, which is the administration panel where you can manage, for example, Users, Sections, or permissions. diff --git a/docs/images/icons.svg b/docs/images/icons.svg index 11c6f67d..82aa3abe 100644 --- a/docs/images/icons.svg +++ b/docs/images/icons.svg @@ -48,9 +48,6 @@ - - - diff --git a/docs/index.md b/docs/index.md index 950205fe..16f9247e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -130,7 +130,6 @@
@@ -219,27 +218,6 @@ -
- -