FTP/CSV Integration Overview
Orders and Bookings can be uploaded to Shippit via a standardised CSV file upload. An FTP upload server is available to enable automation capabilities.
CSV Processing Functionality
Shippit will be required to accept the CSV file in an FTP directory. The CSV file will be processed by Shippit every 15 minutes and orders will be sent to Shippit via Shippit middleware "Shippit Connect".
After picking and packing the order, a CSV file of can be generated and sent to the FTP directory for Shippit to execute the booking process.
Orders can be created within Shippit via a structured CSV file that is processed by Shippit Connect.
Shippit Connect will first validate the file, upon which reports are generated indicating the success/failure of this validation. Orders that have successfully passed validation will be created in Shippit Connect, and subsequently synced with Shippit.
Bookings can be processed within Shippit via a structured CSV file that is processed by Shippit Connect.
Shippit Connect will first validate the file, upon which reports are generated indicating the success/failure of this validation. Booking a that have successfully passed validation will be booked in Shippit Connect, and subsequently synced with Shippit.
1. Navigate to Settings then Integrations in your Shippit account.
2. Select the CSV/ FTP option.
2. Select the most appropriate ftp setup based on how your company will be using the FTP.
(a) Option 1: This will allow you to solely upload using the Shippit Connect User Interface (this is a manual upload).
(b) Option 2: This will allow you to upload using both the Shippit Connect User Interface and an FTP service.
3. Shippit will provide the details to connect using the FTP service.
Please Note: Please take note of the password at this point. There will not be an opportunity to view this password again. You will only be able to reset the password in future.
4. Decide to turn Auto-sync on or off.
Auto-sync: This will automatically ingest files in 15 minutes increments. If this option is set to "no," you will need to fetch the files manually from the FTP service.
Please Note: By default, the FTP service will only display the Orders functionality. If you require the Bookings functionality, please reach-out to us at email@example.com for this to be turned on.
Transferring Files to the FTP Server
There are two options to transfer files into the FTP for consumption. The two options available are detailed below.
Option 1: Manually importing using the User Interface
Option 2: Using the FTP Service
1. User Interface
1.1. Select "Launch Connect" to navigate to the Shippit ftp user interface
1.2. Select "Upload Orders CSV File" on the top right of the user interface
1.3. Choose the file you would like to upload, then select "Upload Orders"
2. FTP Service
2.1. Using an ftp service of your choosing, then insert credentials provided in CSV setup page.
2.2. Ensure files are dropped into the respective "New" endpoint (folder) for the Order and Booking functionality.
New = Folder that ingests all new bookings csv files.
Response = Folder that provides output results of the bookings csv files.
New = Folder that ingests all new order csv files.
Imported = Folder that provides output successful results of order csv files.
Failed = Folder that provides output failed results of order csv files.
* Example of each file type provided at the conclusion of this support article
2.3. There is an option to manually ingest the files in the ftp service. Select the green drop down on the top right of the user interface, then select "Fetch new files via FTP"