-
Notifications
You must be signed in to change notification settings - Fork 7
IBX-9681: Discounts described in user doc #359
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
cdeb814
d0ab540
e44a56a
ff438a6
8bc2823
ac9b926
b93e59e
01e74a4
f86ca6b
6a87d64
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
|
Check warning on line 1 in docs/commerce/discounts/discounts.md
|
||
| description: Increase conversion and attract customers by offering them products at discounted prices. | ||
| editions: | ||
| - lts-update | ||
| - commerce | ||
| month_change: true | ||
| --- | ||
|
|
||
| # 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. | ||
|
Check warning on line 11 in docs/commerce/discounts/discounts.md
|
||
|
|
||
|  | ||
|
|
||
| The **Discounts** module is not included in [[= product_name =]] by default. | ||
| It's an [LTS Update]([[= developer_doc =]]/ibexa_products/editions#lts-updates) that requires separate [installation]([[= developer_doc =]]/discounts/install_discounts/). | ||
|
|
||
| Once the module is installed, 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. | ||
|
Check warning on line 20 in docs/commerce/discounts/discounts.md
|
||
|
|
||
| ### 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 | ||
|
Check warning on line 27 in docs/commerce/discounts/discounts.md
|
||
| - at checkout, see a total value of all applied discounts and prices reduced as a result of those discounts | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| --- | ||
|
Check warning on line 1 in docs/commerce/discounts/work_with_discounts.md
|
||
| description: Create and edit discounts, toggle discount status. | ||
| editions: | ||
| - lts-update | ||
| - commerce | ||
| month_change: true | ||
| --- | ||
|
|
||
| # 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 | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| ### 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: | ||
|
Check warning on line 47 in docs/commerce/discounts/work_with_discounts.md
|
||
|
|
||
| - 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 | ||
|
|
||
|  | ||
|
|
||
| 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](../../pim/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. | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
|
Check warning on line 106 in docs/commerce/discounts/work_with_discounts.md
|
||
|  | ||
|
|
||
| 1. In the **Promotion information** area, provide a name and description of the promotional campaign, as they should be shown to customers. | ||
|
|
||
|  | ||
|
|
||
| 1. Click **Next** to go to the next screen. | ||
|
|
||
|
Check warning on line 114 in docs/commerce/discounts/work_with_discounts.md
|
||
|
|
||
|
Check warning on line 115 in docs/commerce/discounts/work_with_discounts.md
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| 5. In the **Products** screen, select products that the discount applies to. You can choose between: | ||
|
|
||
|
Check warning on line 122 in docs/commerce/discounts/work_with_discounts.md
|
||
| - 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. | ||
|
Check warning on line 127 in docs/commerce/discounts/work_with_discounts.md
|
||
|
|
||
|  | ||
|
|
||
| 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 also set the number of times that the code can be used. | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
Check warning on line 142 in docs/commerce/discounts/work_with_discounts.md
|
||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| ## Edit existing discount | ||
|
|
||
| You may find that an existing discount needs to be modified, for example, to change its validity period or target group. | ||
|
Check warning on line 151 in docs/commerce/discounts/work_with_discounts.md
|
||
|
|
||
| 1. In the left panel, go to **Commerce** -> **Discounts**. | ||
|
|
||
|  | ||
|
|
||
| 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**. | ||
Uh oh!
There was an error while loading. Please reload this page.