CSV Format Specification

This add-on uses one CSV format for both export and import.

File Requirements

  • Encoding: UTF-8 (with or without BOM)
  • Line endings: LF or CRLF
  • Delimiter: comma (default)
  • Enclosure: double quote

Example CSV

"name","description","password","path","is_public","max_downloads","customer_group_ids","customer_ids","created_at","category_id","show_in_sidebar","valid_from","valid_to","send_email","tags","product_links" "Document Name","Description","mysecret123","var/import/customerdocuments/test_1.pdf","1","0","General,Wholesale","roni_cost@example.com,mycustomer2@gmail.com","","General","0","2025-01-01","2025-12-31","0","important,contract","WSH12-29-Red@default@10|24-MB01@default@20"

Column Notes

  • id: optional; needed to update an existing document without changing the file
  • name, description: required
  • path:
    • required for new documents
    • points to a real file on disk (relative to Magento root)
    • importer copies the file into pub/media//
  • customer_ids: comma-separated customer emails
  • customer_group_ids: comma-separated customer group codes
  • category_id: category name
  • send_email: 1 queues email notifications after import
  • tags: comma-separated tags
  • product_links: optional document-to-product links in format sku@store_code@position|sku2@store_code@position

Found an issue with this documentation? Let us know