Customization
This section explains how to customize the Checkout in SCAYLE.
Checkout is customized on the local shop level.
In the SCAYLE Panel, go to Shops > [Shop] > Storefront > Checkout Settings
to customize:
- Admin Webhooks allows you to subscribe to events in the customer and order lifecycle
- Checkout Frontend Configuration
- Checkout Webhooks: Legacy. Use Admin Webhooks.
- Collection Points manage and configure collection points
- Delivery Estimations allow you to modify standard delivery dates and escalate a delivery
- Logistics Cut Off a feature for logistics managers used to document the cut-off times
- Notifications & Templates send users different messages when an event in your shop is triggered
- Rule Engine allows you to automatically run events depending on conditions
- Shipping Options control shipping data and sorting priorities for devices
Admin Webhooks
SCAYLE allows you to get notified when a certain event happens in the system. This feature is handled by webhooks.
View or add webhooks in the SCAYLE Panel
- Go to
Shops > Shop > Storefront > Checkout Settings > Webhooks.
- Click ADD NEW WEBHOOK.
- Enter the Version, URL and select the Event Name from the dropdown.
- Click SAVE.
A summary of event types is provided in the table below.
Event Types
Name | Description |
---|---|
customer-created | Occurs whenever a new customer is registered or connected via a social network on the checkout application. |
customer-updated | Occurs whenever an existing customer's attributes are extended or modified. |
customer-login | Triggered on customer login. |
customer-logout | Triggered on customer logout. |
customer-anonymized | Occurs whenever an existing customer's data is removed from the system at the customer's request. This event can currently only be triggered by the Customer Application. |
customer-password-reset | Triggered on customer password reset. |
customer-address-created | Triggered whenever a customer saves a new address. |
customer-address-updated | Triggered whenever a customer updates an existing address |
order-confirmed | Occurs when payment reservation has been successfully completed, and the order is confirmed. |
order-invoiced | Occurs whenever an order is invoiced (after all items have been shipped). |
order-cancelled | Occurs whenever all items in an order have been cancelled. |
order-item-out-of-stock | Occurs during order delegation whenever an item is removed from the order, due to being out-of-stock when delegated to the merchant. |
order-item-returned | Occurs whenever an item is returned by the customer. |
newsletter-subscribed | Triggered whenever a customer subscribes to a newsletter during Checkout. |
Collection Points
See Collection Points.
Delivery Estimations
See Delivery Estimations.
Logistics Cut Off
See Logistics Cut Off.
Notifications & Templates
Use this tab to:
- manage templates for a variety of Checkout events
- update contact settings of the Checkout notification emails
Manage templates in the SCAYLE Panel
- On the shop country-level, navigate to
Shops > Storefront > Checkout Settings > Notifications & Templates
On the main Notifications & Templates page you can activate/deactivate templates. Templates can be searched by keyword or filtered by template key
and locale
.
Templates can be created for a variety of Checkout events and include:
- Order invoices
- Return stick notes
- Shipment return documents
- Order confirmation/cancellation emails
- Order invoice emails
- Shipment emails
- Product undeliverable emails
- Product return emails
- Password reset emails
- Customer bank account updates/reminders
Available Templates
The following templates are available in the SCAYLE Panel.
Template Key | Purpose |
---|---|
order-invoice-pdf | See order-invoice-mail |
partial-invoice-pdf | See shipment-mail |
corrective-invoice-pdf | See products-return-mail |
package-return-stick-note-pdf | See return-pickup-mail |
shipment-return-document-pdf | See products-return-mail |
order-confirmation-mail | Email queued when the order has been completed. |
order-cancellation-mail | Email queued during the transition from Aborted to Cancelled. This can vary in wording and content depending on the reason that led to the order being cancelled (e.g., Out of Stock, Customer Cancellation, RatePay Cancellation). |
order-invoice-mail (+ order-invoice-pdf ) | Email queued during the transition of the order from Shipped to Invoiced. Can include a full Invoice PDF as an attachment (for countries where this is a requirement). |
shipment-mail (+ partial-invoice-pdf ) | Email queued after the successful handling of a Shipment Message. This can include a Partial Invoice PDF as an attachment (for countries where this is a requirement). |
products-undeliverable-mail | Triggered on the closing of a Return Window. It aims to notify the customer that one or more of their items has not been delivered successfully (due to issues locating the address, customer not being at home, etc.). |
products-return-mail (+ corrective-invoice-pdf , + shipment-return-document-pdf ) | Email queued during the closing of a Return Window. It can include a Corrective Invoice PDF as an attachment (for countries where this is a requirement). |
return-pickup-mail (+ package-return-stick-note-pdf ) | To inform a user about a return pickup time and place. |
password-reset-mail | To send to a user a requested password reset link. |
customer-password-change-mail | To inform a user about the password being successfully changed. |
customer-mail-change-mail | To inform a user about an account email being changed. |
customer-bank-account-update-mail | Email triggered when the IBAN on Customer account is changed. |
customer-bank-account-reminder-mail | Triggered on the closing of the Return Window and then again every 7 days for a limited amount of time. Is only applicable for customers that have received returns for orders, yet have not provided a usable IBAN with which refunds can be provided. |
Template Activation/Deactivation
Templates can be activated/deactivated using the toggle button.
The system checks that there is only one active template for a given shop_id
, key
, and locale
. All other templates are set to inactive automatically in the background.
Configure static notifications
You can configure static notifications as an array below notifications
. Each item in the array may contain the following properties:
Parameter | Description | Data Type | Possible Values |
---|---|---|---|
textTranslationKey | translation key of the notification text | string | e.g. "notifications.preBlackFridayDeliveryDelay" |
startDateTime | start of the date range that a notification can be displayed between | string | |
endDateTime | end of the date range that a notification can be displayed between | string | |
steps | specify at which steps in the checkout process the notification should show | array | Possible values are "auth" , "shipping" and "payment" |
type | notification level | string | "success" , "info" , "warning" ir "error" |
Update contact settings of the Checkout notification emails
- In the SCAYLE Panel, go to
Shops > Storefront > Checkout Settings > Notifications & Templates.
- Select the three-dot menu to open the Contact settings popup.
- Update as required.
- Click SAVE.
Rule Engine
See Rule Engine for details.
Shipping Options
With Shipping Options, you can add existing shipping options to a country. You can also add details like base/express costs and whether a given shipping option is default.
Add Shipping Option
- In the SCAYLE Panel, go to
Shops > [Shop] > Storefront > Checkout Settings
- Select Add Shipping Option. Enter:
- Carrier Group Name
- Base Shipping Service Cost
- Additional Express Shipping Service Cost
- Is Default (True/False)
- Shipping Policy Key
- When the fields are complete, select Save Shipping Option.
Existing options are listed under Overview.
Edit or delete an existing shipping option using the respective icons to the right of the option.
Sorting on Device
With the Sorting on Device tab, you can adjust the order in which shipping options appear for a given device. Select the icon to the left of an option name to drag the option into the desired order. Alternatively, adjust the numbers to the right of the option name.