Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.alumio.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The Magento 2 Order Subscriber is a configuration-based subscriber that listens for order-related events from a Magento 2 source system. It replaces the deprecated prototype-based magento2-order-subscriber previously used in the Legacy Magento 2 Connector.
This component has been migrated from a prototype-based implementation to a configuration-based setup as part of the Legacy Magento 2 Connector replacement project.

​
Prototype vs Configuration-based

This is an important behavioral difference to understand before setting up this component.
Prototype-basedConfiguration-based
ReusabilityCan be reused across different flows by changing a few fieldsNot reusable across different purposes or payloads
FlexibilityOne prototype can serve multiple use cases(Not always) Each use case requires its own dedicated configuration
How to reuseModify fields directlyDuplicate the configuration and adjust as needed
If you need to handle a different payload structure or use case, you must duplicate this Subscriber and adjust the configuration accordingly. Do not modify an existing configuration as another Route already uses it.

​
Type

Subscriber

​
Purpose

This Subscriber listens to incoming order data from Magento 2 and triggers the appropriate Route for further processing. It acts as the entry point for order-related integration flows.

​
Configuration

ParameterDescriptionRequired
store_codeThe Magento 2 Store CodeYes
http-clientThe HTTP Client Authentication method used to connect to Magento 2Yes
mutation-storageThe storage to set the mutation dateYes
entity-schemaThe specific schema for the entityNo
limitThe limit of the itemsNo
start-dateThe start dateNo

​
Usage

  1. Navigate to Subscribers in your Alumio environment.
  2. Search for or create a new Magento 2 Order Subscriber.
  3. Configure the required parameters as described above.
  4. Attach this Subscriber to the relevant route as the Incoming configuration.

​
Deprecated VS New

An example of the deprecated configuration:
Image
An example of the new configuration:
Image
Image

​
Notes

  • Replaces the prototype: magento2-order-subscriber
  • Unlike the prototype-based implementation, this configuration-based subscriber is not reusable across different purposes or payloads. If you need to handle a different payload structure or use case, you must duplicate this Subscriber and adjust the configuration accordingly.
  • Ensure the Magento 2 API credentials are correctly configured before activating this Subscriber.
  • For large order volumes, tune the limit parameter to avoid timeouts.