1. Documentation

Swiss Post: documentation EN

First of all, thank you for purchasing this plugin.

This documentation is to help you with each step of the configuration. Please go through the documentation carefully to understand how the plugin works and how to configure it properly.

Requirements

You will need a contract with Swiss Post to use the Digital Commerce API.
If you already have credentials, you may skip these steps.

  1. First, you must obtain a billing relationship with Swiss Post, which can be accessed here.
  2. You will then receive a franking license from your direct manager at Swiss Post.
  3. The credentials for the API can be retrieved here.

If you are planning to use the Swiss Post Barcode service, you must also register with Swiss Post for the Barcode service.

 This step is mandatory for the plugin to work.

How to install ↑ Back to top


Upload via WordPress Admin

The easiest way to install the plugin is through the WordPress Admin.

Go to your WordPress admin and visit Plugins » Add New.

Click Upload Plugin at the top of the page.

This will open the plugin upload form. Click Choose File and select the plugin ZIP file.

After you have selected the file, click Install Now.

WordPress will now upload the plugin file from your computer and install it for you. You will see a success message like this after the installation is finished.

Once installed, you need to click on the Activate Plugin link to start using the plugin.

WordPress documentation


Upload via FTP Server

In some rare cases, your WordPress hosting provider may have file restrictions that could limit your ability to install a plugin from the admin area.

In this situation, you need to install the plugin manually with FTP using these steps (not recommended for beginners).

  1. First, you will need to extract the plugin ZIP file on your computer.
  2. Open the FTP client on your computer and connect to your website
  3. Navigate to the /wp-content/plugins/ folder
  4. upload the folder you extracted from the zip file to the /wp-content/plugins/ folder on your web server.
  5. Visit the WordPress admin area and click on the Plugins link in the admin menu. You’ll see your plugin successfully installed on the plugins page.
  6. You need to click on the Activate link below the plugin to start using it.

 If you do not have any technical experience, we recommend contacting support for help.

Setup your credentials ↑ Back to top


To access the configuration page, please go to your WordPress admin area, then visit Woocommerce » Settings.

You will notice a new tab Swiss Post, click here.

To setup the plugin, please complete the fields Client Identifier and Client Secret. These credentials were provided by Swiss Post during registration and are mandatory for the plugin to work.

You may also choose which services you would like to use.

 Do not forget to save your changes when you’re done!

Barcodes ↑ Back to top


The barcodes plugin allows you to generate shipping labels for your packages, containing the address of the sender, the recipient, the delivery method, its options and the tracking barcode

Barcodes service setup

To access the barcode configuration, you must click on the “Barcodes” header.

In order to setup the plugin to use the Barcodes service, you must fill in your franking license(s) and environment mode.

If you add multiple franking licenses, a dropdown selection will be available when generating barcodes to choose which license to use for every label.

Delivery methods, options and handling

All the delivery methods, delivery options and handling options available with the plugin are listed. You can check the ones best suited for your activity to simplify the interface on the admin order page.

Please note that the delivery method & delivery and handling options you check here don’t determine how each label will be generated, but what options you actually see in the plugin.

PDF size

This option controls the intended print format of the labels. You may choose between A5, A6 and A7.

Status after label generation

The plugin will automatically change the status of your order upon a successfully generated barcode label, the most common use would be to set this to an In transit or Completed status. This is particularly useful when using the bulk order functionality as it prevents you from having to change every order’s status individually.

By default, the plugin will display your shop address as the sender on the barcode labels.

You may choose to display a logo instead of your address by uploading a logo.

The placement of your logo can be adjusted to your preferences using the rotationaspect ratiohorizontal alignment and vertical alignment options.

Notifications

After ordering, your customers can be kept informed of the shipment status and choose how they receive it.

This is a paid service.

Find out more

You may choose a logo to be displayed in notifications; this field is not required.

In order to set up the notifications you wish to use, you may use the notification builder. This tool allows you to add as many notification services as you want.

  1. Communication method: Choose between SMS or e-mail communication
  2. Service: The notification service you wish to use.
  3. Free texts (optional): For most e-mail notifications, you can provide texts which will be included, the content is up to you.

 If your shop offers customer side language support, be sure to provide the texts in all languages using the language switcher.

The plugin attempts to recognize your customer’s preferred language. As customer side languages are not natively integrated with WordPress, we currently offer compatibility for WPML and any language plugin that uses native user locales.

Single order usage

You can generate a barcode for a single order from the details page in the WordPress admin area.

To do so, you will find a new order action named Generate barcode, please select this action, and click Update.

A pop-up modal will appear showing the different options available.

Once you are satisfied with your barcode configuration, please click Submit to generate the barcode labels.

 In some situations, the download will not start automatically, in such case, you can start the download by clicking on the link that appears.

Bulk order usage

You can also generate barcodes for multiple orders in one go. Visit WooCommerce » Orders and check the wanted orders in the list.

You will then find a new bulk action available in the dropdown named Generate barcodes, please select this bulk action, then click Apply.

The same modal as in the previous section Single order usage will appear.

 In bulk generation mode, the same options will be used for each generated barcode label. Each label is generated separately, currently there is no way to combine them on one page

Shipment tracking

Natively, Woocommerce does not offer a functionality to save an order’s tracking number and send it to the customer. For this, the purchase of this additional plugin is advised. If it is installed, our plugin will automatically update the tracking number for the generated barcode.

If you do not want to install this module, you can find tracking numbers and tracking links in the order barcode generation modal

Address validator ↑ Back to top


The address validation module adds, below the address form in the Woocommerce checkout, a button allowing your customers to check whether their address is recognized as valid by the Swiss Post. If not, corrections will be proposed. There is no obligation to use it, your customers can still use an unvalidated address for their order.

Configuration

To allow your customers to validate their addresses with Swiss Post, please ensure you have activated the service in the plugin configuration.

Usage

Users can validate their Billing and Shipping addresses during checkout by using the Validate my address with Swiss Post button at the bottom of the form.

The button will become red or green depending on the status returned by Swiss Post.

Address autocomplete ↑ Back to top


The Address autocomplete module activates an “autosuggest” feature on the address fields of the Woocommerce order form. For example, when your customer starts typing a street name, they will automatically be offered autocompletion suggestions.

Configuration ↑ Back to top

To allow your customers to autocomplete their addresses with Swiss Post, please ensure you have activated the service in the plugin configuration.

Usage ↑ Back to top

Auto-completion will occur whilst completing the Billing and Shipping address forms.

WooCommerce - the most customizable eCommerce platform for building your online business.

  • 30 day money back guarantee
  • Support teams across the world
  • Safe & Secure online payment