This is an old revision of the document!
Table of Contents
Magento 2 Product Attachment User Guide
Extension Overview
The Magento 2 Product Attachment extension gives store administrators a simple way to add documents and other files to products.
These files can be used for product manuals, specifications, installation instructions, warranty information, brochures, or any other information that customers may need.
Attachments can be uploaded to Magento or added as an external link. Once an attachment is created, it can be assigned to products or categories and made available to selected customer groups.
The extension also provides options for showing attachments on the product page, category page, customer order view, and transactional emails.
Installation
Please refer to the installation guide in the following article:
Admin Configuration
After the extension has been installed, its settings can be found in the Magento Admin under:
Stores → Configuration → Towering Media → Product Attachments
The configuration is divided into several sections.
General
The General section contains the main settings for the extension.
| Setting | Description |
|---|---|
| Enable Module | Turn the extension on or off for the selected store view. |
| Add Category Files to Products | When enabled, files assigned to a category can also be made available on products in that category. |
| Display Include In Order Files on Product Pages | Controls whether files marked as Include In Order should also be shown on the product page. |
| Download URL Type | Controls the type of URL generated for attachment downloads. The example configuration uses Opaque Hash. |
Note: Settings marked as [store view] can be configured separately for different store views.
Product Tab
These settings control the Product Attachments section on the product page.
| Setting | Description |
|---|---|
| Show Product Attachments Tab | Shows or hides the attachment tab on the product page. |
| Tab Title | Sets the title displayed to customers. For example, Product Attachments or Downloads. |
| Tab Position | Sets the position of the attachment tab. The extension recommends avoiding multiples of 10. |
| Show File Icon | Shows the file icon next to an attachment. |
| Show File Size | Shows the file size next to the attachment. |
For example, the tab title can be changed from Product Attachments to Downloads if that better fits the store.
Category Page
Use these options if you want to show files that belong to a category.
| Setting | Description |
|---|---|
| Show Category Attachments in Sidebar | Shows or hides the category attachment block in the sidebar. |
| Block Title | Sets the heading shown above the attachment list. |
| Show File Icon | Shows the file icon. |
| Show File Size | Shows the file size. |
This is useful when the same document applies to a complete category rather than one specific product.
Order View Page
This section controls attachments that customers can see from their order details.
| Setting | Description |
|---|---|
| Show Attachments | Turns the attachment section on or off in the order view. |
| Block Title | Sets the title of the attachment section. |
| Type of Attachments to Display | Controls which attachments are shown. The example uses Include in order only. |
| Order Statuses | Optional. Enter status codes separated by commas, such as `pending,processing,complete`. Leave it empty to show attachments for all order statuses. |
This gives the administrator control over when attachments should be available from an order.
Order Email
If product attachments need to be included in transactional emails, configure the settings in this section.
| Setting | Description |
|---|---|
| Add Attachments to Transactional Emails | Turns email attachments on or off. |
| Block Title | Sets the title used for the attachment section in the email. |
| Type of Attachments to Display | Controls which attachments are included in the email. |
Download
The Autodetect File MIME Type on Download option controls how Magento determines the file type when an attachment is downloaded.
When this option is set to Yes, the extension detects the file's MIME type during the download. Downloads use `Content-Disposition: attachment`.
Link Health
The Link Health settings are useful when attachments use external URLs.
The extension can check external links daily and send an email when a broken link is found.
| Setting | Description |
|---|---|
| Enable Daily Link Health Check | Enables or disables the daily link check. |
| Notification Emails | Email addresses that should receive notifications when broken links are found. Multiple addresses can be separated with commas. |
Example:
admin@example.com, support@example.com
Managing Product Attachments
The Product Attachments grid is used to manage existing attachments.
Open:
Towering Media → Product Attachments
The grid contains information such as:
- ID
- File Label
- Attachment Type
- Link Status
- Visible
- Action
- Icon
- File Name
- MIME Type
- File Size
- Created At
- Updated At
- Customer Groups
To create a new attachment, click Add New Attachment.
The grid also provides Import and Export options for working with attachment data.
Adding an Attachment
Click Add New Attachment to create a new attachment.
The attachment form contains the information needed to upload the file, control who can see it, and decide where it should be used.
Attachment Type
Select the attachment type.
For an uploaded document, select File.
File
Click Upload and select the file you want to use.
When editing an existing attachment, the uploaded file can also be removed.
Attachment Name
Enter a name that makes the attachment easy to identify in the Admin.
Example:
Sample Product Manual
Label
The label is the name customers will see on the storefront.
Example:
Product Manual
The attachment name and label do not have to be the same.
Customer Groups
Select the customer groups that should have access to the attachment.
The available customer groups may include:
- NOT LOGGED IN
- General
- Wholesale
- Retailer
If no customer group is selected, the attachment is available to all customer groups.
Is Visible
Set Is Visible to Yes when the attachment should be available on the storefront.
Set it to No if you want to keep the attachment in the Admin but temporarily hide it from customers.
Include In Order
Set Include In Order to Yes when the attachment should also be available with the customer's order.
Depending on the configuration, these attachments can also be shown in the customer's order view and included in transactional emails.
Assigning the Attachment
After adding the file, use the Attach To section to decide where the attachment should be available.
Categories
Select one or more categories.
For example, a document that applies to all bags can be assigned to the Bags category.
If Add Category Files to Products is enabled, category attachments can also be made available on the products in that category.
Products
Click Add products and select the products that should use the attachment.
The product selection list includes information such as:
- Product ID
- Thumbnail
- Product Name
- Status
- Product Type
- SKU
- Price
If a product is already assigned and you want to remove it, use the Remove action.
Once the attachment and product assignments are complete, click Save Attachment.
User Experience
Once an attachment is enabled and assigned to a product, customers can access it from the storefront.
Product Page
The attachment section is displayed on the product page according to the extension configuration.
In the example below, the Product Attachments section appears below the main product information.
The customer can see the attachment label and, when file size display is enabled, the size of the file.
For example, the Joust Duffle Bag product displays:
Product Attachments Product Manual (4.5 KB)
The customer can click Product Manual to access the document.
The exact location and appearance of the attachment section may vary depending on the Magento theme and configuration.
Troubleshooting
Most attachment issues are related to visibility, product assignment, customer groups, configuration, or Magento cache.
Attachment is not showing on the product page
Check the following:
- Make sure Is Visible is set to Yes.
- Make sure the attachment is assigned to the correct product.
- Check that Show Product Attachments Tab is set to Yes.
- If it is a category attachment, check the category assignment.
- If required, check Add Category Files to Products.
- Clear the Magento cache and test the product page again.
Customer cannot see the attachment
Check the Customer Groups selected for the attachment.
Also check:
- The attachment is visible.
- The customer is using the expected store view.
- The attachment is assigned to the correct product or category.
Attachment cannot be downloaded
Check that:
- The uploaded file still exists.
- The attachment is configured correctly.
- The Download URL Type setting is correct.
- There are no download-related errors in the Magento or web server logs.
If the problem occurs only with a particular file type, also check the server's MIME type configuration.
External link is not working
If the attachment uses an external URL:
- Open the URL directly in a browser.
- Check the URL for typing or formatting errors.
- If Link Health is enabled, check for broken-link notifications.
- Update the attachment if the external file has been moved.
Attachment is missing from the customer order
Check the following:
- Set Include In Order to Yes.
- Check Show Attachments under Order View Page.
- Check Type of Attachments to Display.
- If Order Statuses are configured, make sure the current order status is included.
Attachment is not included in the order email
Check:
- Add Attachments to Transactional Emails is set to Yes.
- The attachment is marked Include In Order.
- The Type of Attachments to Display setting under Order Email is correct.
- Place a test order and check the resulting email.
Category attachment is not showing
Check:
- The attachment is assigned to the correct category.
- Show Category Attachments in Sidebar is set to Yes.
- The category attachment settings are correct.
- If the file should also appear on products, check Add Category Files to Products.
Changes are not visible
After changing the configuration:
- Click Save Config.
- Clear the Magento cache.
- If required, refresh static content according to the store's deployment process.
- Test the page again using a private/incognito browser window.
Link Health notifications are not being sent
Check:
- Enable Daily Link Health Check is set to Yes.
- Valid addresses have been entered in Notification Emails.
- Multiple email addresses are separated with commas.
- Magento cron is running correctly.
Before Contacting Support
If the issue continues, provide the following information when contacting support:
- Magento version and PHP version.
- The affected product or attachment.
- The store view where the issue occurs.
- Steps used to reproduce the problem.
- Relevant Magento or web server log messages.
- Screenshots of the Admin configuration and storefront issue.
This information will make it easier to identify the problem and reproduce it.






