Skip to content

Shopping list #2969

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.

Sign up for GitHub

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

Draft
adriendupuis wants to merge 10 commits into
base: 5.0
Choose a base branch
from
Draft

Shopping list #2969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d9394c8
start Shopping list skeleton
adriendupuis Dec 3, 2025
4da1c78
start Shopping list feature guide
adriendupuis Dec 4, 2025
674bcfb
api_refs.sh: Add shopping-list
adriendupuis Dec 5, 2025
eb16b86
shopping list cards
adriendupuis Dec 8, 2025
08d4f86
enhance cards
adriendupuis Dec 8, 2025
ab19ccd
draft shopping_list_guide.md and install_shopping_list.md
adriendupuis Dec 9, 2025
6fd2514
shopping list APIs and use cases drafts
adriendupuis Dec 18, 2025
16bf9ab
Shopping list events
adriendupuis Dec 18, 2025
3bf4298
Continue API doc skeleton
adriendupuis Dec 19, 2025
fe36e0f
Merge branch '5.0' into shopping-list
adriendupuis Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/api/event_reference/shopping_list_events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
description: Events that are triggered when working with shopping lists.
editions: lts-update commerce
page_type: reference
---

# Shopping List events

| Event | Dispatched by | Description |
|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| [`BeforeCreateShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeCreateShoppingListEvent.html) | [`ShoppingListService::createShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_createShoppingList) | Dispatched before a shopping list is created. Allows to modify or prevent creation. |

Check failure on line 11 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L11 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 11, "column": 76}}}, "severity": "ERROR"}

Check failure on line 11 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L11 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 11, "column": 232}}}, "severity": "ERROR"}
| [`CreateShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-CreateShoppingListEvent.html) | [`ShoppingListService::createShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_createShoppingList) | Dispatched after a shopping list is created. |

Check failure on line 12 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L12 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 12, "column": 70}}}, "severity": "ERROR"}

Check failure on line 12 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L12 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 12, "column": 232}}}, "severity": "ERROR"}
| [`BeforeUpdateShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeUpdateShoppingListEvent.html) | [`ShoppingListService::updateShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_updateShoppingList) | Dispatched before a shopping list is updated. Allows to modify or prevent update. |

Check failure on line 13 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L13 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 13, "column": 76}}}, "severity": "ERROR"}

Check failure on line 13 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L13 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 13, "column": 232}}}, "severity": "ERROR"}
| [`UpdateShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-UpdateShoppingListEvent.html) | [`ShoppingListService::updateShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_updateShoppingList) | Dispatched after a shopping list is updated. |

Check failure on line 14 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L14 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 14, "column": 70}}}, "severity": "ERROR"}

Check failure on line 14 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L14 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 14, "column": 232}}}, "severity": "ERROR"}
| [`BeforeDeleteShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeDeleteShoppingListEvent.html) | [`ShoppingListService::deleteShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_deleteShoppingList) | Dispatched before a shopping list is deleted. Allows to prevent deletion. |

Check failure on line 15 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L15 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 15, "column": 76}}}, "severity": "ERROR"}

Check failure on line 15 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L15 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 15, "column": 232}}}, "severity": "ERROR"}
| [`DeleteShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-DeleteShoppingListEvent.html) | [`ShoppingListService::deleteShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_deleteShoppingList) | Dispatched after a shopping list is deleted. |

Check failure on line 16 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L16 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 16, "column": 70}}}, "severity": "ERROR"}

Check failure on line 16 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L16 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 16, "column": 232}}}, "severity": "ERROR"}
| [`BeforeClearShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeClearShoppingListEvent.html) | [`ShoppingListService::clearShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_clearShoppingList) | Dispatched before a shopping list is cleared. Allows to modify or prevent clearing. |

Check failure on line 17 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L17 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 17, "column": 75}}}, "severity": "ERROR"}

Check failure on line 17 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L17 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 17, "column": 231}}}, "severity": "ERROR"}
| [`ClearShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-ClearShoppingListEvent.html) | [`ShoppingListService::clearShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_clearShoppingList) | Dispatched after a shopping list is cleared. |

Check failure on line 18 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L18 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 18, "column": 69}}}, "severity": "ERROR"}

Check failure on line 18 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L18 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 18, "column": 231}}}, "severity": "ERROR"}
| [`BeforeAddEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeAddEntriesEvent.html) | [`ShoppingListService::addEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_addEntries) | Dispatched before entries are added to a shopping list. Allows to modify or prevent addition. |

Check failure on line 19 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L19 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 19, "column": 68}}}, "severity": "ERROR"}

Check failure on line 19 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L19 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 19, "column": 224}}}, "severity": "ERROR"}
| [`AddEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-AddEntriesEvent.html) | [`ShoppingListService::addEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_addEntries) | Dispatched after entries are added to a shopping list. |

Check failure on line 20 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L20 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 20, "column": 62}}}, "severity": "ERROR"}

Check failure on line 20 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L20 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 20, "column": 224}}}, "severity": "ERROR"}
| [`BeforeRemoveEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeRemoveEntriesEvent.html) | [`ShoppingListService::removeEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_removeEntries) | Dispatched before entries are removed from a shopping list. Allows to modify or prevent removal. |

Check failure on line 21 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L21 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 21, "column": 71}}}, "severity": "ERROR"}

Check failure on line 21 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L21 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 21, "column": 227}}}, "severity": "ERROR"}
| [`RemoveEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-RemoveEntriesEvent.html) | [`ShoppingListService::removeEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_removeEntries) | Dispatched after entries are removed from a shopping list. |

Check failure on line 22 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L22 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 22, "column": 65}}}, "severity": "ERROR"}

Check failure on line 22 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L22 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 22, "column": 227}}}, "severity": "ERROR"}
| [`BeforeMoveEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeMoveEntriesEvent.html) | [`ShoppingListService::moveEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_moveEntries) | Dispatched before entries are moved to another shopping list. Allows to modify or prevent moving. |

Check failure on line 23 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L23 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 23, "column": 69}}}, "severity": "ERROR"}

Check failure on line 23 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L23 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 23, "column": 225}}}, "severity": "ERROR"}
| [`MoveEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-MoveEntriesEvent.html) | [`ShoppingListService::moveEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_moveEntries) | Dispatched after entries are moved to another shopping list. |

Check failure on line 24 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L24 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 24, "column": 63}}}, "severity": "ERROR"}

Check failure on line 24 in docs/api/event_reference/shopping_list_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/shopping_list_events.md#L24 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/shopping_list_events.md", "range": {"start": {"line": 24, "column": 225}}}, "severity": "ERROR"}
Loading