Configuration

Prerequisites

To effectively configure Collection Points in SCAYLE, it's important to understand how Carriers and Shipping Options function within the platform. These should be set up before configuring your Collection Points.

At least one Shipping Option has been configured
The Shipping Option contains a Shipping Policy
At least one Carrier is configured
At least one Collection Point Type is created
If custom API was used, Endpoints were configured

The configuration of a new Collection Point is done in two steps.

Step	Name	Description
1	Setup new Collection Point Type	Creates a `Collection Point Type` in the database on a global level.
2	Add a Collection Point to Checkout	Enables and defines Collection Point viszalization and behavior in the Checkout Webcomponent for specific shop countries.

Create a new Collection Point Type

Collection Point Types are configured globally. Once set up, you can add and configure these Collection Point Types individually for different shop countries and its Checkout Experiences.

To create a new collection point type in the SCAYLE Panel, navigate to "Collection Point Types" under the settings menu, and click on "Create Collection Point Type." Enter the name of the new collection point type. Ensure it follows the snake_case format (words separated by underscores)

Examples of Collection Point Types include "parcel shop," "pick-up location," or an offline "store." Since Collection Points are normally related to service stations operated by specific Carrier, it's advisable to create a separate Collection Point for each Carrier.

This can be done in the SCAYLE Panel under Settings ➜ Configurations ➜ Collection Point Types ➜ Create Collection Point Type.

The name for the collection point type is created by combining the carrier group name and the collection point name (e.g., "DHL_Packstation"). This name helps display the correct logo and translation on the website. NOTE: For click & collect, use "generic" as the key.

Add a Collection Point to a Shop Country

In order to customize the Checkout Experience for each shop country, Collection Points must be added to each shop country.

This can be done in the SCAYLE Panel under Settings ➜ Checkout ➜ Configurations ➜ Shipment And Delivery ➜ Collection Points.

Once selected, the individual Collection Point or Click & Collect can be configured.

The configuration of a Collection Point will be defined by the following parameters

Parameter	Mandatory	Example	Description
Collection Point Type	✅	`dhl_servicepoint`	List of available Collection Point Types on a global level.
Delegation Name	✅	`servicepoint`	Key for order delegation request. Typically identical to the Cloud Type Name.
Cloud Type	✅	`servicepoint`	Key for used to define webhooks or Admin API responses. Typically identical Delegation Name.
Shipping Policies	❌	`standard_delivery`	When`Shipping Policy Key`" is selected, a specific Shipping Policy is applied for the Collection Point.
Carrier Group	❌	`dhl`	When`carrierGroupKey`" is selected, only specified Carrier will be associated with the Collection Point.
Merchant	❌	`fashionshop24`	When "Merchant" is selected, only specified merchants will have access to the Collection Point. If "Default" is chosen, the Collection Point will be available to all merchants. You must use Merchant ID to configure this.
Visibility	❌		If Inactive the configured Collection Points will not display in the Checkout Webcomponent.
Api Search Type	❌	`servicepoint`	Value used when calling the external API to generate a list of possible Collection Points. Usually the same as Delegation Name
Preferred Carrier Key	❌		If set, it will used as pre-selected carrier in the list of available Collection Points filters that are fetched from external API. The API request will include this value to prioritise displaying Collection Points associated with this carrier.
Customer Name	❌		Checkboxes to define whether a customer name is mandatory.
Customer Number	❌		Checkboxes to define whether a customer number is mandatory.
API Config	❌		Option to enable search through an external API. Further specifications can be defined.

Once configured, the Collection Point is visible in the Checkout Webcomponent and can be tested.

Rule Engine integration

When a new collection point is added, the system automatically creates options within the Rule Engine. This allows you to create rules for how collection points are used. read more about how the rule engine works here.