Add company and product documents via SFTP
You can upload a CSV file to map any products to documents found on publicly available URLs. Once the CSV is ingested, alby will scrape the data from it, adding it to its available information to provide to customers.
Be sure you have added alby’s IP addresses to your allow list, or alby may not be able to pull the information from your URLs.
This method allows for bulk uploads, ensuring your documentation is efficiently associated with the relevant products. The documents specified in the URLs will be automatically downloaded and linked to the corresponding products on the alby platform.
Example Filename
Brand_Documents_YYYYMMDD_HHMMSS.csv
Although the filename can be flexible, alby recommends starting it with the brand name and ending it with the export date. Any CSV file format is acceptable. Only alphanumeric characters and underscores are allowed; please avoid using special characters such as colons, spaces, etc. The name of the file must be alphanumeric with _ or - and must not contain spaces or special characters.
Prerequisites
Make sure you have setup a SFTP connection with alby. See setting up SFTP access.
After your connection with SFTP is successful, make sure you see a folder called documents_mapping, if it does not exist, create the folder with the exact naming. You must put the CSV file in this folder in order for document import to activate.
Specifications
- Format
- Files must be in a flat file CSV format. Excel XLSX files are not supported.
- Encoding
- All files must be UTF-8 compliant.
- Header Row
- Files must contain a header row that defines the columns.
CSV Format
The required CSV format for importing documentation consists of five columns, listed in the following order:
| Column Name | Description | Required |
|---|---|---|
| filename | Unique name for the downloaded file. | Yes |
| file_format | The format of the file to be downloaded. Supported file formats include HTML, PDF, .TXT, DOCX | Yes |
| product_ids | Comma-separated list of Product IDs relevant to the file. | Yes |
| external_url | Fully qualified public URL (must start with https://) from which the file can be downloaded. | Yes |
| file_type | Specifies the type of document. Supported file types include: care,ingredients, instructions, product_snapshot, return_policy,sizing_guide, transcript, warranty. | No |
Examples of the supported file types are:
| File type | Example |
|---|---|
| care | How to best take care of the product(s) |
| ingredients | Document contains ingredients details, whether it's in list form, plain text or table |
| instructions | Step-by-step guidance on how to use the product effectively |
| product_snapshot | Brief overview including key features, benefits, and specifications |
| return_policy | Details about return eligibility, timeframe, and process |
| sizing_guide | Dimensions, measurements, or size chart information |
| transcript | Text version of any audio or video content related to the product |
| warranty | Coverage details, duration, and claim process information |
Example CSV File
Below is an example of the required CSV format:
| filename | file_format | product_ids | external_url | file_type |
|---|---|---|---|---|
| A114533_ingredients.html | HTML | A114533, A114534 | https://www.example.com/ingredients/A114533_ingredients.html | ingredients |
| Previous Article | alby Getting Started Guide | Next Article |
|---|---|---|
| Importing your product data feed into alby | Customize alby's look and feel |
Updated 2 days ago