Skip to main content
The Storefront API is available as the central REST interface for storefronts in the WEBSALE shop system. It allows you to connect headless storefronts, progressive web apps, mobile applications, or CMS-based frontends without having to access internal shop logic directly. The API covers typical storefront functions — from URL resolution and catalog data to availability/stock, shopping cart and vouchers, through to customer account, wish lists, reviews, newsletter, and forms. The Storefront API follows a REST approach and uses JSON as the standard data format. Versioning and backward compatibility are a key focus for clean further development (e.g. via paths such as /v1/, /v2/). Depending on the use case, a distinction is made between public and authenticated endpoints. Subshops and multi-tenant structures are natively supported; paging and filtering are provided for list retrievals, optionally complemented by cache headers. Authentication is token-based. The Storefront API is technically and functionally separate from the Admin Interface API.

​
Table of contents

  • Storefront API Basics — The Storefront API Basics page describes the fundamental technical framework conditions for using the Storefront API. This includes, among other things, the base URL and versioning, request/response format (JSON), authentication, and general conventions such as headers, error codes, and paging.
  • Storefront API Checkout (In Progress) — The Storefront API Checkout provides functions for the order and checkout process. It covers the steps that typically take place between the shopping cart and order completion.
  • Storefront API Forms — The API endpoint for forms provides the online forms available in the shop and delivers their fields, required entries, and validations. The endpoint can be used to list all forms, retrieve an individual form or field, and submit completed forms.
  • Storefront API Vouchers — The Storefront API Vouchers allows voucher codes to be redeemed and removed in the storefront. The API automatically checks whether a code is valid and, after redemption, returns the updated shopping cart values (e.g. discounts and totals) as well as notices/error messages if needed.
  • Storefront API Catalog — The Catalog API provides the central information for products and categories and thus forms the basis for product detail pages, category pages, and navigation elements. It delivers standard attributes (e.g. name, description, price), complemented by custom product and category attributes as well as SEO information such as meta data and speaking URLs.
  • Storefront API Customer Reviews — The Storefront API for customer reviews provides functions to create, retrieve, update, delete, and evaluate customer reviews. In addition, you can, for example, query the own review of a logged-in account, all approved reviews of a product, as well as statistical values.
  • Storefront API Customer Account — The Customer Account API provides the functions for the “My Account” area. This includes managing personal data, login credentials, and addresses (creating/editing/deleting the address book) as well as typical account processes such as email change (including double opt-in), changing/resetting the password (“forgot password”), and deleting the account.
  • Storefront API Configurations — The Configuration API provides platform- and subshop-specific settings that are relevant for the appearance and behavior of the storefront.
  • Storefront API Stock — The Availability & Stock API supplements catalog data with stock and availability information. This lets the frontend show whether a product and its variant is currently available or considered sold out, with corresponding notices output directly on product lists or product detail pages.
  • Storefront API Wish List — The Storefront API for wish lists allows products to be saved, managed, and quickly found again later. It offers endpoints for creating, renaming, and deleting wish lists as well as for adding and removing individual products.
  • Storefront API Newsletter — The Newsletter API is used to integrate newsletter sign-ups and sign-offs for the WEBSALE newsletter module in the storefront. It can be used for both logged-in customers and anonymous visitors and represents the usual opt-in/opt-out processes in the frontend.
  • Storefront API Session Handling — Storefront API Session Handling provides functions to create and manage sessions in the storefront. This makes it possible to use user states (e.g. anonymous visit or logged-in customer) as well as session-bound data such as shopping cart and wish list consistently across multiple requests.
  • Storefront API URL Resolution — The URL Resolution API is used to resolve a storefront URL (especially SEO URLs) to the matching shop content. This lets the frontend build its routing on speaking URLs and obtain the result of whether the URL belongs to, for example, a product or a category — including the required internal IDs.
  • Storefront API Shopping Cart — The Shopping Cart API controls all interactions around the shopping cart: items can be added, quantities changed, and positions removed.

​
Outlook & not yet included

The following topics will be considered in a later expansion stage:
  • Checkout process (payment and shipping methods, order completion)
  • Management of stored payment data
  • Events & webhooks
  • System emails (Transactional Messaging API)
  • Direct ordering (DirectOrder)
  • B2B functions such as registration and approval processes, company accounts including permissions, etc.
  • Extended order and fulfillment processes