Outdated documentation

This documentation is created for DYMO Label Software. We advise to use DYMO Connect for Windows. We’re currently working on new documentation. However the principles are still the same, so the documentation below will help you also if you use DYMO Connect.

Mac users: We advise to use DYMO Label Software version 8.7.5 or above.

Introduction

DYMO Web Service needs to be up and running on your system to use WooCommerce DYMO Print.

The DYMO Web Service controls all communication between WooCommerce DYMO Print and your DYMO LabelWriter. On this page you’ll find all information you need if you’re experiencing problems during printing.

What does it do?

In the past, developers had to provide a browser-specific plug-in for each major web browser. Nowadays, most browsers have phased out native plug-in support. Google, for example, stopped supporting Chrome their NPAPI browser extension in September 2015. In response, DYMO released the DYMO Web Service as a new cross-browser solution allowing third-party developer applications the ability to interface with the DLS SDK in a seamless, browser-agnostic fashion.

It handles all printer-related requests from the JavaScript Library which is used in WooCommerce DYMO Print.

Installation

To install DYMO Web Service you need to download and install the latest version of DYMO Label Software.

Debug information

How can I tell if DYMO Web Service is installed?

The DYMO Web Service should be installed as long as you have installed DYMO Connect (Windows) or DYMO Label Software 8.7.5 (Mac) or newer using the setup type “Complete” mode.

If you choose to install DYMO Label Software in “Custom” mode, be sure to select the DYMO Label Web Service component as follows:

If installed, there will be an executable file named DYMO.DLS.Printing.Host.exe within the DLS working folder (normally found within the C:\Program Files (x86)\DYMO\DYMO Label Software folder on Windows and the /Library/Frameworks/DYMO/SDK folder on Mac).

How can I tell if the DYMO Web Service is running?

You should see the DLS application icon within the system tray. Right-click this icon to display a context menu. The menu displays the web service’s status (i.e., “Started on port 41951” or “Stopped”).

The following shows what it looks like on Windows.

On Mac, the DLS application icon and context menu will appear within the system tray like this:

I do not see it in the system tray. How can I start it?

Windows

You can start the web service again by navigating to the DLS working folder and running the executable named DYMO.DLS.Printing.Host.exe.

MAC

Open a Finder window, navigate to the /Library/Frameworks/DYMO/SDK/ folder, and click on the DYMO.DLS.Printing.Host.app icon.
Open a terminal prompt and enter the following command:

launchctl start com.dymo.dls.webservice 

Start & Stop

WooCommerce DYMO Print will not work if you stop the DYMO Web Service.

You can start or stop the web service at any time by clicking on the Start service and Stop service menu items, respectively. Although the service icon will remain in the system tray after stopping it, no API functions will be executed.

Run diagnose

If you’re experiencing errors during printing check if the DYMO Web Service is working correctly.

Click the Diagnose menu item within the context menu while the service is running. If the self-test succeeds, a dialog box will appear asking you to open a test page in your browser to see if SSL certificate is working.

Click the Yes button to open your default web browser. The browser should display a page indicating the web service is running correctly. The page address should be something to the following effect:

https://127.0.0.1:41951/DYMO/DLS/Printing/Check

The port number may vary from machine to machine.

If everything is OK, the following message should appear:

Configuration

Advanced use only! By default the DYMO Web Service does not need any configuration. If you change these settings WooCommerce DYMO Print could stop working.

Clicking the Configure menu item will open a configuration window. This allows you to change the language and listening port. The web service will normally try to use the first available port within the 41951-41960 range. You can override this behavior by checking the Use single port checkbox, which makes the service only try using the specified port only. You cannot specify a port number that does not fall within the specified range. The service will not try using any other port if an error occurs while using this option.