Skip to main content

​
Overview

SFTP (Secure File Transfer Protocol) is an encrypted way to exchange files with Clarus WMS. Use it to upload import files (such as orders, pre-receipts, and products) and to retrieve files Clarus exports for you (such as confirmation exports). Clarus offers two SFTP account types:
  • Upload — drop files into Clarus for import.
  • Download — collect files Clarus has exported.
Your credentials for both are under FTP Users in the web app.

​
SFTP applications

You can connect with any application that supports SFTP — use whichever client you prefer. The applications below are examples that are known to connect over SFTP. This is not an exhaustive list, and listing one is not an endorsement or a guarantee that it has been tested with Clarus:
  • WinSCP
  • FileZilla
  • CyberDuck
  • FireFTP
  • ClassicFTP
  • FreeFTP by CoffeeCup

​
Connecting via SFTP

1

Get your credentials

Find your SFTP credentials under FTP Users in the web app. There are separate accounts for upload and download.
2

Create an SFTP session

Open your SFTP application and create a new session. Select SFTP as the file protocol, then enter your credentials.
3

Transfer files

To import, drag your file from your computer (left side) to the server (right side). To collect an export, drag the file from the server back to your computer. The process is similar across SFTP applications.
SFTP encrypts file transfers, making it more secure than standard FTP. Always use SFTP to protect your data.

​
Uploading import files

1

Prepare your file

Complete your spreadsheet and save it as a CSV file. Missing or incorrectly formatted data will cause the import to fail. The required fields depend on what you are importing — see the individual import guides in this section.
2

Upload it via SFTP

Connect to your upload SFTP account and transfer the file as above.
3

Check the import status

Go to System Logs in the web app. A successful upload shows a confirmation message; a failed import shows an error explaining the cause.
Always review error messages in System Logs carefully to understand and fix any import issues.

​
Retrieving exports

Files that Clarus generates for you are placed on your download SFTP account for collection. Connect to that account and transfer the file back to your computer. See Confirmation Exports for an example.
Any application that supports SFTP will work. The list above gives some examples, but you are free to use any SFTP client.
Your credentials are under FTP Users in the web app, with separate accounts for upload and download.
Import files are CSV. The exact columns depend on the file type — see the relevant import guide.
Check the error message in System Logs. The cause is usually incorrect formatting or missing information in your file.