docs
  1. SCAYLE Resource Center
  2. Developer Guides
  3. Checkout
  4. Customization

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

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

  1. Go to Shops > Shop > Storefront > Checkout Settings > Webhooks.
  2. Click ADD NEW WEBHOOK.
  3. Enter the Version, URL and select the Event Name from the dropdown.
  4. Click SAVE.

A summary of event types is provided in the table below.

Event Types

NameDescription
customer-createdOccurs whenever a new customer is registered or connected via a social network on the checkout application.
customer-updatedOccurs whenever an existing customer's attributes are extended or modified.
customer-loginTriggered on customer login.
customer-logoutTriggered on customer logout.
customer-anonymizedOccurs 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-resetTriggered on customer password reset.
customer-address-createdTriggered whenever a customer saves a new address.
customer-address-updatedTriggered whenever a customer updates an existing address
order-confirmedOccurs when payment reservation has been successfully completed, and the order is confirmed.
order-invoicedOccurs whenever an order is invoiced (after all items have been shipped).
order-cancelledOccurs whenever all items in an order have been cancelled.
order-item-out-of-stockOccurs during order delegation whenever an item is removed from the order, due to being out-of-stock when delegated to the merchant.
order-item-returnedOccurs whenever an item is returned by the customer.
newsletter-subscribedTriggered 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 in the SCAYLE Panel

  1. 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 KeyPurpose
order-invoice-pdfSee order-invoice-mail
partial-invoice-pdfSee shipment-mail
corrective-invoice-pdfSee products-return-mail
package-return-stick-note-pdfSee return-pickup-mail
shipment-return-document-pdfSee products-return-mail
order-confirmation-mailEmail queued when the order has been completed.
order-cancellation-mailEmail 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-mailTriggered 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-mailTo send to a user a requested password reset link.
customer-password-change-mailTo inform a user about the password being successfully changed.
customer-mail-change-mailTo inform a user about an account email being changed.
customer-bank-account-update-mailEmail triggered when the IBAN on Customer account is changed.
customer-bank-account-reminder-mailTriggered 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:

ParameterDescriptionData TypePossible Values
textTranslationKeytranslation key of the notification textstringe.g. "notifications.preBlackFridayDeliveryDelay"
startDateTimestart of the date range that a notification can be displayed betweenstring
endDateTimeend of the date range that a notification can be displayed betweenstring
stepsspecify at which steps in the checkout process the notification should showarrayPossible values are "auth", "shipping" and "payment"
typenotification levelstring"success", "info", "warning" ir "error"

Update contact settings of the Checkout notification emails

  1. In the SCAYLE Panel, go to Shops > Storefront > Checkout Settings > Notifications & Templates.
  2. Select the three-dot menu to open the Contact settings popup.
  3. Update as required.
  4. Click SAVE.

Notification contact settings

Update contact settings of the Checkout notification emails

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

  1. In the SCAYLE Panel, go to Shops > [Shop] > Storefront > Checkout Settings
  2. Select Add Shipping Option. Enter:
    1. Carrier Group Name
    2. Base Shipping Service Cost
    3. Additional Express Shipping Service Cost
    4. Is Default (True/False)
    5. Shipping Policy Key
  3. 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.

Add Shipping 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.