viraxpress / order-number
ViraXpress Order Number Module for Magento 2
Package info
github.com/viraxpress/OrderNumber
Type:magento2-module
pkg:composer/viraxpress/order-number
Requires
- php: ~8.1.0||~8.2.0||~8.3.0||~8.4.0
README
Description
The ViraXpress Order Number Module allows Magento 2 store owners to customize the numbering formats for orders, invoices, shipments, and credit memos. This extension provides flexible configuration options to create unique, branded numbering schemes that can include date elements, store identifiers, incremental counters, and random numbers.
Features
- Custom Order Number Formats: Define custom formats for order numbers using placeholders such as date components ({d}, {dd}, {m}, {mm}, {yy}, {yyyy}), store ID ({storeId}), incremental counter ({counter}), and random numbers ({rndNumbers**}).
- Invoice Number Customization: Configure invoice numbers independently or use the same format as orders with optional text replacement.
- Shipment Number Customization: Set custom formats for shipment numbers, similar to invoices.
- Credit Memo Number Customization: Customize credit memo numbering with the same flexible options.
- Incremental Counters: Set starting counters for each number type to maintain sequential numbering.
- Store-Specific Configuration: Configure numbering per store view if needed.
- Admin Configuration: Easy-to-use admin panel for enabling/disabling features and setting formats.
Compatibility
- Magento 2.4.x
Installation
-
Install the extension via Composer:
composer require viraxpress/order-number
-
Run the following commands from your Magento root directory:
php bin/magento module:enable ViraXpress_OrderNumber php bin/magento setup:upgrade php bin/magento setup:di:compile php bin/magento setup:static-content:deploy -f php bin/magento cache:flush
Configuration
After installation, configure the module in the Magento Admin Panel:
- Go to Stores > Configuration > Customize Order Number > Configuration.
- Enable the module in the General section.
- Configure the desired number formats in the respective sections (Order Number Format, Invoice Number Format, etc.).
- Use placeholders like
{mm}{yy}-{counter}for formats (e.g.,ORD-{mm}{yy}-{counter}). - Set starting counters as needed.
- Save the configuration.
Usage
Once configured, the custom numbering will automatically apply to new orders, invoices, shipments, and credit memos. Existing records will retain their original numbers.
Support
For support, please contact ViraXpress at https://www.viraxpress.com or refer to the license agreement.
License
This extension is licensed under the ViraXpress license agreement. See https://www.viraxpress.com/license for details.