Skip to main content
The checkout process in WEBSALE is freely configurable and can be implemented as needed. This affects both the number of steps in a checkout and the contents that are queried and processed during the checkout process, for example addresses, payment methods, shipping methods, confirmations, or additional information.

​
Configurations

The following settings are relevant for configuring a WEBSALE checkout process:

​
checkout - Checkout process

Central configuration of the checkout process, for example for guest ordering, default selections, free checkout fields, shipping methods, and error display. The following are particularly relevant:
  • checkout.checkout - General checkout settings, guest ordering, free fields, default values. Among other things, it contains:
    • fieldErrorVisibility - Error display and error logic in the checkout
    • defaults - Default selections, for example country, shipping method, payment method
  • checkout.shippingMethod - Shipping methods in the checkout process
  • checkout.clearingErrors - General error text when an online payment fails
For all configuration options, see checkout - Checkout process

​
customer - Customer data

Configuration of the customer data fields, for example for field definitions, mandatory fields, labels, field types, and validations. The following are particularly relevant:
  • customer.customerDataField - Definition of individual customer data fields to be queried
  • customer.customerDataFieldSettings - Settings and validations of the customer data fields
  • customer.customerDataGroup - Grouping of customer data fields
For all configuration options, see customer - Customer data

​
accounts - User accounts

Relevant for logged-in customers, saved addresses, and saved bank or payment data. The following are particularly relevant:
  • accounts.addressFieldsSettings - Settings for address fields
  • accounts.addressField - Definition of individual address fields
  • accounts.customAddressField - Additional custom address fields
Optionally additionally:
  • accounts.bankInfoField - Bank data fields
  • accounts.creditCardField - Credit card fields
For all configuration options, see accounts - User accounts

​
payment - Payment methods

Configuration of the offered payment methods and connected payment providers. The following is particularly relevant:
  • payment.payment - Available payment methods
Depending on the payment methods used, additionally, for example:
  • payment.payPalCheckout - Configuration for PayPal Checkout
  • payment.payPalCheckoutErrors - Error texts for declined PayPal payments
  • payment.stripe - Configuration for Stripe
  • payment.stripeErrors - Error texts for declined Stripe payments
or the respective configuration of the payment methods that are to be offered in the checkout. For all configuration options, see payment - Payment methods

​
Modules

The following modules are particularly relevant for integration into the templates:
  • $wsCheckout - Checkout state, addresses, shipping, payment, problems, totals
  • $wsActions - Generating and evaluating actions
  • $wsAccount - Login status, email, addresses, loadAddress()
  • $wsViews - Current URL, destination pages, view URLs
  • $wsBasket - Basket and order overview
  • $wsConfig - Configuration values, for example salutations and currency
Optionally additionally, if integrated in the checkout:

​
Actions

For a checkout, depending on the desired scope, the actions documented under Checkout are particularly relevant. For all actions for the checkout process, see Checkout

​
Canceled and failed online payments

With an online payment, the buyer briefly leaves the shop to confirm the payment with the payment service. If the buyer cancels the payment or it is declined by the payment service, the buyer returns to the checkout. The order is then not yet completed, and the buyer can choose a different payment method or try again. The template displays the reason for the decline via $wsCheckout.problems.clearing. The texts for this come from these nodes: The page to which the buyer returns is defined by the configuration of the payment method. For PayPal Checkout, these are the parameters cancelTemplate and errorTemplate under payment.payPalCheckout. Without a custom value, both point to checkout.htm.

​
Payments without feedback

If the buyer does not return to the shop and the payment service does not report a result either, the payment remains open. The shop checks such payments regularly. If there is still no result after two hours, it ends the payment due to a timeout and releases the order. If the payment service subsequently reports the payment as successful after all, the shop still completes the order. Orders from test mode and orders marked as fake are excluded from this check.

​
Additionally relevant for a one-page checkout

If all checkout areas are merged onto a single page, the following points in particular are relevant: All of the areas mentioned are described and linked in the respective reference documentation. This overview serves as a technical entry point for the implementation.