Carriers

General

Your shop operates on a country level, meaning each country can have its distinct carriers, shipping costs, and collection point rules. While carrier lists, URLs, and logos are configured globally, the shipping specifics are tailored to each shop country.

Create Shipping Option Types

Shipping option types define the different methods through which an order can be delivered to customers. These options could include standard shipping, express delivery, or special services like refrigerated shipping for perishables.

Purpose: Shipping option types allow you to tailor the delivery experience to match your products' needs and customers' expectations, enhancing flexibility and customer satisfaction.

Create a new Carrier

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

For each carrier, configure the carriers with specific settings such as name, code, group name, and tracking URL.

The carrier name and logo can be later customized on a country level.

Add Carrier to merchant

After a carrier is created, you have to link them to your merchant and in which country this operates. This becomes important if you have different merchants.

Add carrier to a shop country

Shipping Policies: Define your shipping policies, including standard and express delivery options. Assign costs to these policies based on order values and specify any additional costs for express services.
Carrier Configuration: For each carrier, link them to the defined shipping policies. This step is critical for ensuring the correct shipping costs are applied during checkout.

Parameter	Type	Required	Details
key	string	true	The key of the carrier. Example: DHL_STD_NATIONAL
name	string	true	Name of the carrier. Example: DHL
trackingUrl	string	false	Tracking URL of the carrier.
id	integer	false	ID of the carrier created by SCAYLE

let newCarrier = {
  name: "DHL",
  key: "DHL_STD_NATIONAL",
  trackingUrl: "http://nolp.dhl.de/nextt-online-public/set_identcodes.do"
};

let response = await adminApi.apis.Carriers.createCarrier({}, {requestBody: newCarrier});
let createdCarrier = response.body;

console.log(createdCarrier.id);

Update a carrier

When updating a carrier, the provided information replaces the old one.

Parameter	Type	Required	Details
key	string	true	The key of the carrier. Example: DHL_STD_NATIONAL
name	string	true	Name of the carrier. Example: DHL
trackingUrl	string	false	Tracking URL of the carrier.
id	integer	false	ID of the carrier created by SCAYLE

let response = await adminApi.apis.Carriers.updateCarrier({carrierIdentifier: carrierIdentifier}, {requestBody: carrier});
let carrier = response.body;

Get carrier

You can get carrier information by its key or ID.

Parameter	Type	Required	Details
carrierIdentifier	string	true	The carrier ID or key.

response = await adminApi.apis.Carriers.getCarrier({carrierIdentifier: 1});
let carrier = response.body;

console.log(carrier.name);

Get a collection of carriers

You can request multiple carriers and refine the search results by applying filter options.

let response = await adminApi.apis.Carriers.getCarriers();
let carriers = response.body.entities;

Parameters

Parameter	Type	Description	Required
limit	integer	Maximum number of items in the result.	false
filters[id]	integer	Comma-separated list of carrier IDs for filtering.	false
sort	string	Sort by the provided column.	false
sortDir	string	Sort ascending or descending	false
cursor	string	Valid cursor used for pagination.	false

SCAYLE Panel

You can add and edit carriers in the SCAYLE Panel.
Carriers need to be assigned on the local shop level and added manually to the merchant countries in the SCAYLE Panel.

Go to Settings > Merchant Management > Edit.

Add a new merchant carrier

Go to SCAYLE Panel > [Select Shop] >Shops > Storefront > Checkout Settings > Configuration Details > Carriers.
Click the + ADD NEW CARRIER button.
Fill in all the required fields:
- Name
- Group Name
  used for the shipping option configurations (for example default, DHL, DPD)
- Code
- Tracking URL
  used as basic domain for tracking links in transactional mails regarding the shipping

Carrier codes

list of carrier codes

Name              Code
DHL               DHL
HERMES            HERMES
POSTAT            POSTAT
POSTNL            POSTNL
GLS               GLS
LAPOSTE           LAPOSTE
POSTCH            POSTCH
UPS               UPS
ACS               ACS_GR
ACS               ACS_CY
Asendia           ASENDIA_W
Asendia           WNG_SA
Asendia           WNG_IL
Bpost             BPOST_BE
Colissimo         COLI_FR
Correos           UB_CORR_ES
Croatian Post     POST_HR
CTT Expresso      UB_CTT_PT
DHL               DHL_STD_NATIONAL
DHL               DHL_BPOST_BEL
DHL               UB_DHL_SE
DHL WORLD Premium DHL_POST_AUT
DHL_AT            DHL_AT
DHL_NL            DHL_NL
DHL_PL            DHL_PL
DHL_STD_WORLD     DHL_STD_WORLD
Die Post          POST_CH
Econt Bulgaria    ECONT_BG
FAN Romania       FAN_RO
Fastway           UB_FAST_IE
FORCE_CLOSE       FORCE_CLOSE
GLS               UB_GLS_FR
GLS               UB_GLS_DK
GLS Hungary       GLS_HU
Hermes            HERMES_KLV
Hermes            HERMES_POST_AUT
Hermes            HERMES_STD_NATIONAL
Hermes GB         UB_HERM_GB
Omniva_EE         UB_OMNIVA_EE
Omniva_LT         UB_OMNIVA_LT
Omniva_LV         UB_OMNIVA_LV
Post Hungary      POST_HU
Post Slovakia     POST_SK
Posta Slovenije   POST_SI
Poste Italiane    UB_POST_IT
Poste Italiane    POST_IT
Posti             UB_POST_FI
PostNL            POST_NL
PostNord          UB_POST_NO
PPL               PPL
TAXYDROMIKI       UB_TAXY_GR
Zásilkovna        ZASIL_CZ
Zásilkovna        ZASIL_SK
Bring             BRING
DPD               DPD
Post CZ           POST_CZ

Carrier Set Up in the SCAYLE Panel

You can add and edit carriers in the SCAYLE Panel. You must assign carriers to the local shop and merchant countries.

Assign carrier to a local shop

Go to SCAYLE Panel > [Select Shop] > Storefront > Checkout Settings > Shipping options > Carriers.
Click the ADD SHIPPING OPTION button.
Select the carrier from the dropdown and add shipping cost.