magelearn/module-credit-memo-export

Magento 2 module for exporting Credit Memos asynchronously via Message Queue.

dev-main 2026-08-18 09:33 UTC

OSL-3.0

• Vijay Rami

Published on Packagist.org on 2026-08-18 09:34 UTC

README

A Magento2 module that demonstrates how to export Credit Memos asynchronously using Admin UI, Message Queue, Consumer, XML generation, file export, and export-status tracking.

Functionality

The module provides an Export to Service button on the Magento Admin Credit Memo view page.

Screenshots

Admin

Navigate to:

Sales → Credit Memos → Open a Credit Memo

The following button is displayed:

Export to Service

Clicking the button:

1. Validates the export configuration.
2. Checks whether the Credit Memo has already been queued/exported.
3. Publishes the Credit Memo ID to the Magento Message Queue.
4. Stores the published_at timestamp.
5. Adds an Admin Credit Memo comment.
6. The queue consumer processes the message asynchronously.
7. Credit Memo data is converted to XML.
8. XML is written to the configured export directory.
9. A backup copy is created.
10. exported_at is updated after successful export.

A second export attempt is prevented when the Credit Memo has already been queued or exported.

Configuration

Go to:

Stores → Configuration → Services → Magelearn Export

Configure:

Configuration	Description
Enabled	Enable/disable Credit Memo export
Export Path	Directory where XML files are generated
Backup Path	Directory where backup XML files are stored
Topic Name	Message Queue topic used for Credit Memo export

Example:

Export Path:
var/integration/export/creditmemo

Backup Path:
var/export_creditmemo

Message Queue Flow

The module uses Magento's asynchronous message queue architecture:

Admin Credit Memo
       ↓
Export Controller
       ↓
Publisher
       ↓
magelearn.creditmemo_export
       ↓
Queue
       ↓
Consumer
       ↓
Credit Memo Exporter
       ↓
XML Generator
       ↓
Export File
       ↓
Update exported_at

The controller does not generate the XML directly. It only publishes the Credit Memo ID to the queue.

Console Command

The module provides:

bin/magento magelearn:export:creditmemo

Export by Credit Memo Increment ID

bin/magento magelearn:export:creditmemo <increment-id>

Example:

bin/magento magelearn:export:creditmemo 000000123

Export by Date Range

bin/magento magelearn:export:creditmemo \
    --requested-from="2026-08-01" \
    --requested-to="2026-08-16"

Filter by Store

bin/magento magelearn:export:creditmemo \
    --store-id=1 \
    --requested-from="2026-08-01" \
    --requested-to="2026-08-16"

Export only Credit Memos not yet exported

bin/magento magelearn:export:creditmemo \
    --requested-from="2026-08-01" \
    --requested-to="2026-08-16" \
    --not-exported-only

Dry Run

To display matching Credit Memos without exporting:

bin/magento magelearn:export:creditmemo \
    --requested-from="2026-08-01" \
    --requested-to="2026-08-16" \
    --dry-run

Start the Queue Consumer

Check available consumers:

bin/magento queue:consumers:list

Look for:

magelearn.creditmemo_export

Start the consumer:

bin/magento queue:consumers:start magelearn.creditmemo_export

For development, you can keep this command running in a terminal while testing exports.

What to Check After Queue Processing

After successfully processing a Credit Memo, verify:

1. XML Export

Check:

var/integration/export/creditmemo/

Expected:

<creditmemo-file>.xml

2. Backup

Check:

var/export_creditmemo/

A backup XML file should be present.

3. Credit Memo Comment

Open the Credit Memo in:

Sales → Credit Memos → Credit Memo View

The export comment should be displayed in the Credit Memo history.

4. Export Tracking

Check:

SELECT *
FROM magelearn_creditmemo_export
ORDER BY entity_id DESC;

Expected state:

cm_entity_id  | published_at        | exported_at
----------------------------------------------------
123            | 2026-08-16 23:40:00 | 2026-08-16 23:40:05

Database Tables

The module creates one custom table:

magelearn_creditmemo_export

Structure

Field	Purpose
entity_id	Primary key of the export tracking record
cm_entity_id	Magento Credit Memo entity_id
published_at	Time when the Credit Memo was published to the queue
exported_at	Time when the Credit Memo was successfully exported

cm_entity_id has a foreign-key relationship with:

sales_creditmemo.entity_id

and is indexed for efficient lookup.

Export Tracking Lifecycle

Initially:

cm_entity_id = 123
published_at = NULL
exported_at  = NULL

After clicking Export to Service:

cm_entity_id = 123
published_at = 2026-08-16 23:40:00
exported_at  = NULL

After the queue consumer successfully completes the export:

cm_entity_id = 123
published_at = 2026-08-16 23:40:00
exported_at  = 2026-08-16 23:40:05

This tracking prevents a Credit Memo from being queued repeatedly and provides a simple export lifecycle:

Not Published
     ↓
Published / Queued
     ↓
Successfully Exported

Magento Architecture Concepts Demonstrated

This module demonstrates:

• Admin Controller
• Admin UI Block and Template
• ACL
• Dependency Injection
• Service Contracts
• Repository Pattern
• Model / ResourceModel
• Declarative Schema
• Message Queue Publisher
• Queue Consumer
• Virtual Types
• Strategy Pattern
• XML generation
• File export
• Export-state tracking
• CLI Commands
• Asynchronous processing