This article will take you through the steps of setting up our csv importer service for Windows.

Required:

Optional:

Setting up the CSV importer connection

If you haven't done so already, the first step is to create a configuration for your csv files. Give the following article a try, if you're in doubt on how to do that: https://support.webshipper.com/en/articles/2970731-how-to-use-the-csv-import

When that's done, you can download the csv-importer here:

Extract the zip file, to any direction and open up the Webshipper-CSV-Settings.exe. 

You should be met with the following screen:

Start by setting up the "1. Connection" section. Tenant name is the account name you use to login to Webshipper with at webshipper.io

API-key can be created at "Settings" -> "Access and Tokens" on your Webshipper account. Press enter in one of the two fields and the csv configurations you've created in Webshipper, should now appear. If this is not the case, please check that you API-key and Tenant name is correct. 


Next step is to fill out the "2. Import Settings".
Choose an import directory, which serves as the directory from where Webshipper should load your csv files.
Backup directory is where the csv file will be moved to, after it has been handled by Webshipper.
Finish by setting the encoding of your csv files

Installing the Webshipper CSV Service in Windows

  1. Open CMD(Command prompt) with administrative privileges 
  2. Locate your .NET installation and cd to the install path of Webshipper, as stated in the example below:
    a) cd C:\(WebshipperCSVService path here)
    b) C:\Windows\Microsoft.NET\Framework64\v4.0.30319\InstallUtil Webshipper-CSV-Service.exe
  3. Start the service as you normally would.


This is everything that is needed to automatically import csv files from a local directory to Webshipper. If you need to load files from an FTP server, please continue reading.

Loading files from a FTP-server

When loading files from a FTP-server, section 1 and 2 needs to be completed. Please read above on how to do this.
Fill out Hostname, Port, Username and Password of your FTP-server. 

When loading from an FTP, the file flow is as following:

  1. Webshipper load the csv file from the "FTP Path" and move it to the chosen "Import directory" in section 2.
  2. Webshipper load the csv file from the "Import directory" and move it to the "Backup directory" if chosen.
  3. If a "Backup path" is chosen in the FTP-client section, it will also move it to this directory on the FTP-server.

Setting up the optional order file

When Webshipper is loading the orders from a csv file into your Webshipper account, an order will be made. You can use this order data, to create a new csv file.

Start by taking a look at the Order entity in our API documentation: https://docs.webshipper.io/#orders

You can use this data and the attribute names, to freely format your returned csv file.
visible_ref;delivery_address.att_contact inserted into "Order file format", should return a new file with the order number and delivery address contact, of your newly created orders.

Remember to tick the "Enable" checkbox to activate this.

Setting up the optional shipment file

The same way a new order csv file can be created, we can also create a shipment file, when a new shipment is created in Webshipper.
This service is looking at new shipments in Webshipper every 5 min and then creates a new csv file, for every shipment it finds. 

You can format this shipment file, the same way that you format the order file.
"reference;tracking_links.number" should return a file with the reference number on the shipment, as well as a list of tracking numbers. 

Remember to tick the "Enable" checkbox to activate this.

Did this answer your question?