1. Brief introduction

To be able to make transport bookings with one or more transporters, from one environment, Transsmart has built a so-called 'API'. This API environment is called MyTranssmart.

Magento has a connection (plugin) with MyTranssmart: SmartConnect. This link makes it possible to send orders, print labels and track statuses from your Magento web shop.

This document describes how to configure SmartConnect in Magento.

 

2 Preparation

To use SmartConnect, you need:

Hardware 

• A recent Windows (not Windows XP) or Apple PC.
• A graphic A4 printer or a Zebra sticker printer (preferably GK420d).

Software 

• Magento 2.0 or higher.
• SmartConnect plugin (available via Transsmart).
• The QZ tray print utility 2.0 and SmartPrint (downloadable via  https://my.transsmart.com).
• An internet browser (Google Chrome, Firefox, Internet Explorer, Safari).
• A recent version of Java (installed on the PC from which it will be printed, or on the network in the case of a network printer).
• Communication ports 8181 and 8282 must be open for printing.

Transsmart 

• Has set up the underlying MyTranssmart account for you.
• Has the activated the link(s) with your carrier(s).
• Has provided you with the account details (username, password and account ID).

2.1 SmartConnect installation

Log in to your Magento environment (as you usually do with your Magento log-in data). SmartConnect for Magento can be installed by the administrator of your web shop. SmartConnect can be downloaded via packages.transsmart.com via a customer specific login. This login will be sent to you by Transsmart. On this page there are further instructions regarding the installation.

The code for the plugin is clearly legible for your Magento administrator. In addition, it is written so that it is also applicable if you do not have a standard Magento environment. Your administrator can, if necessary, make custom edits based on this code. If your manager needs technical advice in this area, our partner Techtwo BV can provide this. SmartConnect for Magento is compatible with both One-page checkout and OneStepCheckout.

After this you can start configuring the SmartConnect. This provides the connection between Magento, Transsmart and the linked carriers. The configuration is accessible to a Magento user with administrator rights. In this configuration, in addition to creating a connection, you can configure the following:

• The standards regarding transporter profile, e-mail notification, incoterms, cost centre and packaging type.
• Which printer is being used.
• Which carrier profiles are visible in the checkout for your customer and how they are visible in the checkout; as a delivery option or pick-up option.
• Whether a location selector (map) is visible in the checkout.
• Which transport price is calculated.
• For which countries a carrier profile can be selected.
  
  

3. SmartConnect configuration

After SmartConnect is installed in your Magento environment, the configuration can start. To configure SmartConnect, go to Magento via Stores > Configuration to the Sales tab (on the left of the menu). Here you can see that two items have been added after installing the plugin: Transsmart and Transsmart Booking Profiles. Select Transsmart.

 

3.1 Set up connection

 Under 'Environments' enter the username, password and account ID you received from Transsmart. To be able to book shipments to the carrier, this environment must be 'live'. We advise you to always start in a test environment first. Your Magento partner can set this up for you. You also start in a test environment for Transsmart. You do this by selecting 'staging'. Shipments are not yet sent to the carrier.

Do you not yet have a test environment at Transsmart? Please contact us at this link. After configuring, click on 'Save config' in the upper right corner to save the settings.

You can then retrieve the configuration of the links(s) that Transsmart has made with your carrier(s) via the 'Default Shipment Properties' tab using the 'Load Transsmart data' button. You will see a rotating hoover with 'Please wait…' while the data is being retrieved. The data is not retrieved until after the page has automatically refreshed and the yellow bar will indicate when the final update has been completed.

3.2 Configuring the standard properties of a shipment

You can set the default properties of a shipment via Stores - Configuration - Stores - Transsmart under the 'Default Shipment Properties' tab. Here you define the properties with which a shipment is created. For each shipment, these settings can still be changed by editing the order. See the user manual for this.

Here you define the following standard details for a shipment:

• Booking Profile | This concerns all transporter profiles that have been configured at Transsmart. A transporter's profile is a combination of transporter, service (service level) and possibly also an additional service (service level other).
• Email Type | This concerns the e-mail notification that is sent via Transsmart to your customers (if this has been configured).
• Incoterm | This concerns the incoterm conditions under which your shipments are sent by default.
• Cost centre | If you wish to be able to send from different names or under different contract numbers, cost centres can be configured by Transsmart. Here you determine which cost centre is used by default.
• Package | Here you determine the standard packaging type used for a shipment.

If you have changed something in one or more fields, choose 'Save Config' in the top right corner.

For all options, it must be configured by Transsmart and then retrieved in the Magento environment using the 'Load Transsmart data' button. Do you want to make changes to the options? Please contact us at this link.

 

3.3 Set up Transsmart pickup locations

In the Transsmart menu (Stores - Configuration - Sales) you will find the tab 'Transsmart Pickup locations'. Here you can configure which carriers you want to show in the checkout as a pick-up location. This means that your customer can select this carrier on the map at checkout and the shipment is delivered to the desired pick-up location.

3.3.1 Default settings pick-up locations

• Enabled for Checkout | Here you indicate whether you want to use pick-up locations.
• Shipping Method Name on Frontend | Here you indicate how you want to name the pick-up locations in the checkout.
• Request shipping rates dynamically | If you have the rates of the carriers set at Transsmart, you can indicate here whether you want to collect the rates from the carrier at Transsmart or whether you offer a fixed price per profile to your customer.

If you have changed something in one or more fields, choose 'Save Config' in the top right corner.

 

3.3.2 Configure pickup locations

In the 'Transsmart Pick-up locations' tab you can indicate for pick-up profiles which pick-up locations you want to display in the checkout for your customer.

• Click on 'Add profile' to add a new profile. A new blank line will appear in the grey area.
• Active | Here you indicate whether the profile can be shown in the checkout.
• Carrier profile | Here you select the carrier profile you want to display in the checkout. Please note that all transporter profiles can be seen here, not just the pick-up locations. Make sure you select the right service from the carrier.
• Title | Here you can indicate how you want to name this carrier profile. This title is shown in the checkout.
• Price | Have you opted to configure the transport costs yourself and not via the transport costs that are set at Transsmart? Then you can configure the transport costs here. This price is included in the total amount to be paid by the customer. If you enter nothing here, an amount of € 0.00 will be displayed in the checkout. If you want to configure 'no transport costs' from an x amount, use the Magento functionality 'shopping cart price rules'. Ask your Magento partner for advice. This can be combined with SmartConnect and the prices that you set via stores > configuration > sales > Transsmart. The result is that in the checkout you will see a transport price of € 0 from an x amount of product value.
• Action | Here you can optionally delete a profile if you no longer use it.

If you have changed something in one or more profiles, choose 'Save Config' in the upper right corner.

The pick-up locations are shown in a map from Google Maps. For this you need a Google API key. You can configure these under the pickup profiles at 'Google Maps API key'.

For example, if you have set up the following in your configuration (this is just an example):

 Then in the checkout this shipping option is displayed as follows:

If the customer clicks on the button 'Select location' the following pop-up opens where the customer can choose the pick-up location:

 

3.4 Set up Transsmart delivery options

In the Transsmart menu (Stores > Configuration > Sales > Transsmart) you will find the Shipping Methods tab. Here you can configure which carriers you want to show in the checkout as a delivery option. This means that the shipment is delivered to the delivery address.

 

3.4.1 Default settings delivery options

• Shipping Methods to Profiles Map | If you use fixed rates in Magento, you can choose here which carrier profile you would like to use to send these shipments. The fixed rates are set via Stores > Configuration > Shipping Methods > Flat Rate.
• Shipping Carrier Title on Frontend | Here you can indicate how you want to name the delivery options in the checkout.

If you have changed something in one or more fields, choose 'Save Config' in the top right corner.

 

3.4.2 Configure delivery options

In the 'Shipping Methods' tab in the Transsmart menu you can indicate in Delivery methods which delivery options you want to show in the checkout for your customer.

• Active | Here you indicate whether the profile can be shown in the checkout.
• Carrier profile | Here you select the carrier profile you want to display in the checkout. Caution: all transporter profiles are displayed here, so not just the delivery options. Make sure you select the right service from the carrier.
• Title | Here you can indicate how you want to name this carrier profile. This title is shown in the checkout.
• Price | Here you can set the transport costs. This price is included in the total amount to be paid by the customer. If you enter nothing here, an amount of € 0.00 will be displayed in the checkout. If you want to configure 'no transport costs' from an x amount, use the Magento functionality 'shopping cart price rules'. Ask your Magento partner for advice. This can be combined with SmartConnect and the prices you set via Stores > Configuration > Sales > Transsmart. The result is that you can see a transport price of € 0 in the checkout from an x amount of product value.
• Action | Here you can optionally delete a profile if you no longer use it.

If you have edited something in one or more profiles, select 'Save Config' in the upper right corner.

For example, if you have set up the following in your configuration (this is just an example):

Then it will look like this in the checkout:

 

3.5 Mapping parameters

If your webshop uses multiple street fields, you can configure how each field is used. This is possible through Stores > Configuration > Sales > Transsmart > Transsmart mapping parameters.

You can only use description, country of origin, HS code and Reason of export in the case of customs documents for which you have to send a paperless invoice. If you want to make use of this, these services must be linked to Transsmart for you. Please contact us through this link for this.

 

3.6 Set transporter profiles per country

In the Stores tab > Configuration > Sales > Transsmart Booking Profiles allows you to determine by carrier for which countries the carrier profile is visible. This is determined on the basis of the country code that the customer has chosen as the delivery address. You can select all countries or specific countries. If you want to select or deselect multiple countries, you need to hold down the Ctrl key.

If you have edited something in one or more profiles, select 'Save Config' in the upper right corner.

 

3.7 Set up sender address

The sender address originates from the standard Magento settings. The address can be set via stores > general > general > store information. This address is sent as standard to Transsmart and used as the sender address in the bookings.

For manual bookings in MyTranssmart, your business address is set as standard. This can be adjusted by logging in to MyTranssmart. Then go to 'Manage account' at the top and choose Dispatch locations. Here the sender address is set which is used for manual bookings in MyTranssmart.

 

4. Printing from Magento

Printing from Magento is fully integrated. However, this must be configured once in MyTranssmart for it to work.

To print with Magento, you always need the QZ Tray print program. In addition, it is necessary to also install the SmartPrint print program in order to be able to print from Magento.

The utilities must be installed and accessible at the level at which you print the labels, that is, locally if the printers are installed locally or on the print server if you print labels through a server.

 

A. Install Qz tray

To download the most recent version of this program, log in to MyTranssmart first.

If you are already logged in, click on MyTranssmart on the printer button (top right) and then on 'download QZ Tray':

The QZ Tray icon will appear at the bottom right of your taskbar. If it is green, you have successfully installed the program.

 

Tip: Right-click on the QZ Tray icon at the bottom of your taskbar. Then click on 'automatically start'. The program will now always start automatically when you switch on your PC.

 

B. Install SmartPrint

To print from Magento you need the SmartPrint tool. To configure the SmartPrint tool, you need to carry out the actions below once only.

• Click once again on the printer button (top right) and then on 'download Smartprint'.
• The SmartPrint icon will appear at the bottom right of your taskbar.
• Right click this icon and choose connection status.
• Fill in user credentials and hit connect.
• Right click the icon again and choose exit
• Hit the windows key and type SmartPrint to restart the application
  
  

C. Configuring printers in MyTranssmart

Make sure the QZ-tray is started up first and that the icon is green. Then start SmartPrint and log in to MyTranssmart.

• Then click on the persona icon in the upper right corner and then choose MyDetails.

• Go to 'printing' and select the 'print with SmartPrint' box.
• Select the available connection.
• Then select the printer with which you want to print.
• Click on the 'save' button.

Different printers can be defined for each user, but only one can be connected via a SmartPrint tool.

 

5. Table rates

Magento has so-called 'table rates'. This is a functionality that allows you to further specify transport prices in the checkout. These table rates also work in combination with the Transsmart transporter profiles. This way you can specify on the basis of the information below which transporter profiles can be shown in the checkout and you can configure different prices for each profile.

• Destination versus weight
• Destination versus subtotal order
• Destination versus number of items

Table rates is a Magento functionality. For further information on this, we advise you to contact your Magento partner. The explanation in this document is only an explanation for the Transsmart part in table rates.

A. Setting up table rates

In order to determine which carrier profile can be offered per line of table rates, you need to look up the ID codes of the transporter profiles. Log in to MyTranssmart, go to 'Manage account' and choose 'Booking profiles' in the menu. Here you will see a unique ID per carrier profile. In the example below this is D4U1, D4U2 etc.

A table rate based on the subtotal of the order is then displayed as follows, for example;

In the last column a space has been added for ID codes of the transporter profiles. The table rate can be read as follows;

If your customer has a shipment to NL with an order value between 0 and 20 euro, your customer will see 2 transporter profiles in the checkout:

• D4U1: DHL 4 You Evening delivery for € 2.50
• D4U2: DHL 4 You standard delivery for € 2.00

Should the shipment have an order value of € 50 or more, the customer will only receive D4U or DHL 4 You as standard, not with neighbours for € 0 in the checkout.

Please note, table rates do not yet work with profiles for which time a pick-up location has to be chosen (V1.1). You can currently only use table rates with delivery options.

This logic works exactly the same for table rates based on destination versus weight and destination versus number of articles.

6. Extension version and hyperlinks

Via the configuration menu, stores > configuration > sales > Transsmart, you can see which version of SmartConnect you have used.

You will also find hyperlinks to:

• MyTranssmart both acceptance (test environment) as the production surroundings.
• Manuals from Magento and MyTranssmart.
• Transsmart Helpcenter.

Please use our help center to notify us of any questions or requirements. Via the Helpcenter you can be kept informed of updates, maintenance work and malfunctions for all parties involved by selecting 'follow' next to announcements in the Release Notes forum. The same can be done on our statuspage. You must create a user in the helpcenter when using it for the first time. You can create your own password using your e-mail address. Is your e-mail address already in use? Select 'forgot my password'. You can then create a new password.

Attached you'll find the usermanual for the SmartConnect Magento 2.X plugin.