Add company and product documents

The more information alby has on your products and website, the more accurate its responses to customers can be.

To give alby information to help customers, you can import supplemental documentation about your products, such as sizing guides, warranty information, and return policies.

There are two kinds of documents you can upload to alby:

  • Company documents
    • These are overarching documents that cover all products and services your company provides, and won’t often change. Company documents can include topics such as return policies, loyalty information, and financing guidelines.
  • Product documents
    • These are documents specific to each product, and may be different for different products. They include sizing guides, blog articles, assembly instructions, and ingredient lists.

There are two ways to import document data, a self-serve upload within alby.com, or via publicly available URLs via SFTP.

Self-serve upload

Specifications

Any document uploaded to alby must be smaller than 5 MB.

Documents must be in one of the following formats:

  • HTML
  • PDF
  • TXT
  • DOCX

How to upload document data

To upload your documents to alby, follow these steps:

  1. Click the Knowledge > Documents. The Documents page displays a list of previously uploaded documents.
  2. Click + Upload. You’ll be prompted to find a file on your computer to upload.
  3. Once you select and upload a file, you need to choose what kind of document it is. These options will give added context to alby on how and when to reference them to customers.
    1. Ingredients
      1. Document contains ingredients details, whether it's in list form, plain text or table
    2. Sizing guide
      1. Document contains sizing details
    3. Warranty
      1. Document is a warranty document for the product
    4. Other
      1. These will still be referenced by alby, as it sees fit for the situation
  4. Next, you can assign the document to either all products within your catalog, or specific products. For example, if your sizing guide is the same across your catalog, you can assign it to all products.

URL upload 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.

🚧

Note: 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 NameDescriptionRequired
filenameUnique name for the downloaded file.Yes
file_formatThe format of the file to be downloaded. Supported file formats include HTML, PDF, .TXT, DOCXYes
product_idsComma-separated list of Product IDs relevant to the file.Yes
external_urlFully qualified public URL (must start with https://) from which the file can be downloaded.Yes
file_typeSpecifies the type of document. Supported file types include: ingredients, sizing_guide, warranty.No

Examples of the supported file types are:

  • ingredients
    • Document contains ingredients details, whether it's in list form, plain text or table
  • sizing_guide
    • Document contains sizing details
  • warranty
    • Document is a warranty document for the product

Example CSV File

Below is an example of the required CSV format:

filenamefile_formatproduct_idsexternal_urlfile_type
A114533_ingredients.htmlHTMLA114533, A114534\https://www.example.com/ingredients/A114533_ingredients.html>ingredients

By following these guidelines, you can ensure that your documents are correctly uploaded and associated with the appropriate products on the alby platform.


Previous Articlealby Getting Started GuideNext Article
Importing your product data feed into albyCustomize alby's look and feel