Skip to main content
WEBSALE supports a store finder including click & collect, saving the selected store, and availability checks in the selected store. Customers can use it to select a store, remember this store for the session, and — if supported — order goods online and pick them up in the store.

​
Store management

Currently, store management is only possible via the Stores REST API.
Store management via the Admin Interface is currently being developed and will only be available at a later time.In order for a store finder to be offered in the online shop, stores must be created and maintained. Store management is currently done via the Stores API reference.The available fields of a store are also documented there, such as:
  • name - Name of the store
  • street - Street and house number
  • openingHours - Opening hours
  • location - Coordinates of the store
  • clickAndCollect - Pickup at the store available
  • and many more
For all data fields for a store, see Stores API reference

​
Configuration

​
checkout - Checkout process

Only relevant if a store is to be offered as a pickup location in the checkout process, i.e., for click & collect.
  • checkout.shippingMethod - Shipping methods in the checkout process; type is particularly relevant for the shipping method type, e.g., standard or pickup
For all configuration options, see checkout - Checkout process

​
Modules

The following modules are particularly relevant for integrating the store, branch, or store selection in the shop:
  • $wsStores - Load stores, output store lists, use selected store
  • $wsActions - Generate and evaluate actions, e.g., select store
  • $wsViews - Current URL, destination pages, view URLs
  • $wsCheckout - Store in checkout, selected shipping method
  • $wsConfig - Shipping methods and other configuration values
  • $wsInventory - Load store stock via storageId

​
Actions

The following actions are relevant for the store finder:
  • Stores - Action reference for the store finder
  • Checkout - Store selection in the checkout for shipping methods of type pickup via CheckoutStoreIdSelect