nShift Transsmart Connector
Product Sheet
Section titled “Product Sheet”Documentation
Section titled “Documentation”How-to guides
Section titled “How-to guides”Installing the SmartPrint Client
YouTube
Section titled “YouTube”Dive into nShift Transsmart Connector features and usages at our YouTube channel.
1.2 Setup of nShift Transsmart Shipment Connector
Section titled “1.2 Setup of nShift Transsmart Shipment Connector”After the installation of the extensions is completed, the setup of the nShift Transsmart Shipment Connector can commence. Firstly, ensure that connection is established to the Transsmart Web Portal. Afterwards, setup the integration between the Transsmart Web Portal and the nShift Transsmart Shipment Connector.
1.2.1 nShift Transsmart Web Portal
Section titled “1.2.1 nShift Transsmart Web Portal”Begin the setup with the nShift Transsmart Web Portal.
- Log into the Transsmart Web Portal with the account information provided by nShift Transsmart:
- Production: https://my.transsmart.com/
- Test/Acceptance: https://accept-my.transsmart.com/
- Obtain the API User (username) and API Key credentials from the portal. These are required to configure the connector in Business Central.
- Note the Account Code(s) associated with your Transsmart account (e.g.
MYCOMPANY_NL). Account Codes are used to link Shipping Agents in Business Central to the corresponding Transsmart accounts.
- If label printing via SmartPrint is required, install and register the SmartPrint Client:
- Download and install the SmartPrint Client from the Transsmart portal.
- Register the SmartPrint Client in the portal.
- Note the SmartPrint Connection string. The format is
user@device. If the SmartPrint Client runs as a Windows service, the format isdevice$@device.
Note: The SmartPrint Client must be installed on the computer or server that is physically connected to the label printer. The SmartPrint Connection string is required when configuring printers in Business Central (see section 1.2.4).
1.2.2 nShift Transsmart Shipment Connector
Section titled “1.2.2 nShift Transsmart Shipment Connector”Utilise the search function (Alt + Q) in order to find Shipment Settings.
Note: If no settings record exists yet, an Init Transsmart action will be visible on the page. Click Init Transsmart to create the initial settings record with the default Transsmart URLs pre-populated.
Access Information (Production)
Section titled “Access Information (Production)”Insert the credentials obtained from the Transsmart Web Portal.
| Field | Description |
|---|---|
| Api User | Insert the API User (username) from the Transsmart portal. This field is only editable when Activated is disabled. |
| Api Key | Insert the API Key from the Transsmart portal. This is a masked field. Only editable when Activated is disabled. |
| Activated | Toggle to activate the extension and validate the license. |
Access Information (Test)
Section titled “Access Information (Test)”If you wish to use the Transsmart acceptance environment for testing purposes, configure the following fields:
| Field | Description |
|---|---|
| Api User (Test) | Insert the API User for the test/acceptance environment. |
| Api Key (Test) | Insert the API Key for the test/acceptance environment. |
| Test Mode | Enable to switch all API calls to the Transsmart acceptance environment (accept-api.transsmart.com). This field is only editable when Activated is disabled. |
Note: When Test Mode is enabled, the Portal Url and Auth Server Url are automatically switched to the corresponding acceptance environment URLs.
Service (URLs)
Section titled “Service (URLs)”The following URL fields are pre-populated with default values when the settings record is initialised. Under normal circumstances these do not need to be changed.
| Field | Production Default | Test Default |
|---|---|---|
| Api Url | https://api.transsmart.com/v2/ | https://accept-api.transsmart.com/v2/ |
| Portal Url | https://my.transsmart.com/ | https://accept-my.transsmart.com/ |
| Auth Server Url | https://api.transsmart.com/ | https://accept-api.transsmart.com/login |
| Code Prefix | (optional) | A prefix applied to codes downloaded from Transsmart. |
Other Important Settings
Section titled “Other Important Settings”| Field | Description |
|---|---|
| Confirm Type | Controls the shipment confirmation flow. Direct Print sends the shipment immediately. Confirm Shipment displays a confirmation prompt before sending. Confirm Package prompts the user for confirmation per individual package. |
| Default Printer | Select the default SmartPrint printer to be used for label printing. This printer is pre-selected on all shipments. |
| Weight Unit | Set the default unit of measurement for shipment weight. |
| Length Unit | Set the default unit of measurement for shipment dimensions. |
| Shipment Information | Select whether the sender address is sourced from Company Info, Location, or a Custom Address. |
After entering the credentials, verify the connection by clicking Test Connection in the action bar under Actions > Platform > Test Connection.
1.2.3 Transsmart Account Codes
Section titled “1.2.3 Transsmart Account Codes”Before downloading data from Transsmart, at least one Account Code must be configured in Business Central. Account Codes link Business Central to specific Transsmart accounts and are required for the Download Shipping Agents action to function correctly.
To open the Account Codes list, either:
- From Shipment Settings, navigate to Account Codes in the navigation area, or
- Utilise the search function
(Alt + Q)to search for Transsmart Accounts.
Add one or more Account Codes by pressing the + New button and filling in the following fields:
| Field | Description |
|---|---|
| Account Code | The account code from the Transsmart portal (e.g. MYCOMPANY_NL). |
| Description | A descriptive name for the account to aid identification. |
Important: The Download Shipping Agents action will fail with an error if no Account Codes have been configured. Ensure all relevant Account Codes are added before proceeding to section 1.2.5.
1.2.4 SmartPrint Client Setup
Section titled “1.2.4 SmartPrint Client Setup”SmartPrint is the Transsmart label printing client. It must be installed on the computer or server that is connected to the label printer. The SmartPrint Client communicates with the Transsmart API to receive and print labels automatically when a shipment is confirmed in Business Central.
Steps to configure SmartPrint:
-
Download and install the SmartPrint Client from the Transsmart portal. Refer to the SmartPrint installation guide for detailed instructions.
-
Register the SmartPrint Client in the Transsmart portal and note the SmartPrint Connection string. The connection string has the format
user@device. If the SmartPrint Client is running as a Windows service, the format isdevice$@device.
- In Business Central, after downloading printers (see section 1.2.5), open Shipment Printers from Shipment Settings (navigation area), or utilise the search function
(Alt + Q)to search for Shipment Printers.
- For each printer, configure the following fields:
| Field | Description |
|---|---|
| SmartPrint Connection | The connection string from the Transsmart portal. Format: user@device. If SmartPrint runs as a Windows service, use device$@device. |
| Printer | The name of the printer as registered in the SmartPrint Client. |
| Printer Type | Select the label format: printer_zpl (ZPL labels), printer_pdf (PDF labels), or printer_doc (document). |
Tip: After configuring printers, set the Default Printer on the Shipment Settings page to pre-select a printer for all shipments.
1.2.5 Download of Data
Section titled “1.2.5 Download of Data”All data downloads are performed from the Shipment Settings page, using actions in the Platform group in the action bar under Actions > Platform.
The recommended order for downloading data is as follows:
-
Test Connection — Verify that the API connection is working correctly before proceeding with any downloads.
-
Download Shipping Agents — Downloads all Shipping Agents (carriers), Shipping Agent Services (service level times), and Additional Services (service level other) for all configured Account Codes.
-
Download Parcel Types — Downloads Package/Parcel Types for all Shipping Agent Services.
-
Download Shipment Printers — Downloads SmartPrint printers registered in the Transsmart portal.
You will receive an acknowledgement when the data is correctly transferred.
Note: The Download Shipping Agents action iterates over all Transsmart Account Codes configured in Business Central and calls the Transsmart API for each one. Each downloaded Shipping Agent is automatically linked to its corresponding Account Code.
Be aware: Run Download Shipping Agents before Download Parcel Types, as Parcel Types are linked to Shipping Agent Services and require those to exist first.
After downloading printers, return to Shipment Settings and select the desired printer in the Default Printer field.
1.2.6 Shipping Agent & Shipping Agent Services
Section titled “1.2.6 Shipping Agent & Shipping Agent Services”Below is shown an overview of the various Shipping Agents that have now been downloaded. The overview can be found by searching for Shipping Agent in the search field (Use Alt + Q).
Each Shipping Agent includes an Account Code field that links it to the Transsmart account from which it was downloaded.
Every Shipping Agent has various services associated with it. The Shipping Agent Services specify the carrier product which is ordered to handle the parcel. Note that there can be different Shipping Agent Services depending on which countries you are shipping to. Select a Shipping Agent on the line and select the following in the ribbon:
Shipping Agent > Shipping Agent Service
The following fields exist in the Shipping Agent Service overview:
| Field | Description |
|---|---|
| Code | This code is used when selecting a Shipping Agent Service in Business Central. Shipping Agent and Shipping Agent Service is specified e.g. on a Sales Order or Sales Shipment. It is possible to rename the code to a name that is more descriptive for the user. |
| Country Code | Defines which destination country this service applies to. Leave blank to apply the service to all countries. |
| Default | Select a default Shipping Agent Service which is automatically inserted onto the waybill line when the Shipping Agent is selected. This can be overruled on the Waybill lines. |
| LDM (Loadmeter) Factor | If you are booking with Loadmeter it is necessary to define an LDM Factor. Normally, this factor is 2.4. The volume-based freight calculation is: Length × Width / 10,000 / Factor. If the field is left blank, Loadmeter will not be enabled on the service. Consult the tooltip for additional information. |
| Customs Type | Defines which customs implementation to use for this service. The default value is Dutyfree. |
| Use Servicepoints | Enable this field to allow service point (pick-up point) selection when creating a shipment with this service. See section 1.2.9 for further details. |
Note: The Shipment Code and Shipment ID fields are read-only and are set automatically during the download of Shipping Agents. Do not attempt to modify these values.
1.2.7 Addons, Additional Services & Notifications
Section titled “1.2.7 Addons, Additional Services & Notifications”Every Shipping Agent has various supplementary services associated with it. It is possible to assign optional services to a Shipping Agent Service.
The options available differ from Shipping Agent to Shipping Agent but also from Shipping Agent Service to Shipping Agent Service. However, SMS and E-mail notifications are universally available. It is possible to select multiple addons, services and notification types.
An example of an optional service is E-mail Notification where the receiver of the shipment will receive an e-mail notification containing the status of their parcel. There can be multiple optional services added to a Shipping Agent Service.
Additional Services (service level other) are downloaded together with Shipping Agents via Download Shipping Agents. The optional services for a Shipping Agent Service can be found in the Shipping Agent Service tab. In the tab find:
Related > Services
Note: If you select multiple optional services it may require you to insert additional information in Business Central. For example, if you select the optional service “E-mail Notification” it is required to specify the receiver’s e-mail address in Business Central on the related Waybill.
An overview of the selected optional Shipping Agent services is also available on the Sales Order. This is found in a fact-box at the bottom right of the sales order.
It is possible to acquire insurance for a shipment. This is done by choosing the equivalent Insurance addon for a given Shipping Agent Service. A similar function exists for Cash on Delivery. Once the addons/additional services are activated you can select a Service Type.
Once these criteria are met, it is possible to specify the insurance or cash on delivery amount in their respective fields on the waybill. Once activated the fields are also editable which enables users to manually insert an amount. At default the insurance amount will be the purchase price excluding VAT whereas the Cash on Delivery amount will be the purchase price including VAT.
Be aware: If you add an addon or an additional service to a shipping agent it will update on every open post. We recommend that you create a new shipping agent service named appropriately for its purpose.
For instance, a Shipping Agent may have a shipping agent service named Parcel. There may be occasions where you would like to add an SMS or Email notification for the receiver of the shipment so they are notified of the status of their order. The best practice suggested is to copy the current Parcel service and name it appropriately for the context — such as “Parcel with SMS & Email notification”.
In order to create/copy a new shipping agent service, access the ribbon and select the following:
Actions > Copy Shipping Agent Service
Afterwards you will be prompted with a wizard where you can enter the new Shipping Agent Service code, as well as a name/description for the service (e.g. “Parcel with SMS & Email notification”).
Once finished, select the OK button and the service will be available in the overview.
Lastly, select the newly created shipping agent service and add the desired addons and extra services.
1.2.8 Package Types
Section titled “1.2.8 Package Types”Every Shipping Agent Service has one or more related Parcel Types (Package Types). The Parcel Types have a number which cannot be altered and a description which may be changed — additionally, it is possible to adjust the dimensions of the package: Length (cm), Width (cm) and Height (cm).
The description of the package, as well as the dimensions, are automatically inserted onto the waybill lines when the package type is selected. It is also possible to define Pallet Exchange and select a package type as the default package type for the Shipping Agent Service — this in turn will insert the package type automatically when the Shipping Agent Service is selected.
Parcel Types are downloaded via Download Parcel Types on the Shipment Settings page (see section 1.2.5). In order to access the overview for a given Shipping Agent’s package types, navigate to the given Shipping Agent, select a Shipping Agent Service on the line, and then access the following in the ribbon:
Related > Package Types
Afterwards, you will be shown the aforementioned overview.
It is also possible to create a new Package Type for the Shipping Agent Service. This is done by selecting a package type on the line and accessing the following in the ribbon:
Actions > Copy Package Type
Afterwards, you will be prompted by a new window where the setup of the new package type takes place. When the new package type has been named and given a unique number, press the OK button to continue.
The new package type is now found in the overview and can henceforth be selected as a package type when shipping.
1.2.9 Service Points (Pick-up Points)
Section titled “1.2.9 Service Points (Pick-up Points)”Transsmart supports service points (pick-up points), enabling shipments to be delivered to a parcel shop or other collection point rather than directly to the recipient’s address.
Unlike some other connectors, service points in Transsmart are fetched dynamically per shipment based on the ship-to address — they are not pre-downloaded as a static dataset. An active API connection is therefore required at the time of shipment creation.
To enable service point selection for a Shipping Agent Service:
- Open the Shipping Agent Services page for the relevant Shipping Agent (Use
Alt + Qto search for Shipping Agent, then navigate via Shipping Agent > Shipping Agent Service in the ribbon). - Enable the Use Servicepoints field on the relevant service.
When creating a shipment, if the selected Shipping Agent Service has Use Servicepoints enabled, a Service Point List will be available to select the desired pick-up location.
In the overview it is possible to see the Name, Country/Region Code, Zip Code, City and Address for the Service Point.
Note: Service points are retrieved in real-time from the Transsmart API based on the ship-to address (country, postal code, city, street). An active API connection is required at the time of selection. Ensure the ship-to address is complete before opening the Service Point List.