Skip to main content
All Collectionsalby
Add company and product documents to alby
Add company and product documents to alby
Updated this week

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.

Specifications

  • Location

    • Use the filepath /alby/documents_mapping. If it does not exist please create the folder with the exact naming. You must put the CSV file in this folder in order for document import to activate.

  • 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:

  1. filename

    • Unique name for the downloaded file.

  2. file_format

    • The format of the file to be downloaded. Supported file formats include

      1. HTML

      2. PDF

      3. TXT

      4. DOCX

  3. product_ids

    • Comma-separated list of Product IDs relevant to the file.

  4. external_url

    • Fully qualified public URL (must start with https://) from which the file can be downloaded.

  5. file_type (Optional)

    • Specifies the type of document. Supported file types include:

      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

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

ingredients

If you need assistance uploading documents, contact support@alby.com.

Did this answer your question?