You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/commerce/shopping_list/shopping_list_guide.md
+27-12Lines changed: 27 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ month_change: true
6
6
7
7
# Shopping list feature guide
8
8
9
-
Shopping lists give customers a simple yet powerful way to manage future purchases.
9
+
Shopping lists give logged-in customers a simple yet powerful way to manage future purchases.
10
10
It can cover many purchase planning cases.
11
11
12
12
## Use cases
@@ -29,28 +29,43 @@ even several products fulfilling the same purpose to decide latter wish ones to
29
29
30
30
Policies can give the rights to create, view, edit, and delete shopping lists.
31
31
Authenticated customers can be granted with those rights on their own shopping lists.
32
+
For more information, see [Shopping list user role](install_shopping_list.md#shopping-list-user-role).
32
33
33
-
Such customer can
34
+
A customer always have a default shopping list named "My Wishlist"
35
+
which is created automatically on first use,
36
+
which can't be renamed, and can't be deleted.
37
+
According to configuration, customers can have a limited amount of additional custom shopping lists.
38
+
The number of products a shopping list can contain is also limited by configuration.
39
+
40
+
A shopping list only stores product codes.
41
+
A shopping list doesn't store quantities.
42
+
43
+
In the out-of-the-box storefront, a shopping list user can:
34
44
35
45
- Create a shopping list
36
46
- in shopping lists management interface
47
+

37
48
- from catalog when adding a product to a shopping list
38
-
- from cart when saving for later into a shopping list
49
+

50
+
- from a shopping list when moving products from one shopping list to another
51
+

39
52
- Add product (or product variant) to a shopping list
40
53
- Rename a shopping list (except the default "My Wishlist")
41
-
-List existing shopping lists
42
-
- View a shopping list product list
54
+
-View the list of their shopping lists
55
+
- View a shopping list and its product list
43
56
- Move products from a shopping list to another shopping list
44
-
- TODO: Copy products from a shopping list to another shopping list
45
57
- Remove product from a shopping list
46
-
- Clear all products from a shopping list
47
-
- Copy product from a shopping list to cart (products are kept in shopping list while added to the cart)
58
+
- Copy product from a shopping list to cart (product is kept in shopping list while added to the cart)
48
59
- Copy a whole shopping list to cart (products are kept in shopping list while added to the cart)
49
-
- Move products from cart to a shopping list (product are removed from cart and added to the shopping list)
60
+
- products are kept in shopping list while added to the cart
61
+
- products out-of-stock aren't copied and the user is warned
62
+
- products are added with quantity 1, the user can adjust quantities in the cart afterward
50
63
- Move a whole cart to a shopping list (products are removed from cart and added to the shopping list)
51
64
- Delete a shopping list
52
65
53
-
A shopping list only stores product codes.
54
-
A shopping list doesn't store quantities.
66
+
## Extensibility
67
+
68
+
The [PHP API](shopping_list_api.md#php-api) and the [REST API](shopping_list_api.md#rest-api) already offers few functionalities not used in the default storefront,
69
+
such as to empty a whole shopping list, or to copy products from a shopping list to another (instead of moving them).
55
70
56
-
TODO: illustrate with storefront screenshots?
71
+
Those APIs can be used to implement custom features, and can themselves be extended to cover more use cases.
0 commit comments