Skip to content
  • Documentation >
  • Commerce >
  • Shopping list >
  • Shopping list API

Shopping list APIs

The shopping list APIs allow managing shopping lists. The cart APIs includes methods to move products from cart to shopping list and vice versa.

About the default shopping list

There is one default shopping list per user. This default shopping list is created only when a user uses it for the first time.

The default shopping list is created by \Ibexa\Contracts\ShoppingList\ShoppingListServiceInterface::getOrCreateDefaultShoppingList(). For example, starting to use the default list from REST API will create it if it doesn't exist, as during a call to POST /shopping-list/default/entries](/api/rest_api/rest_api_reference/rest_api_reference.html#tag/Shopping-Lists/operation/api_shopping-listdefaultentries_post) or [POST /cart/{identifier}/move-to-shopping-list`.

PHP API

TODO: Ibexa\Contracts\ShoppingList

TODO: Ibexa\Contracts\ShoppingList\ShoppingListServiceInterface

TODO: Ibexa\Contracts\Cart\CartShoppingListTransferServiceInterface

TODO: Shopping list event reference

REST API

TODO: * /shopping-list/*

TODO: POST /cart/{identifier}/move-entries-to-shopping-list TODO: POST /cart/{identifier}/move-entries-to-shopping-list/{shoppingListIdentifier} TODO: POST /cart/{identifier}/move-to-shopping-list TODO: POST /cart/{identifier}/move-to-shopping-list/{shoppingListIdentifier}