basket - Basket - WEBSALE Dokumentation

The basket section covers all settings around the shopping basket of the online shop.
This is where you control how the basket behaves, which items are automatically added and how long basket data is stored. Typical configuration options include:

Automatic add-ons — defines products that are automatically placed in the basket when the shop is first loaded (e.g. surprise products).
Basket cookies — defines whether a cookie-based basket is active, how long it is stored and how the system behaves when a user returns.
General basket options — for example, the maximum number of items, behaviour on price changes or synchronisation between sessions.

`basket*` - Basic structure

The basic structure of the basket node is shown below:

{
"basket": {
  "autobasket": { ... },
  "basket": { ... }
 }
}

Parameter description

Parameter	Description
`autobasket`	Automatically added basket positions. Contains a list of entries per country / shop.
`basket`	Basic basket behaviour: persistence via account/cookie, validity period, behaviour on sign-in/sign-out, maximum item quantity.

`basket.basket` - Basket settings

The basket node controls the basic behaviour of the basket in the shop. It defines whether baskets are stored per user, how long cookies are valid, and how the basket reacts on sign-in or sign-out. These settings therefore determine how durably a basket is preserved and how the system behaves for returning users. Typical use cases:

Activation of a persistent basket via customer account or cookie
Definition of the validity period of stored baskets
Control of whether a basket is deleted or kept on sign-out
Limitation of the maximum item quantity in the basket

Example configuration for all subshops (`basket.basket`)

{
  "accountBasketActive": true,
  "accountBasketDurationDays": 365,
  "clearBasketOnLogout": false,
  "cookieBasketActive": false,
  "cookieBasketDurationDays": 30,
  "maxItemQuantity": 100,
  "readCookieBasketAfterLogin": false
}

Parameter description

Parameter	Type	Description
`accountBasketActive`	bool	Controls whether the basket most recently stored for the user account is automatically restored on sign-in. Without this option, the currently used basket is still preserved locally after sign-out (e.g. via session/cookie). - `true` — on the next sign-in, the account-bound basket most recently stored is loaded server-side. - `false` — no server-side restoration takes place; only local persistence remains active. Default: false
`accountBasketDurationDays`	int	Validity period of a stored account basket in days. After expiration the basket is automatically deleted. Default: 365
`clearBasketOnLogout`	bool	Determines whether the basket is deleted on sign-out (`true`) or preserved (`false`). Default: false
`cookieBasketActive`	bool	Enables the cookie-based basket. If the value is true, the basket is stored via a browser cookie even without sign-in. Account basket and cookie basket can exist in parallel. When signed in, the account basket is usually prioritised. By combining `cookieBasketActive` and `accountBasketActive`, a seamless basket preservation across devices can be achieved. Default: false
`cookieBasketDurationDays`	int	Validity period of the cookie basket in days. After expiration the cookie basket is deleted. Default: 30
`maxItemQuantity`	float	Defines the maximum number of individual items that may be placed in the basket. Used to limit excessively large baskets. Default: 100.0
`readCookieBasketAfterLogin`	bool	Controls whether an existing cookie basket is read out and merged with the account basket after sign-in (`true`), or whether it is ignored (`false`). Default: false

`basket.autobasket` - Automatic basket add-ons

With autobasket you can place items automatically into the basket — for example gift items or promo products. Multiple automatic items are possible; the order corresponds to the configuration. Without conditions, the positions are always added; with optional conditions you can control the automatic add-on (e.g. per subshop, country, campaign).

Example configuration for all subshops (`basket.autobasket`)

 {
    "products": [
      {
        "product": {
          "id": "GIFT-001",
          "variant": "std",
          "number": "900001"
        },
        "behavior": {
          "product": true,
          "removable": true,
          "changeable": false
        }
      },
      {
        "product": {
          "id": "DEPOSIT-250",
          "number": "990250"
        },
        "conditions": [
          { "field": "country", "value": "DE" }
        ],
        "behavior": {
          "product": true,
          "removable": false,
          "changeable": false
        }
      }
    ]
}

Parameter description

Parameter	Type	Description
`products`	list (object)	List of products to be added to the basket.
`product`	object	Each entry describes one item including identification, optional conditions and behaviour.
`id`	string	Internal/technical item ID.
`variant`	string	Variant identifier (if required), e.g. size/colour.
`number`	string	Item number (SKU).
`conditions`	list (object)	List of conditions; all must be satisfied for the add-on to be added.
`field`	string	Check field (e.g. `country`, `subshop`, `campaign`).
`value`	string	Expected value (e.g. `DE`, `deutsch`, `spring-sale`).
`behavior`	object	Behaviour in the basket.
`visible`	bool	Indicates whether the position is visible in the basket. Default: true
`removable`	bool	Indicates whether the position can be removed from the basket by the shopper. Default: true
`changeable`	bool	Indicates whether the position can be changed by the shopper in the basket, e.g. quantity / variant. Default: true

​basket* - Basic structure

​Parameter description

​basket.basket - Basket settings

​Example configuration for all subshops (basket.basket)

​Parameter description

​basket.autobasket - Automatic basket add-ons

​Example configuration for all subshops (basket.autobasket)

​Parameter description

`basket*` - Basic structure

Parameter description

`basket.basket` - Basket settings

Example configuration for all subshops (`basket.basket`)

Parameter description

`basket.autobasket` - Automatic basket add-ons

Example configuration for all subshops (`basket.autobasket`)

Parameter description