FTP (File Transfer Protocol) is a communications protocol for file sharing. It allows files to be copied to another computer on the network, or files to be modified on that computer.
In Shippingbo, this allows you to import orders, products or update stock in our solution from a predefined CSV file.
In the case of an order import, this allows you to import orders that would not be in our solution with a direct connection to the order source.
If you don't use any software to manage your FTP, we can suggest using FileZilla. If you wish, you can download it from your browser.
CAREFUL To configure your FTP for the first time in your Shippingbo account, please contact support so that they can take the necessary steps. |
Log in into your FTP
If it is a Shippingbo FTP:
The information required to connect an FTP will be sent to you by support.
This information is as follows:
- host: your FTP host
- user: your login
- password: your password
CAREFUL After 5 failed connection attempts in 10 minutes, your IP will be banned for 1 hour and all new connection attempts will result in failure (even with the correct identifiers). |
If it is an external FTP :
You will need to give us your connection details so that we can configure it:
- host: your FTP host
- user: your login
- password: your password
Options available for uploading orders to FTP
Once the FTP has been activated, you can go to Configurations→External services→ +GenericSftp CsvBased to view the options available for your FTP:
- all the fields "..._directory:" fields are fields corresponding to the folder from which we retrieve information or to which we push information. For example: "orders" to retrieve orders and "shipments" to return shipping information.
- "col_sep:" this is the designated column separator, to be applied in the csv files to be imported. This can be a comma or a semicolon.
- "datetime_fmt:" this is the date format, which must always be "%d/%m/%Y".
- "push_only_on_create:" this option allows information to be pushed only when the order is created, particularly if the order reference already exists and you don't want changes to be possible if the same reference is brought up again in the FTP.
Creating a CSV file to import
CAREFUL It is very important to respect the format of the file in order to guarantee the success of the import later on. The following rules are particularly important:
|
At the end of the page, you will find a file detailing the different columns that can be filled in, together with instructions on how to upload them.
Importing orders :
Here is an example of a file to be imported into "orders":
Here is an example of a file returned in "shipments":
Product imports :
Stock imports :
Uploading a file to your FTP
Enter your FTP access details, then click on the "Connect" button:
Place your files in the 'orders' folder by double-clicking on it, then right-click on the file you wish to import on the left (1) and select 'send'.
NOTE
You can also drag the file from the left to the right.
We will send any information feedback in the "shipments" folder.
Optional: configuring an SFTP for exporting data
This tutorial covers the configuration of an FTP server for importing data into Shippingbo.
You may potentially want to automate the export of data from Shippingbo on an SFTP.
To do this, please consult our tutorial on configuring an FTP/SFTP server for automatic data export.