README

The Order API & Scheduled Export module by ManiyaTech allows merchants to access and export order data efficiently using configurable filters. You can retrieve orders via REST API based on a minimum grand total and a selected date range. In addition, a cron job can be scheduled to automatically export orders to Excel format and store them in the var/exportorder/ directory. The module keeps only the latest 5 export files, ensuring disk space optimization.

This is especially useful for admins who need regular exports for reporting, analysis, or integration with third-party systems.

Key Features

✅ REST API Support: Fetch filtered order list using custom API endpoint.
🔧 Configurable Filters: Set minimum grand total and number of past days for export.
📅 Scheduled Export via Cron: Automatically generate Excel files on a defined schedule.
📂 Auto Cleanup: Keeps only the 5 most recent export files; older files are automatically deleted.
📈 Formatted Excel Output: Generates well-structured spreadsheets with all key order fields.
🛡️ Magento Standards Compliant: Follows Magento 2.4.X and PHP 8.4 best practices with PSR & PHPCS compatibility.
⚙️ Admin Configurable: Enable/disable module, define export filters, and cron frequency from the backend.
🕒 Timezone Aware: Date range filters work according to store timezone settings.
📩 Automated Email Delivery: Sends the order report automatically via a scheduled cron job — no manual intervention required.
📎 Order Report Attachment: Attaches the latest order report (Excel) directly to the email.
⚙️ Magento Email Template Integration: Fully supports dynamic email templates with variables like subject and receiver name.
🧩 Customizable Configuration: Easily configurable via Magento admin (subject line, recipients, etc.).
🛡️ Secure File Handling: Uses Magento’s filesystem and mail transport classes for secure and reliable file delivery.
🔄 Supports Magento 2.4.8: Fully tested and compatible with Magento 2.4.8.

How to install ManiyaTech_OrderApi module

Composer Installation

Run the following command in Magento 2 root directory to install ManiyaTech_OrderApi module via composer.

Install

composer require maniyatech/magento2-orderapi
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy -f

Update

composer update maniyatech/magento2-orderapi
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy -f

Run below command if your store is in the production mode:

php bin/magento setup:di:compile

Manual Installation

If you prefer to install this module manually, kindly follow the steps described below -

Download the latest version here
Create a folder path like this app/code/ManiyaTech/OrderApi and extract the main.zip file into it.
Navigate to Magento root directory and execute the below commands.

php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy -f

maniyatech / magento2-orderapi

Maintainers

Details