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

1. Install the extension via Composer:

   composer require viraxpress/order-number

2. 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:

1. Go to Stores > Configuration > Customize Order Number > Configuration.
2. Enable the module in the General section.
3. Configure the desired number formats in the respective sections (Order Number Format, Invoice Number Format, etc.).
4. Use placeholders like {mm}{yy}-{counter} for formats (e.g., ORD-{mm}{yy}-{counter}).
5. Set starting counters as needed.
6. 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.