DirectOrder

This section describes the available actions in the direct order area. With these actions, products can be entered into the session’s order form list by article number, changed, and removed again. They also control the number of input rows.

The DirectOrder actions do not add anything to the basket. Transferring the captured items is a separate step that uses the BasketItemAdd action. A complete example can be found under Transfer items to the basket.

Actions overview

Action	Description
`DirectOrderAdd`	Enters a product into the order form list by article number or increases the quantity of an existing item.
`DirectOrderUpdate`	Sets the quantity of an item in the order form list. If the item does not exist yet, it is created.
`DirectOrderDelete`	Removes an item from the order form list.
`DirectOrderAddLines`	Adds `refreshedNumber` input rows, up to `maximalNumber` at most.
`DirectOrderDeleteLines`	Removes `refreshedNumber` input rows, never below `initialNumber`.

Actions

DirectOrderAdd

This action enters a product into the order form list based on its article number. If the product is already in the list, the action adds the new quantity to the existing quantity. After successful execution, the item is set in $wsDirectOrder.items. The article number comes either from the id field or from the configured article number fields. The latter are only evaluated if the id field is empty. Usage example
Can be used on the direct order page, where customers can quickly search for products by article number and add them to the order list without having to open the product detail page. Parameters

Name	Description
`id`	The article number, product number, EAN, or ISBN of the product.
`quantity`	Required The quantity. If it is missing, the action reports `missingQuantity`.
Names of the article number fields	The input fields configured in `itemNumberFields` under `checkout.directOrder`, for example `firstField`. Only evaluated if `id` is empty.
`insert`	The insert code of the item. Only used if the shop has not split off a code from the entered article number.

Errors

Error field	Error codes
`errorsByField.id`	`missingId`, `invalidId`, `productHasNoVariants`, `variantDoesNotExist`, `baseProductCanNotBeChosen`
`errorsByField.quantity`	`missingQuantity`, `invalidQuantity`
`errorsByField.<fieldName>`	`itemNumberCheckFailed`, `missingId` for an empty required field

The error texts and the exact mapping can be found under actions.directOrder. Related modules, variables & methods

Example showing how a product is added to the direct order list via an article number input field.

{{ var $myActionDirectOrderAdd = $wsActions.create("DirectOrderAdd", tag=string($myDirectOrderProduct)) }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionDirectOrderAdd.csrf }}">
    <input type="text" name="id" value="{{= $wsDirectOrder.items[$myDirectOrderProduct].id | ifNull('') }}">
    <input type="text" name="quantity" value="{{= $wsDirectOrder.items[$myDirectOrderProduct].quantity | ifNull('1') }}">
    <button type="submit" name="wsact" value="{{= $myActionDirectOrderAdd.id }}">Search product.</button>
</form>

DirectOrderUpdate

This action sets the quantity of an item in the order form list. Unlike DirectOrderAdd, the quantity is not added but replaced. If the product number is not yet in the list, the action creates the item. Usage example
Can be used on the direct order page when a customer wants to adjust the quantity of a product that has already been entered. Parameters

Name	Description
`id`	The product number of the item. Alternatively, the names of the article number fields as with `DirectOrderAdd`.
`quantity`	Required The new quantity of the product.
`insert`	The insert code of the item, as with `DirectOrderAdd`.

Errors The action can report the same errors as DirectOrderAdd. Related modules, variables & methods

Example showing how the quantity of an item in the direct order list is updated via an input field.

{{ var $myActionDirectOrderUpdate = $wsActions.create("DirectOrderUpdate", tag=string($myDirectOrderProduct)) }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionDirectOrderUpdate.csrf }}">
    <input type="hidden" name="id" value="{{= $wsDirectOrder.items[$myDirectOrderProduct].id }}">
    <input type="text" name="quantity" value="{{= $wsDirectOrder.items[$myDirectOrderProduct].quantity | ifNull('1') }}">
    <button type="submit" name="wsact" value="{{= $myActionDirectOrderUpdate.id }}">Update product.</button>
</form>

DirectOrderDelete

This action removes a product from the direct order list. Usage example
Can be used on the direct order page when a customer wants to remove a product from the order list. Parameters

Name	Description
`id`	The product number determined by the shop from `$wsDirectOrder.items[…].id`, not the article number entered by the customer.

Errors

Error field	Error codes
`errorsByField.id`	`invalidId` if `id` is missing or empty

Related modules, variables & methods

Example showing how a product is removed from the direct order list via a button.

{{ var $myActionDirectOrderDelete = $wsActions.create("DirectOrderDelete", tag=string($myDirectOrderProduct)) }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionDirectOrderDelete.csrf }}">
    <input type="hidden" name="id" value="{{= $wsDirectOrder.items[$myDirectOrderProduct].id }}">
    <button type="submit" name="wsact" value="{{= $myActionDirectOrderDelete.id }}">Remove product.</button>
</form>

DirectOrderAddLines

This action adds further input rows to the order form so the customer can enter several products at once. The number is defined by refreshedNumber under checkout.directOrder (default 5). The total number of rows increases to maximalNumber at most. Usage example
Can be used on the direct order page when a customer wants to enter more products than there are currently input rows. Related modules, variables & methods

Example showing how a new input row is added to the direct order list via a button.

{{ var $myActionDirectOrderAddLines = $wsActions.create("DirectOrderAddLines") }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wsact" value="{{= $myActionDirectOrderAddLines.id }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionDirectOrderAddLines.csrf }}">
    <button type="submit">Add row.</button>
</form>

DirectOrderDeleteLines

This action removes input rows from the order form. Their number is defined by refreshedNumber. However, the total number of rows never drops below initialNumber. Usage example
Can be used on the direct order page when a customer has added too many rows and wants to remove them again. Related modules, variables & methods

Example showing how input rows are removed via a button. The button only appears if more rows are displayed than initialNumber specifies.

{{ if $wsDirectOrder.currentLines > $wsConfig.directOrder.initialNumber }}
    {{ var $myActionDirectOrderDeleteLines = $wsActions.create("DirectOrderDeleteLines") }}
    <form method="post" action="{{= $wsViews.current.url() }}">
        <input type="hidden" name="wsact" value="{{= $myActionDirectOrderDeleteLines.id }}">
        <input type="hidden" name="wscsrf" value="{{= $myActionDirectOrderDeleteLines.csrf }}">
        <button type="submit">Remove rows.</button>
    </form>
{{ /if }}

Frontend

The basics

Getting started

Feature overview

Examples

Reference – Actions

Reference – Language

Reference – Modules

Actions overview

Actions

DirectOrderAdd

DirectOrderUpdate

DirectOrderDelete

DirectOrderAddLines

DirectOrderDeleteLines

​Actions overview

​Actions

​DirectOrderAdd

​DirectOrderUpdate

​DirectOrderDelete

​DirectOrderAddLines

​DirectOrderDeleteLines

Actions overview

Actions

DirectOrderAdd

DirectOrderUpdate

DirectOrderDelete

DirectOrderAddLines

DirectOrderDeleteLines