Skip to content

Commit e0315ee

Browse files
authored
IBX-9681: Discounts described in user doc (#359)
* IBX-9681: Discounts described in user doc
1 parent 48532f9 commit e0315ee

19 files changed

+216
-7
lines changed

docs/commerce/commerce.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ edition: commerce
77

88
[[= product_name =]] provides a Commerce solution that consists of several modules.
99
You can use them to create a unified and streamlined e-commerce platform.
10-
Modules interact with each other, for example, to decrease stock following a sale, or cancel shipments and payments when orders are cancelled.
10+
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.
1111

1212
The solution complements functionalities provided by the [PIM](products.md) offering, and allows you to sell products through the website.
1313
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.
@@ -27,5 +27,6 @@ Once the order is placed, users can interact with it by working with the followi
2727
[[= cards([
2828
"commerce/order_management/order_management",
2929
"commerce/payment/payment_management",
30-
"commerce/shipping_management/shipping_management"
31-
], columns=3) =]]
30+
"commerce/shipping_management/shipping_management",
31+
"commerce/discounts/discounts"
32+
], columns=3) =]]
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
description: Increase conversion and attract customers by offering them products at discounted prices.
3+
editions:
4+
- lts-update
5+
- commerce
6+
month_change: true
7+
---
8+
9+
# Discounts
10+
11+
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.
12+
13+
![Cart with discount](discount_cart.png)
14+
15+
The **Discounts** module is not included in [[= product_name =]] by default.
16+
It's an [LTS Update]([[= developer_doc =]]/ibexa_products/editions#lts-updates) that requires separate [installation]([[= developer_doc =]]/discounts/install_discounts/).
17+
18+
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.
19+
20+
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.
21+
22+
### Interaction with other modules
23+
24+
The **Discounts** module interacts with other parts of the system, so that store customers can:
25+
26+
- in the product catalog, see base prices of products together with prices reduced according to active catalog discounts
27+
- 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
28+
- at checkout, see a total value of all applied discounts and prices reduced as a result of those discounts
Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
---
2+
description: Create and edit discounts, toggle discount status.
3+
editions:
4+
- lts-update
5+
- commerce
6+
month_change: true
7+
---
8+
9+
# Work with discounts
10+
11+
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).
12+
13+
## View discount information in discounts list
14+
15+
1. In the left panel, go to **Commerce** -> **Discounts**.
16+
17+
Here, you can see a list of discounts, together with information about their validity period, status, type, and their authors.
18+
19+
2. Narrow down the list of displayed discounts in one of the following ways:
20+
21+
- search for a discount by typing in a part of its name or identifier in the search field
22+
- filter discounts by selecting one or more of the following filters:
23+
- **Discount type**: applicable to catalog or cart products
24+
- **Status**: active, inactive or disabled
25+
- **Created**: start and end of date range within which the discount was created
26+
- **Validity period**: start and end of date range within which the discount is in force
27+
28+
![Discount filters](discount_filters.png)
29+
30+
3. Click **Apply** to confirm your choices.
31+
32+
4. To clear all the filters, click **Clear filters**.
33+
34+
### Instantly disable discount
35+
36+
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.
37+
38+
To disable the offending discount, find it in the discount list and, in its line, click the **Disable** icon.
39+
40+
![Discount filters](discount_disable_icon.png)
41+
42+
### View discount details
43+
44+
To view the details of a discount, click its line in the discount list.
45+
On the discount details screen, you can see an overview of the discount's details.
46+
47+
Discount details include basic information about the discount:
48+
49+
- validity period and value of the discount
50+
- region and currency that the discount applies to
51+
- whether the discount applies to all customers or a selected customer group,
52+
- whether any conditions apply
53+
54+
![Discount detail view](discount_detail_view.png)
55+
56+
On other tabs within this screen you can see:
57+
58+
- products subject to the discount
59+
- users who have authored or modified the discount
60+
- translations created for the discount
61+
62+
### Add translations
63+
64+
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).
65+
66+
## Create new discount
67+
68+
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.
69+
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.
70+
Cart discount applicability can be further limited by setting a number of conditions, such as:
71+
72+
- a number of products in the cart
73+
- total purchase value
74+
- a discount code
75+
76+
!!! note "Navigating through the steps"
77+
78+
When you define discount details, you can go back to change your choices.
79+
To do it, click a step header at the top of the screen.
80+
81+
![Discount creator steps](discount_creator_headers.png)
82+
83+
1. In the left panel, go to **Commerce** -> **Discounts**, and click **Create**.
84+
85+
2. Select whether the discount applies to catalog or cart products and the discount's type.
86+
87+
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.
88+
89+
![New discount](new_discount.png)
90+
91+
3. In the **General properties** screen, provide general information about the new discount:
92+
93+
1. In the **Global properties** area, provide an internal name of the discount and set the validity period.
94+
Toggle the **Permanent discount** on to make the discount valid until you manually disable it.
95+
1. Then, select discount priority to help the system choose between discounts to apply when calculating the final price.
96+
97+
!!! note "Only one discount at a time"
98+
99+
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.
100+
For example, cart discounts surpass catalog discounts.
101+
102+
For more information, see [the product guide]([[= developer_doc =]]/discounts/discounts_guide/#discounts-priority).
103+
104+
1. If your store supports multiple markets, you can select a region that the discount applies to.
105+
1. If you are creating a fixed-amount discount, select a currency of the discount.
106+
107+
![Creating a new discount](create_new_discount.png)
108+
109+
1. In the **Promotion information** area, provide a name and description of the promotional campaign, as they should be shown to customers.
110+
111+
![Adding information about the promotion](discounts_promo_info.png)
112+
113+
1. Click **Next** to go to the next screen.
114+
115+
116+
4. In the **Target group** screen, select customers that the new discount is targeted at.
117+
You can choose everyone, or select one or more customer groups.
118+
119+
![Customer selection](discounts_select_customers.png)
120+
121+
5. In the **Products** screen, select products that the discount applies to. You can choose between:
122+
123+
- all products from the catalog, for example, to clear stock before the end of year
124+
- products from a specific category, for example, promotional gadgets for company partners
125+
- specific products or even product variants, to activate slow-moving inventory
126+
127+
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.
128+
129+
![Product picker](product_picker.png)
130+
131+
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:
132+
133+
- added to cart no less than a specific number of certain items
134+
- added products to a cart for no less than a specified total value
135+
- entered a specified discount code
136+
137+
If you set the discount code, you can also set the number of times that the code can be used.
138+
139+
![Cart discount conditions](cart_discount_conditions.png)
140+
141+
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.
142+
Otherwise, enter a monetary value to be deducted from the base price.
143+
144+
8. In the **Summary** screen, review the details of the discount that you are creating, and click **Save and close** to save the discount.
145+
Depending on the settings, you may see a warning message.
146+
147+
![Discount summary screen notice](discounts_summary_notice.png)
148+
149+
## Edit existing discount
150+
151+
You may find that an existing discount needs to be modified, for example, to change its validity period or target group.
152+
153+
1. In the left panel, go to **Commerce** -> **Discounts**.
154+
155+
![Discounts list](discount_list.png)
156+
157+
2. Use the search field and filters to find the discount that you want to edit.
158+
159+
3. Click the **Edit** button next to the discount in the list.
160+
161+
4. Edit the necessary details as described in [Create new discount](#create-new-discount).
162+
163+
5. **Save and close** to save your changes.
164+
165+
## Delete existing discount
166+
167+
When there are too many discounts in the system, you may want to delete historic, unused ones.
168+
You can only delete disabled discounts.
169+
170+
1. In the left panel, go to **Commerce** -> **Discounts**.
171+
172+
2. Use the search field and filters to find the discount that you want to delete.
173+
174+
3. If the discount that you want to delete is not disabled, use the **Disable** icon to [disable it](#instantly-disable-discount).
175+
176+
4. Select a box next to the discount's name and click **Delete**.
36.8 KB
Loading
48.8 KB
Loading
132 KB
Loading
6.57 KB
Loading
79.8 KB
Loading
18.9 KB
Loading
22.8 KB
Loading

0 commit comments

Comments
 (0)