FTP (File Transfer Protocol)
This section explains how to connect to item DI using FTP (File Transfer Protocol) for data transfer. FTP enables secure file uploads and downloads, allowing systems to exchange key data, including product information, orders, inventory updates, and shipping details.
Channel Connection via FTP
To connect to item DI via FTP:
- Navigate to Merchants > select the desired merchant > Sales Channels.
- Select Connectors under the Live Channels section.
- Click the + New Channels or the "new channel" text link. The new channels window will appear.
- Select FTP from the channels list.
- Fill out the required fields:
| Required Fields | Description |
|---|---|
| Channel Name | Enter the channel name. |
| FTP Protocol Type | Select either FTP (FTP Secure) or SFTP (SSH File Transfer Protocol) for secure data transmission. |
| FTP Host | Provide the FTP host (domain) where the files are stored. |
| FTP Port | Enter the port number used by the FTP server. |
| Login Name | Enter the login credentials for FTP access. |
| Password | Provide the password for the login credentials. |
| Download File Path | Specify the file path where data files (e.g., orders) are located for download. |
- Click Test Connection to verify the FTP setup.
- If the "Connection Successful" message appears, click Submit to finalize the connection. The FTP server will be connected.
Data Exchange via FTP
Once the FTP channel is successfully connected, data can be exchanged between item DI and the third-party platform in the form of files, such as CSV, XML, or JSON. This enables the following data transfers:
- Data Upload: The third-party platform pushes files (e.g., order or inventory updates) to the FTP server.
- Data Download: Item DI retrieves these files from the FTP server for processing.
FTP Settings
When the FTP server is connected, the system automatically downloads orders at regular intervals (every 10 minutes). You can also schedule the desired intervals by selecting from the drop-down list, which includes options for 10 minutes, 30 minutes, 1 hour, and 1 day.
Download Order
You can customize these settings to control the order syncing process:
| Setting Details | Description |
|---|---|
| Start Date | Define the date from which the system should begin syncing orders. * E.g. Setting the start date to 2024-01-01 means that it will download orders created from January 1, 2024, up to the present time. |
| Allow order cancellation | Define whether canceled sales orders should be synced (default is set to "on"). |
| The first line is the title line | Indicate whether the first line in the data file should be treated as the title or header (default is set to "off"). |
| Receiving file path | Enter the file path where item DI will receive and store the incoming order data files. |
| Processed file path | Provide the file path for item DI to store files after processing. For example, the file format needs to be converted to the correct format (Excel to JSON). |
| Error file path | Specify the file path for storing files that encountered errors during processing. |
| Succeed file path | Define the file path where successfully processed files will be stored. |