Help Center

Setting Up FTP Flights

Shawn Dillon
Shawn Dillon
  • Updated

1. Onboarding Setup for FTP Flights

To configure FTP Flights for a client, use the following client fields to store authentication details:

  • Username → Stored in ApiField
  • Password → Stored in ApiKey
  • FTP Server → Stored in ApiUrl

Ensure the credentials are accurate to enable proper data retrieval.

 


2. Flight Types and Naming Conventions

FTP flights retrieve SKU upload files for processing. There are two types of FTP Flights:

 


A. Generic FTP Flight (FtpAutoLoadFlight)

This flight processes general FTP uploads. Ensure the uploaded files follow this naming convention:

Format:
<ClientCode>_YYYYMMDD.[zip|gz|txt]

Example:
XX123_20181222.gz

Key Points:

  • The Client Code, Year, Month, and Day are extracted from the filename.
  • Files can be compressed (.zip, .gz) or uncompressed (.txt).
  • Overwrite is set to false, meaning new uploads will not overwrite existing data.

B. Teamwork Retail FTP Flight

This flight is customized for Teamwork Retail and differs slightly in how it interprets filenames.

Format:
Management One_<YYYY>_<MM>_<DD>_<HHMMSS>.txt.[zip|gz|txt]

Example:
Management One_2018_12_26_210229.txt

Key Points:

  • This naming structure includes a timestamp (HHMMSS) for accurate identification.
  • The Year, Month, Day, and Client are parsed from the filename.
  • Compressed (.zip, .gz) and uncompressed (.txt) files are supported.

3. Additional Notes

  • Ensure correct naming conventions are followed to prevent processing errors.
  • Overwrite is disabled—previous data remains unchanged when new files arrive.
  • For troubleshooting, verify the stored credentials and naming consistency.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.