Here is an overview of the system requirements for nShift Ship (former Consignor) including ports, web services, and IP addresses used. This page covers On-premises, Ticket, Portal, and Scan App.
- Ship system requirements
- Portal and Drop Zone requirements
- Scan App Pro requirements
- Date and time
- Label size
- Network requirements and ports
- Secure data transfer
- SPF record
- Folder security
- Printer requirements
- Portal DNS Servers to be whitelisted
- Webservices and URLs
- Encodings support
|Platform||Windows Edition||Minimum hardware||Software requirements|
Windows Server 2022
Windows 8 - 10
Windows Server 2019
It is possible to install On-premises on a shared server but we recommend using a dedicated server. This will ensure more stable performance. We also do not recommend installing On-premises on a domain controller. Running On-premises Clients on a different network than the On-premises server is an unsupported solution.
Portal, Ticket, and Drop Zone requirements
|Platform||Operating Systems||Minimum hardware||Supported Browsers|
|Portal + Ticket||
Windows 8 - 10
Running https is required.
Scan App Pro requirements
Scan App Pro is available for Android and iOS. Scan App Pro runs on iOS 11 or later or Android 5 or later. It is recommended to always keep the app updated to the latest version.
IP addresses used by Scan App Pro
Use these IP addresses if you need to use a fixed IP address for Scan App Pro.
The following 5 IP addresses are in use until May 7, 2023:
From May 7, 2023, the following IP address will be used and replace the 5 old IPs:
If you get a message saying "No internet or network wrongly configured!" your phone is not able to access the Internet or you may have firewall settings blocking the access on your network.
Domains to whitelist for camera scanning:
Main server: https://mlts.dynamsoft.com, port: 443
Standby server: https://slts.dynamsoft.com, port: 443
Date and time
Date and time must be set correctly on your system to ensure the best performance. Incorrect date and time on your server may cause performance degradation and missing or invalid data in Portal. It is also important to use the correct date and time if you are using our APIs to make sure security tokens are valid.
Check the current date and time on www.timeanddate.com. If your system is in sync within a 5-minute margin of the time on this page it should be correct.
Labels are optimized for thermal labels sized 100x192 mm (EU+international) or 4x6 inch (US). Larger-sized labels will also do but please note that if you are using smaller-sized labels, only the labels from selected carriers will be printed correctly.
Network requirements and ports
Ports in use by Ship externally:
TCP 80/443 (HTTP/HTTPS - Ship uses a handful of web services, read more in this section: Ship web services and URLs.
TCP 21 (FTP/FTPS - Ship may be configured to use FTP/FTPS, if you are uncertain about your configuration please contact your local Customer Service department)
TCP 9999 (SFTP - Ship may be configured to use SFTP, if you are uncertain about your configuration please contact your local Customer Service department-)
TCP 25 (SMTP - Ship may be configured to use SMTP (Mail), if you are uncertain about your configuration please contact your local Customer Service department.)
Local ports in use by Ship:
52346 (In use by client to connect to server).
52345 (In use by clients when fetching updates from server).
52347 (In use by server for a local process "import.exe" running an integration module).
52348 (In use by server for a local process "JobExecutor.exe" running multiple tasks).
Note: These local ports can be configured, contact your local Customer Service department if this is needed.
Note that Ship is a software that uses MS SQL Server for its database, the database communication is done by both server and client. See Microsoft's site for details on network requirements: https://support.microsoft.com/en-us/kb/287932.
Secure data transfer
We have secure data transfer (HTTPS) between all Ship internal web services.
Exceptions are 3rd party web services, which do not support secure connections, i.e. transmit of data to carriers (EDI).
All web services called from On-premises can use HTTPS if the option is activated in the On-premises settings. FTP depends on configuration. We support FTP, FTPS and SFTP.
SMTP depends on the configuration (e.g. mailback).
Ticket/Shipment Server API
The communication protocol is HTTPS (port 443).
Data upload to Portal
The communication protocol is HTTPS (port 80).
Drop Zone always uses ports 80 and 443 or 8089. It is a configuration choice to use either port 443 with SSL/TLS protocol, or port 8089 without. Port 8089 may be configured to another number.
Portal API (data web services)
Available both with HTTP (port 80) and HTTPS (port 443).
Some customers are using nShift's SMTP server along with their own email server on their own domain. It is mandatory to add an SPF record to your domain, to avoid emails sent through nShift’s SMTP server being classified as spam.
An SPF record is a txt record added to your domain’s DNS and is specific for each domain.
Example of an SPF record including Consignor’s SMTP servers:
v=spf1 mx include:spf.protection.outlook.com include:_spf.consignor.com ~all
You MUST include the "include:_spf.consignor.com" if you are sending e-mails from our solution.
Read more about SPF:
Folder security - On-premises server:
When installing an On-premises server, it is required that the user executing the installation package is a local administrator. Following that it is expected that the user (or 'Local System account' running our local service "Consignorserver" have local administrator rights. If the Consignorserver service is not run with local administrator rights, not all functionalities will run properly.
Folder security - On-premises client:
The user logged on to Windows needs to have access to read the local folder where the On-premises client is installed (by default: C:\Program Files (x86)\Consignor client\
Every user that opens up the On-premises client will try to create a folder with configuration files under C:\Users\<username>\appdata\roaming\Consignor\Consignor - to be able to create and maintain these configuration files the Windows user account should have proper access here.
NOTE: After an update to the On-premises server, it will run the process UpdateClient.exe (found in the Consignor client installation folder). The user that opens up the client needs to have read and write access to the Consignor client installation folder.
Folder security for file drop integration:
When using file drop integration it is required that the service Consignorserver has access to read and write to the configured folders.
Printer requirements - On-premises client:
The user logged on to Windows needs to have the "Print" permission to the printer driver - On-premises by default tries to check printer status which requires the security permission "Manage this printer". This status check can be turned off if needed.
Printer requirements - On-premises server:
Regular printing requirements on server. This method has the same printer requirements as the On-premises client has.
Automated printing requirements on server:
The automated printing (auto print etc) is executed by the local service 'Consignorserver', and this service needs the proper rights. Read more here: Printer setup in nShift On-premises.
Portal DNS Servers to be whitelisted
Some customers need to whitelist DNS/IPs in their firewall or FTP. Here's an overview of the IP addresses used:
Portal Gateway (ReturnData & ExportData)
portalgateway.consignorportal.com (22.214.171.124 and 126.96.36.199)
APIs (there will be multiple APIs on this URL)
Ship web services and URLs
Ship uses several web services, we recommend that the web services mentioned underneath are whitelisted in firewalls, etc.
Our servers run mainly on these sites for web services outgoing on port 80 / 443:
Our web services support TLS 1.2
Address lookups, drop point validation, etc:
Automatic refill of shipment numbers:
EDI file transmit:
Resource Center for AutoUpdates
To verify access, go to: https://api.consignorportal.com/ApiGateway/healthcheck/index. Press F12 to bring up the console. Click the Network tab and see that you get a Status 200.
Example from Google Chrome:
Example from Firefox:
Upload of shipments to Portal:
Some carriers might also have specific web services to function properly.
You might also see all our web services and their functions in the configuration file located at C:\Consignor\Consignor\LiveUpdate\Config\FactorySettings\WebServerConfiguration.xml
Our web services might run from both client and server.
See also how to set up Proxy settings here.
How to check connectivity towards our web services:
- Open an internet browser
- Copy one of the URLs into the address bar and hit enter.
- If one of the screenshots below is shown the web service should be open.
NB: Even if you can access the web service through your browser but not Ship it could be proxy settings in the browser.
We support the following encodings in import and import upload files:
- UTF8 without BOM