Toret PPL plugin documentation

You are on the documentation page for the Toret PPL plugin for WooCommerce, which implements this shipping service into your e-shop.

To use the PPL plugin, you must have an account created with PPL.

Furthermore, you need to request access to the CPL API from PPL. In the request, state that you will use the integrator solution:

Toret plugins s.r.o.
IntegrID: 4257736.

You can purchase the PPL plugin here: Toret PPL for WooCommerce

Plugin Installation

After purchasing the PPL plugin, you will receive a license key and a download link for the plugin zip file via email. You can find detailed instructions on how to install the plugin from your computer into WordPress here.

Plugin Activation

After installing the plugin, open the Toret PPL plugin, insert the license key into the appropriate field, and click the button to activate.

Video Tutorial

Connecting to PPL

After installing and activating the plugin, continue to its settings. This is found in the section Toret plugins → PPL

To connect the plugin with a PPL account, you need to select the API type for which you have access credentials.

Insert the access credentials into the corresponding fields and save.

To connect to the CPL API (Create package label), you need:

• ClientID
• Client secret

Shipment Number Range (myAPI only)

Furthermore, it is necessary to request a shipment number range from PPL, which you insert into the plugin settings on the “Hlavní nastavení” (Main Settings) tab. If the shipment number range runs out over time, have it increased by PPL support and update this value in the plugin settings.

This setting is only necessary if you are using the connection via the older API version – myAPI.

The number range on the screen is just an example. Request your own from PPL support.

Main Settings

On the Main Settings tab (Toret plugins > PPL > Hlavní nastavení), you can further configure:

• Rates and taxes (VAT, COD tax class, free shipping coupon behavior)
• Custom surcharges – can be set per product, variant, category, country, shipping, or globally
• Labels – format, note, and references
• Widget settings – opening, button placement, hiding boxes and COD
• Pickup addresses for shipment collection by courier
• Displaying icons for individual shipping methods in checkout
• Main settings (functions for checkout and email)
• Multiple shipments (automatic splitting of order into multiple packages based on weight)

Setting up Carriers in the PPL Plugin

Individual delivery types can be found in the PPL plugin on the Způsoby dopravy (Shipping Methods) tab (Toret Plugins > PPL > Způsoby dopravy). After clicking the Nastavení (Settings) button for a specific country, you will see an overview of available shipping methods for that country.

After activating the given shipping method by checking the checkbox and clicking Save, the settings for that method will appear.

In the Toret PPL plugin, you can set up shipping:

• PPL Private (delivery to address)
• PPL Parcelshop (pickup points for the Czech Republic, Slovakia, Poland, Germany)
• PPL Business (delivery to company address)
• PPL Dopolední balík (Morning package)
• PPL Parcel Return Connect Import (Return shipment from abroad to the Czech Republic. Service available only from supported countries. These countries must be set as the pickup address (sender).)
• PPL Parcel CZ Smart to box

For each shipping method and delivery country, the following options can be set:

• shipping price – flat or based on weight
• free shipping over amount
• use of free shipping coupon
• flat price in other currencies
• maximum weight and maximum dimension (if exceeded, the shipping method will not be displayed in checkout)
• availability by cart value, number of items in cart, or product price (if exceeded, the shipping method will not be displayed in checkout)
• cash on delivery (if PPL supports it for the given shipping method and country)
• COD surcharge – flat or based on order price
• free COD over amount
• evening delivery (if PPL supports it for the given shipping method and country)
• return shipment (if PPL supports it for the given shipping method and country)

Tip: if you want to trigger free shipping or free COD at checkout e.g. from 500, set the value 499 in the plugin.

Price Settings

First, select the Typ výpočtu dopravy (Shipping calculation type). The shipping price can be set uniformly – with a fixed amount entered in the Jednotná cena (Uniform price) field,

or set custom price rules based on shipment weight.

Flat rate in other currencies: Here you can set fixed shipping prices to be used if the order is in a currency other than the default e-shop currency.

Free Shipping

You set free shipping directly in the PPL plugin (Toret Plugins > PPL > Způsoby dopravy) for each type of shipping, for each country separately.

The free shipping setting is “above” an amount, meaning free shipping is activated on the website after exceeding the set amount in the cart.

EXAMPLE: If you want free shipping from 500, set the amount 499 in the plugin.

Tip: If you have VAT configured in WooCommerce, the value for triggering free shipping is entered without VAT.

The free shipping amount setting applies only to products; the shipping price is not included.

EXAMPLE: If you have free shipping set from 500, and the cart contains a product for 450 + shipping price 65 = 515 CZK, free shipping will not be activated. It is necessary to exceed the set price with the product, i.e., to activate free shipping set this way, you need to put product(s) worth at least 500 CZK into the cart.

Free shipping for a specific product can be set in its detail on the PPL tab.

Free shipping for goods from a specific product category can be enabled in the category settings.

Free Shipping Coupons

The plugin supports coupons for free shipping. These can be set globally, for all PPL shipments, or for a specific type of delivery. You configure coupon behavior in the main plugin settings (Toret plugins > PPL > Hlavní nastavení).

If you choose the option Vybraný způsob dopravy zdarma (Selected free shipping method), enable coupons in the settings of the specific method for which you want to have the coupon active.

Cash on Delivery (COD)

To set up COD for shipping, it is necessary to check the Povolit dobírku (Enable COD) checkbox.

Subsequently, it is possible to set:

Zdarma od (Free from): From the entered order value, COD will be without surcharge.

Maximální povolená hodnota (Maximum allowed value): Upon exceeding this order value, COD will not be available in checkout.

Typ výpočtu poplatku (Fee calculation type): You can choose a fixed surcharge – Jednotná cena (Uniform price),

or scale the surcharge according to the order value – Celková cena (Total price) and set custom price rules.

Weight and Dimension Limits

If you activate weight/dimension checks and enter values for maximum dimension/weight, shipping will be hidden in checkout if limits are exceeded. The plugin loads weight/dimensions from values set for products.

Availability

In the Availability section, you can set the minimum and maximum cart value, number of items in the cart, or product price. If orders exceed any of the limits, shipping will not be available in checkout.

Evening Delivery

Activate evening delivery by checking the Povolit PPL večerní doručení (17:00 – 21:00) (Enable PPL evening delivery) checkbox. Evening delivery is available only for some shipping methods.

It will appear in checkout as an additional checkbox for the shipping method.

Parcel Return Service

For supported shipping methods, parcel return is also available – with drop-off at a ParcelShop. The service must be activated – checkbox Povolit PPL Return balík v pokladně (PPL Private, PPL Private s dobírkou). Příjemce odnese balík do PPL Parcelshopu. (Enable PPL Return package in checkout. Recipient takes package to PPL Parcelshop.)

Subsequently, it is possible to set text, surcharge, and field pre-checking. It will appear in checkout as an additional checkbox for the shipping method.

Shipping Zone Settings

After setting up carriers in the Toret PPL plugin, it is necessary to set up identically named carriers in your WooCommerce shipping zones. Without setting them in shipping zones, carriers from the PPL plugin will not appear in checkout.

In WooCommerce > Settings > Shipping select the zone in which you want to enable shipping via PPL. Click “Edit”.

In the zone settings, click “Add shipping method”.

Select your required method from the list and click Continue.

Leave the Enable box checked, you can adjust the Title and Description as needed. Tax status can be chosen as Taxable or None. After clicking Create and save, the shipping method will be available for the given zone.

Product and Category Level Settings

The PPL plugin also adds additional setting options to product and category details.

In product detail, you can set:

• Age verification (see below)
• Free shipping for product
• Disable shipping method
• Free COD for product
• Deactivate delivery boxes for product
• Surcharge for product (Must first be created in the main plugin settings)

In category detail, you can set:

• Disable shipping method
• Free shipping
• Free COD
• Disable delivery boxes
• Surcharge by category (Must first be created in the main plugin settings)

Shipment Submission from Web to PPL

You have two options for submitting a shipment to the PPL system in the plugin.

Submitting a package requires weight. We recommend setting the weight at the product level; without set weight for products, automatic shipment submission upon order status change will not work.

Shipments sent via the plugin can also be found in the PPL Customer Zone.

1. Manual via button in order overview or order detail

2. Automatic shipment sending on order status change

Automatic submission can be set in the PPL plugin on the tab Automatické odesílání (Automatic Sending).

In the section Odeslat data do systému PPL při změně stavu objednávky (Send data to PPL system on order status change), choose the order status for individual payment methods at which data will be automatically sent to the PPL system.

In the Hlavní nastavení (Main Settings) section, you can set whether a label will also be automatically created and pickup ordered when creating a shipment.

Do not forget to save the changes made.

Ordering Package Pickup

Via the plugin, it is possible to order package pickup. Ordering pickup can be done in two ways.

Manual

In the order overview, there is a car icon for orders submitted to the PPL system. Clicking the icon displays a box above the order overview with the option to select the date for ordering package pickup.

Automatic

On the tab Automatické odesílání (Automatic Sending), in the section Hlavní nastavení (Main Settings) in the PPL plugin, it is possible to set automatic ordering of shipment pickup for the next day upon shipment creation.

Age Verification

The PPL plugin supports age verification. This can be set for any product directly in the product detail on the PPL tab, where checking the Age Verification requirement is sufficient for activation.

Everything works automatically. If the order contains at least one product that requires age verification upon delivery, the entire order will require age verification.

You can choose between 15+ and 18+ limits.

Printing Labels

Label Printing Settings with myAPI

! We recommend using the Create package label (CPL) API, which does not need shipment number range settings. For new registrations, PPL will issue CPL API directly.

If you have an older registration and want to stay with myAPI, it is necessary to request a shipment number range from PPL, which you insert into the plugin settings on the “Hlavní nastavení” (Main Settings) tab. If the shipment number range runs out over time, have it increased by PPL support and update this value in the plugin settings.

The number range on the screen is just an example. Request your own from PPL support.

Setting Data on Label

The label is created by our plugin. For the label to contain all necessary data required by PPL, in addition to the shipment number range, it is also necessary to fill in:

• Sender company name visible on label
• Sender contact person visible on label
• Sender email visible on label
• Sender phone number visible on label

You can find shipment label settings on the “Hlavní nastavení” (Main Settings) tab

Setting Label Format, Note, and Reference Number

You can configure label format, note, and reference on the label in the PPL plugin, on the Hlavní nastavení (Main Settings) tab.

Downloading and Printing Labels

Labels of submitted packages can be downloaded directly in the website administration.

In the order overview for an order already submitted to the PPL system, click on the PDF document icon (see image) for the selected order. The label will be saved in PDF format, and then you can print it.

For a submitted shipment, the label can also be downloaded in the order detail.

Automatic Shipment Status Loading

To track the shipment status in transit directly in the order overview, you can use cron. You find it on the Sledování (Tracking) tab (Toret Plugins > PPL > Sledování). Then set up the cron in your hosting including the required execution interval.

Order Status Change Based on Shipment Status in Transit

On the Tracking tab, you can further set the order status change according to the shipment status at the carrier. Simply assign WooCommerce order statuses for given PPL statuses and save the changes made.

E.g. Upon successful PPL shipment delivery, the order status changes to Completed (Dokončeno).

FAQ

Custom VAT Rate for COD Surcharge

You set the VAT rate for COD in the Main Settings of the plugin, Rates and Taxes section. The tax rate can be determined by items in the cart or set fixed,