Table of Contents
- Connecting via SFTP
- File Formats
- Price List
Updated by Kyle Tymoszewicz
- Connecting via SFTP
- File Formats
- Price List
If you are not using a platform which directly integrates with Convictional, data can still be shared through our SFTP server. This enables users to share data with Convictional by securely transferring files to us using an SFTP client. After onboarding, we will automatically process transferred files and load the data into our platform.
We are actively building out our SFTP capabilities. If you have any questions or feature requests, please reach out to us at firstname.lastname@example.org.
Connecting via SFTP
Provided below is the information needed to establish a SFTP connection:
- Host: sftp.convictional.com
- Port: 2122
- Directory: /
- Credentials (Username + Password): available in our platform as part of the onboarding process
If you've forgotten your Username, you can view it from the settings->integrations tab.
If you've forgotten your Password, you can update it from the settings->integrations tab.
We currently support processing CSV files. We currently support comma (,), bar (|) or tabs (/t) as delimiter/separator. If your file uses different delimiter/separator, please contact email@example.com for its inclusion.
We require that all column headers be non empty. We also require that all row entries be in a specified column header.
When importing data through CSV we need to build an understanding of how your information can be represented in our system. We use the concept of CSV Mappings to enable this.
What are CSV Mappings?
CSV Mappings match one-to-one each of your product details with our Convictional product fields. You can find the list of product fields we support here. When syncing product details from your uploaded files, we will make use of CSV Mappings to accurately create your products in our system.
You will only need to create CSV Mappings one time, every uploaded product file will make use of these mappings.
How do I create CSV Mappings?
CSV Mappings are completable within our platform as part of the onboarding process. You can find the CSV Mappings creation tool on the products page. Start by clicking on "Create CSV Mappings". Below is a full walkthrough.
Step One: Upload your product file to the SFTP server
To begin setting up your CSV Mappings, you'll first need to have your product file uploaded to our SFTP server.
You can use our product template linked here to facilitate mappings between your CSV headers and our Convictional product fields.
This products CSV must also be uploaded to the SFTP server.
Note: If you do not include inventory levels in your Products CSV (recommended), you will need to upload a separate file including both inventory levels and Product SKUs.
Step Two: Select your product file
In the CSV Mappings creation tool on the products page, you'll first be prompted to select the appropriate product file from which the mappings will be based off of. We also ask that you specify the delimiter/separator used in your product file. This is most commonly a comma (,) for CSV files.
Step Three: Setup CSV Mappings
Upon submitting your product file and delimiter/separator, we will pull column headers and sample row data from the specified file. With this, you can begin mapping.
In each row, we provide our Convictional fields along with their corresponding descriptions. Through a dropdown selection, choose the appropriate column name from your product file that matches the Convictional field. Upon selection, we provide a preview of some of the values in that column from your file. Please match all fields that are applicable to your products. Note that it is possible to map multiple Convictional Fields to a column header multiple times. For example, if your products don't have product codes, you can set both Product Code -> Sku and Sku -> Sku.
Step Four: Convictional review
Upon submission, our support team will be notified to review your mappings. We currently only enable product syncing once mappings have been approved. We do so to help catch any potential mappings that could be problematic before syncing your catalogue into our system. Please give 2-3 business days for us to review. We will notify you when your products have synced.
Updating Product Details
For product updates, please upload your updated product file to our SFTP server. We require that the product file name is the same as the one chosen during the CSV Mappings process. This enables our system to easily identify which file to sync information from. Our product updates run periodically, your updates should be live within an hour.
Updating CSV Mappings
If your product file needs changes such as addition/removal of columns that were used in your CSV Mappings, please contact firstname.lastname@example.org to update your CSV Mappings.
Once the SFTP feed and products have been created, a price list must be created. See How to Set Up Pricing.
The final step is to assign the price list to your buyer. See Adding Partners.