SFTP Set-Up

Configure the SFTP connection that YBM Connect uses to retrieve catalog data and prices and to deliver customer orders to your system.

Use your own SFTP server with YBM Connect. The same server connection can be used in two directions:

  1. YourBarMate fetches your product catalog and, if configured, price files.
  2. YourBarMate uploads generated customer orders to your server.

If your firewall requires an allow-list, request the current connection details during onboarding. The connection settings use a hostname, port, username and password. If you require another authentication method, agree it with the YourBarMate team before setup.

Set-up flow

  1. Request a YBM Connect account from the YourBarMate team.
  2. Sign in and open Settings → Integration.
  3. Enter your SFTP hostname, port, username and password.
  4. Configure the catalog, pricing and order paths, formats and encoding.
  5. Test the first exchange and review the resulting catalog or prices.
  6. Activate the automated exchange once the setup is correct.

Configure the server connection

In the integration settings, enter the hostname, port, username and password for your SFTP server.

The same area contains separate settings for the product catalog import, pricing import and order export. Use v5 for new catalog integrations. Existing v3 or v4 integrations keep their configured format. Define the relevant file paths and CSV options, then agree the import schedule and final activation with the YourBarMate team.

Before setup, have the following information ready:

  • SFTP hostname and port
  • SFTP username and password
  • the remote path for the product catalog file
  • the remote path for the complete pricing file, if pricing is exchanged
  • the destination path and file name pattern for customer orders

Use a separate SFTP user with only the permissions required for the configured directories. Keep the credentials private and do not include them in CSV files or support messages.

Fetching the product catalog from your server

The v5 product catalog CSV file can be fetched from your server. Existing integrations using v3 or v4 keep their configured format. We configure the source path and import profile for your account.

Please provide these details:

  • hostname: The SFTP host
  • port: The SFTP port
  • username: The username
  • password: The password, if required
  • remote_file: The path to the product catalog CSV file
  • encoding: Either utf-8 or latin1 (ISO 8859-1)

The default CSV delimiter is a comma. If your file uses another delimiter, configure that option explicitly in the integration settings and use the same delimiter consistently throughout the file.

Automated catalog imports are complete snapshots. Products missing from the source file are marked deleted.

Make sure the file is complete before the scheduled import runs. Do not replace the file while it is being read; first write the complete file to a temporary name and then move it to the configured path if your SFTP workflow supports that method.

Fetching customer prices from your server

Provide one complete CSV file containing all price groups for the account.

In addition to the above settings, please provide the following details:

  • Pricing file path: The path to the complete product prices CSV file

Automated price imports are complete snapshots. Prices missing from the configured source file are removed. Do not split price groups across several files unless this has been explicitly agreed and configured with the YourBarMate team.

Receiving orders on your server

We can place the order CSV file on your server via SFTP.

Please provide these details:

  • hostname: The SFTP host
  • port: The SFTP port
  • username: The username
  • password: The password, if required
  • remote_file: The path to the order CSV file to create
  • encoding: Either utf-8 or latin1 (ISO 8859-1)

The standard export is the CSV Order Format. The remote file name must end in .csv.

The remote_file may contain these placeholders:

  • ${type}: Will be replaced with the order type, "delivery" or "return"
  • ${id}: Will be replaced with the order ID
  • ${date}: The date when the order was created in the format YYYY-MM-DD
  • ${time}: The time when the order was created in the format HHmmss