This guide is for the CSV importer tool that has been downloaded and installed before the 24th of September 2020.
*Requires a Windows installation! Not available for MAC or LINUX.
1. Setting up the CSV configuration
To get started with the CSV importer tool the first thing that is required is that you set up a CSV configuration inside Webshipper. See how here
2. Installing the CSV importer tool
2.1 This version is no longer available to download. Please click here to see the new guide instead.
2.2 Extract the zip file in any folder and open up the file Webshipper-CSV-Settings.exe
You should be met with the following screen:
3. Filling in the details
The tool contains 5 sections. However, all you need to focus on primarily is section 1. Connection and section 2. Import settings.
Start by setting up the 1. Connection section.
- Tenant name is the account name you use to log into Webshipper at tenantname.webshipper.io
- The API key can be created in your Webshipper account. Go to Settings - Access and Tokens and add a new key with full access.
- Press enter in one of the two fields and the CSV configuration you've created in Webshipper, should now appear in the third field. If this is not the case, please check that your API key and Tenant name is correct.
The 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.
- The 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.
4. Installing the CSV service
- Open CMD(Command prompt) with administrative privileges in the start menu.
- Locate your .NET installation and cd to the install path of Webshipper, as stated in the example below:
a) cd C:\(WebshipperCSVService path here) + press enter
b) C:\Windows\Microsoft.NET\Framework64\v4.0.30319\InstallUtil Webshipper-CSV-Service.exe + click enter.
- Start the service as you normally would.
Congratulations you are all done and the importer tool is now installed.
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.
5. Loading files from an FTP-server
When loading files from an FTP-server, sections 1 and 2 need to be completed. Please read point 3 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 follows:
- Webshipper load the CSV file from the "FTP Path" and move it to the chosen "Import directory" in section 2.
- Webshipper load the CSV file from the "Import directory" and move it to the "Backup directory" if chosen.
- If a "Backup path" is chosen in the FTP-client section, it will also move it to this directory on the FTP server.
6. 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.
7. Setting up the optional shipment file
In the same way that a new order CSV file can be created, you 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.