Configuration Reference
This page collects the fixed values that SCAYLE recognizes when you configure carriers, shipping options, and collection points. Some of these values are enforced by the system, others are conventions. For each list, the Enforcement note tells you what happens when you use a value that is not listed.
- Carrier Group Keys
- Tracking URL Placeholders
- Carrier Codes With Language Substitution
- Collection Point Delegation Keywords
- Reserved Shipping Option Keys
Carrier Group Keys
The carrierGroupKey (Carrier Group Name) defines the logo and translation key of a carrier in the Standard Checkout. The following keys resolve to a carrier-specific logo and translation.
Enforcement: convention. The Carrier Group Name field accepts any string. A key that is not listed here falls back to a generic logo and translation in checkout. Keys are case-sensitive and not uniformly lowercase, for example royalMail.
Available Carrier Group Keys
- acs
- asendia
- balikovna
- bartolini
- bpost
- bpostlu
- bring
- chronopost
- colissimo
- correos
- ctt
- default
- dhl
- dpd
- dsTblt
- econtbg
- evri
- fanro
- fastwayie
- fedex
- generic
- genikiTaxydromiki
- gls
- hermes
- inpost
- intime
- laposte
- letter
- omniva
- planzer
- postat
- postch
- postcz
- posteitaliane
- postfr
- posthr
- posthu
- postifi
- postlx
- postnl
- postnord
- postsi
- postsk
- ppl
- quickpac
- royalMail
- sda
- seur
- speedy
- sps
- suedmail
- ups
- wngil
- wngsa
- yurtici
- zasilcz
- zasilsk
If you need an additional carrier group key, reach out to your SCAYLE Account Manager. For more information on how carrier group keys are used, see Carriers.
Tracking URL Placeholders
The Tracking URL of a carrier is mandatory and must contain at least one of the following placeholders. SCAYLE replaces every placeholder it finds in the URL and converts spaces to %20.
| Placeholder | Resolves To |
|---|---|
{{ key }} | The shipment key (tracking number). |
{} | The shipment key. Legacy syntax, kept for backward compatibility. Use {{ key }} for new carriers. |
{{ language }} | The language code, for example de. Only substituted for the carrier codes listed in Carrier Codes With Language Substitution. |
{{ zip }} | The zip code of the delivery address. |
Enforcement: enforced. A tracking URL without a valid placeholder is rejected. Any other placeholder name, for example {trackingId}, is not recognized and stays in the URL as literal text.
Example: https://acme.com/tracking?code={{ key }}&zip={{ zip }}
Carrier Codes With Language Substitution
The {{ language }} placeholder is substituted only for the following carrier codes (carrierKey). The language is resolved from the country code of the carrier and falls back to en if the resolved language is not supported.
| Carrier Code | Supported Languages |
|---|---|
DHL | de, en, fr, es, cs, pl, nl, it |
DHL_STD_NATIONAL | de, en, fr, es, cs, pl, nl, it |
DHL_STD_WORLD | de, en, fr, es, cs, pl, nl, it |
DHL_BPOST_BEL | de, en, fr, es, cs, pl, nl, it |
SWISS_POST | de, en, fr, es, cs, pl, nl, it |
POST_CH | de, en, fr, it |
Enforcement: enforced. For any other carrier code, {{ language }} is not substituted and remains in the tracking URL as literal text, which results in a broken tracking link for the customer. Do not use {{ language }} for carriers that are not listed here.
Collection Point Delegation Keywords
The Delegation Name and Api Search Type of a collection point type are derived from the type name by matching it against one of six keywords. The Cloud Type copies the full type name instead.
The six keywords are:
genericparcel_shoppost_officepackstationservicepointlocker
The match is a keyword search on the type name that ignores underscores. The carrier prefix is not stripped. If the type name contains none of the keywords, no value can be derived and you have to choose the values yourself.
The following table shows how the values are derived for typical collection point types.
| Collection Point Type | Delegation Name and Api Search Type | Cloud Type |
|---|---|---|
generic | generic | generic |
hermes_parcelshop | parcel_shop | hermes_parcelshop |
dhl_postoffice | post_office | dhl_postoffice |
dhl_locker | locker | dhl_locker |
dhl_postbank | No match, choose manually. | dhl_postbank |
Enforcement: convention. The derived values are suggestions. SCAYLE does not validate Delegation Name, Api Search Type, or Cloud Type when you save a collection point, so any value is accepted and stored.
The type name generic is reserved. A collection point type named generic activates the Store Pickup delivery option (Click & Collect), any other type name activates the Collection Point delivery option. Renaming a generic type silently changes this behavior. For more information, see Delivery Options.
Reserved Shipping Option Keys
The following shipping option keys (shipping policy keys) carry a specific behavior or default translation in checkout.
| Key | Default Translation | Behavior |
|---|---|---|
standard_delivery | "Standard Delivery" | Default translation only. |
express_delivery | "Express Delivery" | Default translation only. |
free_delivery | "Free Delivery" | Default translation only. |
scheduled_delivery | "Scheduled Delivery" | Triggers the delivery date and time picker in checkout. Supported for Home Delivery only. |
least_packages | "All Items in One Delivery" | Default translation only. |
ingrid_generic | – | Activates the Ingrid delivery widget in checkout. Requires a carrier with the Carrier Code INGRID_GENERIC and the Ingrid Add-on enabled. For more information, see Ingrid Integration. |
Enforcement: convention. Any shipping option key in snake_case is accepted. The behavior and default translation apply only if the key matches exactly. For example, dhl_scheduled_delivery is saved without an error, but does not trigger the date picker.
Shipping option keys, carrier codes, and collection point types are three separate namespaces. The same word can appear in all three with a different meaning, for example the shipping option key ingrid_generic, the carrier code INGRID_GENERIC, and the collection point type generic.
