actualizer / quote-document
Actualize: Quote Document - Adds quote document type with number range
Package info
github.com/actualizer/ActQuoteDocument
Type:shopware-platform-plugin
pkg:composer/actualizer/quote-document
Requires
- php: >=8.3
- shopware/core: >=6.7 <6.8
README
This plugin adds a new document type "Quote" (German: "Angebot") to your Shopware 6 installation, complete with its own number range and customizable validity period.
Features
- New Document Type: Adds "Quote" as a fully integrated document type
- Dedicated Number Range: Separate number sequence for quotes (starting at 1000)
- Configurable Validity: Set quote validity period via plugin configuration
- Multi-language Support: Full support for German and English
- Customizable Text: All texts manageable via Shopware's text module system
- Professional Templates: Based on Shopware's standard document templates
- Safe Installation/Uninstallation: No data loss, existing documents are protected
Requirements
- Shopware >=6.7 <6.8
- PHP 8.3 or higher
Installation
Via Composer (recommended)
composer require actualizer/quote-document bin/console plugin:refresh bin/console plugin:install --activate ActQuoteDocument bin/console cache:clear
Manual Installation
- Copy the plugin folder to
custom/plugins/ActQuoteDocument - Run the following commands from your Shopware root directory:
bin/console plugin:refresh bin/console plugin:install --activate ActQuoteDocument bin/console cache:clear
Installation via Git (for development)
cd custom/plugins git clone [repository-url] ActQuoteDocument cd ../.. bin/console plugin:refresh bin/console plugin:install --activate ActQuoteDocument bin/console cache:clear
Configuration
Plugin Settings
Navigate to Extensions → My Extensions → ActQuoteDocument in your admin panel:
- Quote validity in days: Set how many days a quote should be valid (default: 30 days)
Number Range
The plugin automatically creates a number range for quotes:
- Navigate to Settings → Shop → Number ranges
- Look for "Quotes" / "Angebote"
- Default pattern: Sequential numbering starting at 1000
- Can be customized per sales channel
Text Customization
All texts can be customized via Shopware's text module system:
- Navigate to Settings → Shop → Text modules
- Search for keys starting with
act_quote_ - Available text keys:
act_quote_title: Document titleact_quote_headline: Document headlineact_quote_validUntil: Validity text
Usage
Creating a Quote
- Navigate to Orders → Orders
- Select an order
- Click on "Documents" tab
- Click "Create document"
- Select "Quote" as document type
- Generate the document
Customizing the Template
The quote template can be customized by overriding it in your theme:
themes/YourTheme/views/documents/quote.html.twig
The template extends Shopware's base document template and inherits all standard features like:
- Company information
- Customer addresses
- Line items with prices
- Tax calculations
- Payment and shipping information
Technical Details
Database Tables Affected
The plugin creates entries in the following tables:
document_type: Quote document typedocument_type_translation: Translations for the document typenumber_range_type: Number range type for quotesnumber_range_type_translation: Translationsnumber_range: The actual number range configurationnumber_range_translation: Translationsdocument_base_config: Document configurationdocument_base_config_sales_channel: Sales channel assignmentsnumber_range_sales_channel: Number range sales channel assignments
Safety Features
- Installation Safety: Checks if quote document type already exists before creating
- Uninstallation Safety:
- Keeps data by default when uninstalling
- Checks for existing quote documents before removing configuration
- Never deletes actual quote documents
- Unique Identifiers: Uses
act_quote_prefix for all text keys to avoid conflicts
Development
Extending the Plugin
The plugin follows Shopware 6 best practices and can be extended:
- Custom Fields: Add custom fields to the quote document
- Event Subscribers: Hook into the document generation process
- Template Extensions: Override blocks in the quote template
- Additional Configuration: Add more configuration options
Troubleshooting
Quote documents not showing
- Clear the cache:
bin/console cache:clear - Check if the plugin is activated
- Verify number range assignment in admin
Wrong language displayed
Ensure your admin user has the correct language selected and that the locale is properly configured in Shopware.
Custom styling not applied
When modifying templates, remember to:
- Clear the cache
- Compile the theme if using custom CSS
Support
For issues and feature requests, please use the GitHub issue tracker.
License
This plugin is licensed under the MIT License - see the LICENSE file for details.
Credits
Developed by Actualize
Made with ❤️ for the Shopware Community