Configuration

Overview

To make a Carrier available for your users, you need to follow these three steps.

Create a new Carrier Type

A Carrier Type bundles different information about a Carrier having a distinct carrierKey and carrierGroupKey combination.

Once set up globally, the Carrier Type can be configured for the Checkout in each shop country, with its generic parameters automatically applied. While each shop operates at a country level, a new Carrier Type MUST first be created globally to ensure the Carrier is recognized across the platform.

Note: Carriers are strongly linked to Merchants. Therefore, each new Carrier MUST be assigned to Merchant countries BEFORE you can configure a Carrier for a specific shop country.

After the initial setup, the individual Checkout experience per shop country can be tailored by e.g. adding Carriers to the Checkout flow of each shop country, dedicated Shipping Options assigned, or the specific Carrier assigned to Collection Points.

Start by defining your carriers globally, including carrier names, codes, and tracking URLs. This step ensures that the carriers are recognized across your platform.

You can do this in the SCAYLE Panel under Settings > General > Configuration > Carriers.

Since logos and translation keys can be shared across countries, multiple Carrier Types may use the same carrierGroupKey. For example, Hermes Austria and Hermes Germany would both use the same logo. However, a one-to-one relationship between Carrier Type and carrierKey must be maintained, as Hermes Austria and Germany could be managed differently within their respective logistics systems.

The setup of a Carrier Type will be defined by the following parameters:

Parameter	Mandatory	Example	Description
Logo	❌		Display image in the SCAYLE Panel.
Carrier Name	✅	`Hermes`	Display name in the SCAYLE Panel.
`carrierKey` (Carrier Code)	✅	`HERMES_AT`	Assigned to a Carrier during the Checkout flow, allowing warehouses to identify the actual carrier responsible for fulfilling the shipment.
`carrierGroupKey` (Carrier Group Name)	✅	`hermes`	Defines how the carrier is visually presented during the Checkout flow. It determines the carrier’s logo and translation key that are pre-configured by SCAYLE.
Tracking URL	❌	https://acme.com/trakcing?{trackingId}/{zipCode}	A carrier tracking URL is used to provide customers with real-time updates on the status of their orders during the shipping process. The is typically provided by the shipping carrier.
Tracking Email	❌	[email protected]	Email address
Tracking Tool	❌		Name of the tracking tool
Is this tracking external	❌	yes\|no	If checkout returns shipment part of their Order Items payload, FE will use the shipment tracking info to construct tracking urls and call Shipment Tracking API. Otherwise no information will be shown External Carriers: Same as Shipment Tracking, if external carriers (Hermes, and Post NL) are configured for the tenants, tracking is automatically enabled.
Display track & trace status	❌	yes\|no	Should SCAYLE show the current track & trace status to the user

Assign Carrier Type to a Merchant

After creating a Carrier Type, link it to the relevant merchant and specify the country in which the merchant operates. This is crucial when managing multiple merchants with different operating regions.

You can do this in the SCAYLE Panel under Settings > Merchant Management > Merchant > Edit.

Assign Carrier to a Merchant and a Country

Simply use the dropdown below each Merchant country and assign Carrier.

Add Carrier to a Shop Country

Once the Carrier Type is created and assigned to the Merchant, the Carrier can be added to the relevant shop country, making the Carrier available in the Checkout Webcomponent.

You can do this in the SCAYLE Panel under Storefront > Checkout Settings > Checkout Frontend Configuration > Carriers > New Carrier.

The setup of a Carrier Type will be defined by the following parameters

Since logos or translation keys can be shared across countries, a carrier added to multiple shop countries may use the same carrierGroupKey. For example, both Hermes Austria and Hermes Germany would share the same logo. However, it's essential to maintain a one-to-one relationship between the carrierKey, Tracking URL and Carrier Name assigned to the Carrier Type and the parameters used in each shop country.

Parameter	Mandatory	Example	Description
Carrier Name (Name)	✅	`Hermes`	Utilized throughout SCAYLE panel to enhance transparency.
`carrierKey` (Code)	✅	`HERMES_AT`	Assigned to a Carrier during the Checkout flow, allowing Warehouses to identify the actual carrier responsible for fulfilling the shipment.
`carrierGroupKey` ( Group Name)	✅	`hermes`	Defines how the carrier is visually presented during the Checkout flow. It determines the carrier’s logo and translation key that are pre-configured by SCAYLE
Tracking URL	❌	https://acme.com/trakcing?{trackingId}/{zipCode}	A carrier tracking URL is used to provide customers with real-time updates on the status of their orders during the shipping process. The is typically provided by the shipping carrier.