Inventory

This section describes the available actions in the Inventory area. With these actions, product reservations can be renewed and back-in-stock notifications can be managed.

Actions overview

Action	Description
`InventoryReserve`	Renews the reservation of a product in the basket.
`BackInStockActivateNotify`	Activates a notification when a product is available again.
`BackInStockDeactivateNotify`	Deactivates an existing back-in-stock notification.

Actions

InventoryReserve

This action renews the reservation of a product in the basket. It is only relevant if the reservation duration of an item has expired and the customer wants to extend the reservation. Usage example
Can be used on the basket page when the reservation time of an item has expired and the customer should be given the option to renew the reservation. Parameters

Name	Description
`basketItemId`	The ID of the basket entry whose reservation should be renewed.

Error codes

Error code	Description
`inventoryInactive`	Inventory management is not active, so a reservation is not possible.
`missingBasketItemId`	Parameter `basketItemId` is missing.
`invalidBasketItemId`	The basket entry does not exist or does not belong to this basket.
`setChildReserveActionInvalid`	The basket entry is part of a set. Parts of a set cannot be reserved individually.
`noReservationFound`	There is no reservation for the basket entry that could be renewed.
`insufficentAmount`	The available stock is not sufficient for a renewed reservation.

The error code insufficentAmount is output in this spelling. The associated error text is located in the configuration under insufficientAmount and in the text module ws.error.inventoryReserve.insufficientAmount.

Related modules, variables & methods

Example showing how a customer with an expired reservation is given the option to renew it via a button.

{{ var $myReservation = $wsInventory.loadReservation($myProduct.id) }}
{{ if $myReservation and $myReservation.duration == 0 }}
    {{ var $myActionInventoryReserve = $wsActions.create("InventoryReserve", tag=$myProduct.id) }}
    <form method="post" action="{{= $wsViews.viewUrl('basket.htm') }}">
        <input type="hidden" name="wscsrf" value="{{= $myActionInventoryReserve.csrf }}">
        <input type="hidden" name="wsact" value="{{= $myActionInventoryReserve.id }}">
        <input type="hidden" name="wstarget" value="{{= $wsViews.viewUrl('basket.htm') }}">
        <input type="hidden" name="basketItemId" value="{{= $myProduct.id }}">
        <button type="submit">Renew reservation.</button>
    </form>
{{ /if }}

BackInStockActivateNotify

This action activates a notification that informs the customer by email as soon as a sold-out product is available again. For this purpose, the shop stores the inventory status that the product has at the time of activation. The email is sent as soon as the availability traffic light improves, i.e. from red to yellow or from yellow to green. No login is required for this action. If the customer is logged in, the notification is additionally assigned to their customer account and appears under $wsAccount.backInStockList. Usage example
Can be used on the product detail page when a product is sold out and the customer wants to be notified as soon as it can be ordered again. Parameters

Name	Description
`productId`	The ID of the product for which the notification should be activated.
`email`	The email address to which the notification should be sent.
`storeId`	Optional. ID of the store whose inventory is decisive. If not specified, the inventory of the subshop applies.

Error codes

Error code	Description
`notAllowed`	Back-in-stock notifications are not enabled in the shop.
`missingEmail`	Parameter `email` is missing.
`missingProductId`	Parameter `productId` is missing.
`invalidStoreId`	`storeId` is not a valid number or there is no store with this ID.
`missingInventoryState`	No inventory status is available for the product.
`entryExists`	A notification is already activated for this product and this email address.

Related modules, variables & methods

Example showing how a customer can activate a notification for a sold-out product.

{{ var $myActionBackInStockActivateNotify = $wsActions.create("BackInStockActivateNotify") }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionBackInStockActivateNotify.csrf }}">
    <input type="hidden" name="wsact" value="{{= $myActionBackInStockActivateNotify.id }}">
    <input type="hidden" name="productId" value="{{= $myProduct.id }}">
    <input type="email" name="email">
    <button type="submit">Be notified when the product is back in stock.</button>
</form>

BackInStockDeactivateNotify

This action deactivates an existing back-in-stock notification. Usage example
Can be used on the account overview page, where logged-in customers can view and remove their active notifications. The action requires a login. Parameters

Name	Description
`productId`	The ID of the product for which the notification should be deactivated.
`email`	The email address for which the notification should be deactivated.

Error codes

Error code	Description
`notAllowed`	Back-in-stock notifications are not enabled in the shop.
`notLoggedIn`	The customer is not logged in.
`missingEmail`	Parameter `email` is missing.
`missingProductId`	Parameter `productId` is missing.
`entryNotFound`	There is no active notification for this product and this email address.

Related modules, variables & methods

Example showing how an active notification is deactivated via a button.

{{ var $myActionBackInStockDeactivateNotify = $wsActions.create("BackInStockDeactivateNotify") }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionBackInStockDeactivateNotify.csrf }}">
    <input type="hidden" name="wsact" value="{{= $myActionBackInStockDeactivateNotify.id }}">
    <input type="hidden" name="productId" value="{{= $myProduct.id }}">
    <input type="hidden" name="email" value="{{= $myProduct.email }}">
    <button type="submit">%%DeleteFromNotification%%</button>
</form>

Frontend

The basics

Getting started

Feature overview

Examples

Reference – Actions

Reference – Language

Reference – Modules

Actions overview

Actions

InventoryReserve

BackInStockActivateNotify

BackInStockDeactivateNotify

​Actions overview

​Actions

​InventoryReserve

​BackInStockActivateNotify

​BackInStockDeactivateNotify

Actions overview

Actions

InventoryReserve

BackInStockActivateNotify

BackInStockDeactivateNotify