SFTP Integration Guide

Connect your sales channel or warehouse system with Helm using Secure File Transfer Protocol (SFTP) to automate order and stock file transfers securely

What is SFTP

SFTP is a secure method of transferring files over the internet that encrypts data during transmission to protect sensitive information

Using SFTP with Helm allows automatic importing and exporting of order and stock files without manual uploads, improving efficiency and accuracy

PROS ✅

CONS ❌

Secure, encrypted file transfers

Requires SFTP server setup and access credentials

Automates file exchange to reduce manual handling

Initial setup may require IT support or technical skills

Supports large file sizes and scheduled transfers

File format and naming conventions must be strictly followed

Step-by-Step Setup

To set up SFTP integration with Helm

  1. Set Up SFTP Server
    Use your own server or a third-party SFTP provider
    Ensure you have the hostname, port, username, and password or SSH key for access

  2. Configure Access in Helm
    Log in to Helm and navigate to Settings → My Store

  3. Add New Sales Channel
    Click Add New Sales Channel and select SFTP from the options

  4. Enter Required Details

FIELD

DESCRIPTION

Sales Channel Name

e.g., SFTP Warehouse Feed

Sales Channel Logo

Upload an icon or logo to represent the channel

SFTP Hostname

The server address for your SFTP connection

Port

The port number (default is usually 22)

Username

The username for SFTP login

Password or SSH Key

The password or private key for authentication

Remote Directory

The folder path on the SFTP server to upload/download files

  1. Set File Transfer Settings
    Define file naming conventions, file types (CSV, XML), and transfer schedules (e.g., daily at 2am)

  2. Test Connection
    Verify Helm can successfully connect to your SFTP server and transfer files

Interaction Settings

Configure how Helm handles files transferred via SFTP

INTERACTION SETTINGS

DESCRIPTION

Upload Directory

Location where Helm uploads outbound files

Download Directory

Location where Helm reads inbound files

File Naming Pattern

Required naming convention for files

Transfer Frequency

How often files are transferred (hourly, daily)

File Format

Accepted file formats (CSV, XML, etc.)

Final Steps

  • Click Save once all settings are configured

  • Set the channel to Is Active at the top of the screen

Once configured, Helm will securely exchange order and stock files via SFTP automatically

Common Issues

ISSUE

SOLUTION

Connection Failures

Verify hostname, port, username, and password/key are correct

Permission Denied

Check SFTP user has read/write access to directories

File Not Found

Confirm files exist in the specified remote directory

Incorrect File Format

Ensure files follow the required naming and format conventions

If you experience issues and need assistance, contact Helm Support