Zum Hauptinhalt springen

​
Data access & display

As part of the new shop version, the system provides flexible options to access various data sources of the shop and to display them in a targeted way in the frontend. To implement specific pages or functions, you need to know the right variables and tags in order to dynamically embed, for example, product details, categories, payment methods, or address data. This section of the documentation provides a structured overview of the central data elements of the shop. In addition, practical notes are given to make data integration efficient and user-friendly.

​
Topic areas

  • $wsAccount - Account — Customer data forms the basis for a personalized user experience in the shop. It makes it possible to retrieve important information such as the address data and the customer profile of the logged-in user and to display them clearly in the customer account. In this section you will learn how to access the data of a customer account and display it dynamically in the frontend.
  • [wsBasket−Basket](./datenzugriff−anzeige/wsbasket−warenkorb.mdx)—Entercontenthereorpastecontenttocreateanexcerpt.ThewsBasket - Basket](./datenzugriff-anzeige/wsbasket-warenkorb.mdx) — Enter content here or paste content to create an excerpt. The wsBasket module enables access to a user’s current basket data. With this data, the contents of the basket can be displayed dynamically at various points in the shop. In this area you will learn how to access this information, use it for different application scenarios, and understand its structure.
  • $wsCategories - Categories — In this section you will find all options to access the category data in the shop. The available variables and tags are described with which you can display the data dynamically in the frontend.
  • $wsCheckout - Checkout — In this section you will find all options to access the data of the checkout process. The available variables and tags are described with which you can display the data dynamically in the frontend.
  • $wsConfig - Configuration — In this section you will find all options to access the configuration data in the shop. The available variables and tags are described with which you can display the data dynamically in the frontend.
  • $wsConsent - Consent layer — In this section you will find all options to access cookie data in the shop. The available variables and tags are described with which you can display cookie data dynamically in the frontend.
  • $wsDirectOrder - Direct order — With direct ordering, the buyer can add one or more products directly to the basket by entering product numbers. The prerequisite is that the customer has the product numbers, for example from a catalog.
  • [wsExternalData−Externaldata](./datenzugriff−anzeige/wsexternaldata−externe−daten.mdx)—ThewsExternalData - External data](./datenzugriff-anzeige/wsexternaldata-externe-daten.mdx) — The wsExternalData module enables access to file-based external data stored in the shop’s own S3. Typical use cases are additional information that does not come from the standard shop data (e.g., project-related JSON files from a PIM or content from WEBSALE components such as the WEBSALE Strapi instance).
  • $wsForm - Forms — In this section you will find all options to access form data. The available variables and tags are described with which you can display the forms dynamically in the frontend.
  • $wsInventory - Stock & availability — In this section you will find all options to access the stock and availability data in the shop. The available variables and tags are described with which you can display the data dynamically in the frontend.
  • [wsLastSeenProducts−Recentlyviewedproducts](./datenzugriff−anzeige/wslastseenproducts−zuletzt−angesehene−produkte.mdx)—ThewsLastSeenProducts - Recently viewed products](./datenzugriff-anzeige/wslastseenproducts-zuletzt-angesehene-produkte.mdx) — The wsLastSeenProducts module provides access to a user’s recently viewed products. In this area you will learn how to retrieve this data and use it dynamically in the frontend. In addition, the available variables and tags are described with which the product data can be flexibly embedded in templates.
  • $wsNavigation - Navigation — In this section you will find all options to access the data of navigation elements. The available variables and tags are described with which you can display the navigation elements dynamically in the frontend.
  • [wsOptIn−Opt−inURLs](./datenzugriff−anzeige/wsoptin−opt−in−urls.mdx)—ThewsOptIn - Opt-in URLs](./datenzugriff-anzeige/wsoptin-opt-in-urls.mdx) — The wsOptIn module creates an opt-in URL based on an existing URL by appending a token parameter. Which token is appended is determined by the tokenName parameter. Which token names are available depends on the executed action and is documented with the respective action.
  • $wsOrderHistory - Order history — In this section you will find all options to access the data of the order history. The available variables and tags are described with which you can display the order history data dynamically in the frontend.
  • $wsPayPalCheckout - PayPal Checkout
  • [wsProducts−Products](./datenzugriff−anzeige/wsproducts−produkte.mdx)—ThewsProducts - Products](./datenzugriff-anzeige/wsproducts-produkte.mdx) — The wsProducts module enables access to product data within the shop. With it, both individual products and product lists can be read out and displayed in the frontend.
  • $wsSession - Session — A session is a temporary session that begins with the first visit to the shop and persists throughout the user’s entire visit. It stores various data and status information to control the shop visit and track user interactions. This includes, for example, basket data, user status, test mode, or references to the visitor’s origin.
  • $wsTestMode - Test mode — In addition to classic staging environments, WEBSALE supports an integrated test mode with which integrations, functions, and configurations such as payment methods can be tested — without them being visible in live operation and without having to set up a separate staging environment.
  • [wsViews−Generaldataaccess](./datenzugriff−anzeige/wsviews−allgemeiner−datenzugriff.mdx)—ThissectiondescribesgeneraldataaccessviawsViews - General data access](./datenzugriff-anzeige/wsviews-allgemeiner-datenzugriff.mdx) — This section describes general data access via wsViews. It provides variables, tags, and functions to use data of the currently rendered view (page) in the frontend and to build view URLs.
  • $wsVoucher - Vouchers — In this section you will find all options to access voucher data. The available variables and tags are described with which you can display the voucher data dynamically in the frontend.
  • $wsWatchList - Watchlist — In this section you will find all options to access the watchlist data in the shop. The available variables and tags are described with which you can display the data dynamically in the frontend.