Release notes for Connector

These release notes document numerous functional fixes and enhancements of the Connector. Release notes are published in conjunction with the release to production.

Each section below represents a specific, versioned Connector release, and the noted date reflects when the release notes were published.

Release notes include:

  • New features
  • Improvements
  • Known issues

See the changelog for each version of the Connector compatible with Magento Commerce 2.1.x, Commerce 2.2.x, Commerce 2.3.x, or Commerce 2.4.x.

Magento Commerce v2.4.x

v4.1.0

October 1, 2020

  • Connector compatible with Magento Commerce v2.4.1—The Connector is now compatible with Magento Commerce v2.4.1.

v4.0.0

July 28, 2020

  • Connector compatible with Magento Commerce v2.4.0—The Connector is now compatible with Magento Commerce v2.4.0.

  • Disable new MSI modules to use OMS and ConnectorDisable the new Multi-source Inventory (MSI) modules to use OMS and the Connector with Magento v2.4.

  • ShippingRefundRule determines shipping fee refunds—If the ShippingRefundRule is set to never in the Order Management System (OMS) Admin, shipping fees for returns are not refunded in Magento Commerce.

  • Child order lines in multi-bundle orders contain correct parent_line_number—When an order contains more than one bundle, now the child order lines contain the parent_line_number that corresponds with the appropriate bundle product.

Magento Commerce v2.3.x

v3.6.0

October 1, 2020

  • Connector compatible with Magento Commerce v2.3.6—The Connector is now compatible with Magento Commerce v2.3.6.

  • Notify me functionality enabled out-of-the-boxNotify me functionality is enabled out-of-the-box when multiple Magento Commerce instances are connected to a single Order Management System instance.

  • parent_line_number corresponds with correct bundle line—Now, when an order contains more than one bundle, the child order lines have a parent_line_number that corresponds to the correct bundle line in the order_management.create message.

  • New maximum number of retries functionality in the Catalog export view—We added a maximum number of five retries in the retry functionality for the catalog export task to avoid infinite retries on products which are not valid to export per Order Management System rules.

v3.5.0

April 28, 2020

  • Connector compatible with Magento Commerce v2.3.5—The Connector is now compatible with Magento Commerce v2.3.5.

  • Connector supports SHA-2 signature—The Connector now supports the SHA-2 security signature provided by the Order Management System (OMS) Service Bus.

  • See average and historical message time consumed by Connector—Now you can see the average message time and historical message time in each of the endpoints consumed by the Connector module. This information will be available in the Connector system report in the Magento Commerce Admin.

  • Order number pattern configurable—The order number pattern is now configurable via configuration in the Developer view of the Magento Commerce Admin.

  • New health check command—We implemented a command to check the health of the Commerce OMS integration and provide guidance for executing next steps if a problem is found.

  • New Relic logs key performance metrics—You now have access to performance metrics, including memory usage before and after, memory usage difference, peak memory usage before and after, difference between peak memory usage, and time elapsed for each message that is processed.

  • Increased performance from asynchronous option—To increase performance, we added the asynchronous option for JSON RPC.

  • Message processes avoids out of memory limitation—The message processor now avoids out of memory limitations by adding a check to compare usage and limits, and then ending the loop when memory consumption is over threshold (and a warning is logged in the log file).

  • Expanded catalog export task for troubleshooting—We added columns to the catalog export task that allow you to see the reason, start time, and end time of requests for troubleshooting purposes.

  • Added max retries for catalog export task—We added a maximum number of retries to the catalog export task for each item to avoid infinite retries on products not valid for export (per OMS rules).

  • Sales Orders filter option shows date picker—Now, the date picker in the Magento Commerce Admin appears when you select a date in the Sales Orders filter option.

  • Custom message handlers now backward compatible—Custom, third-party or System Integrator (SI), message handlers inside the Connector module are now backward compatible.

  • Stock aggregate info removed from OMS Admin—When a stock aggregate is removed from the OMS Admin, the information for the stock aggregate is also removed.

  • Show related products per rule config—The behavior of showing related products, based on the number of products, is now correctly utilizing the rule’s configuration.

  • NONZERO stock snapshot updates keep bundles in stock—Now, when you manage stock snapshot updates in NONZERO mode bundles do not appear out of stock, and instead remain in stock as expected.

v3.4.0

January 28, 2020

  • Connector compatible with Magento Commerce v2.3.4—The Connector is now compatible with Magento Commerce v2.3.4.

  • Connector compatible with PHP 7.3—The Connector is now compatible with PHP 7.3.

  • Out of stock product shown when inventory greater than 0—We enabled inventory website granularity to allow order placement from the Magento Commerce Admin when a merchant uses specific stock levels on each website to alleviate the out of stock product availability for inventory greater than quantity of 0.

  • Dynamic SKU functionality disabled for Connector—The Dynamic SKU is disabled out-of-the-box for the Connector, due to no compatibility with the MSI functionality in Magento Commerce.

  • Fixed order export functionality—We fixed the inoperable Export Order button (to force the export of orders) in the Magento Commerce Admin.

  • Increased delay for first retry of order_management.create message—We resolved the issue that the Connector could send more than one magento.sales.order_management.create message when the partner configures this communication in asynchronous mode. This fix improves the API Journal functionality.

  • Improved Connector permissions for users—We fixed user roles and permission for the Connector to ensure the admin role is not disabled.

v3.3.0

November 6, 2019

  • Enabled advanced inventory functionalities—New capabilities and advanced inventory functionalities have been added out-of-the-box for Magento Commerce.

  • Multiple invoices are now created for each shipment in an order—Invoices are created for each shipment of an order, instead of an invoice being created for each package in the shipment.

  • Credit memo creation for gift cards/store credit—Added the capability to create credit memos of gift cards and store credit.

  • Improved gift card invoice creation—Invoice creation logic for fully or partially paid gift card orders is now aligned with out-of-the-box Magento Commerce logic.

  • Updated store credit payment method logic—Store credit is not treated as a gift card in the OMS or in Magento Commerce. The Connector supports a new structure for store credit and gift cards.

  • Connector now compatible with Commerce v2.3.2 SOAP API—Now the Connector is compatible with Magento Commerce v2.3.2 and its SOAP API communication protocol.

  • Connector now compatible with Magento Commerce v2.3.2 XSD validation—Now the Connector is compatible with Magento Commerce v2.3.2 and its XSD validation files.

v3.2.0

June 27, 2019

  • Increased timeout for registration/other messages—We increased the timeout for sending messages to the OMS from 5 seconds to 1 minute.

  • New WARNING log status message—A new WARNING log status message was added to the API Journal view to indicate that the API was processed successfully (but can also be used to require a check that indicates that the message content was correct).

  • Incoming messages only imported asynchronously—Incoming messages are only imported asynchronously, and are not manually configurable.

  • Load bundled product with admin capabilities—We made improvements to allow you to load bundled products with admin CSV import product capability.

  • Fixed price bundles successfully exported—Now, bundles with fixed prices are exported correctly and without error in the Order Management System (OMS).

  • Update frequency of push messages via UI—This fix allows you to modify the frequency of the cron job that performs the hourly push for synchronizing Magento Commerce (MC) and the OMS.

  • Catalog inventory FULL mode updates absent catalog items correctly—The magento.inventory.aggregate_stock_management.updated message, in FULL mode, no longer sets all absent catalog items as “0”. Use NONZERO mode to initialize the previous behavior.

  • Align statuses in order grid and order detail page—he OMS statuses in the order data grid and order detail page are aligned and show the same status information.

  • Order cancellations for MC 2.2.0 installations—Now, you can complete order cancellations for MC 2.2.0 installations.

  • Export orders after initial order export failure—We resolved the issue that after the first order export failure you are not able to export any other orders. You can now continue exporting orders even after a failure.

  • Errant HTML formatting removed from order details page—The “Purchased from”, “Billing Address”, and “Shipping Address” fields in the Magento Digital Commerce (MDC) order details page will no longer permit HTML tags, which errantly render in the UI.

  • Re-enabled capability to resend tracking emails—You can re-send tracking emails via the Send tracking information button from the Shipping and Invoice pages. This option was previously disabled.

  • Display message log title in the API Journal history view—In the API Journal view we added the ability to view the message title related to each of the log entries.

  • Modules save only attributes to be modified—Modules only save the attribute they intend to modify, using EntityAbstract::saveAttribute instead of orderRepository->save, so that other data does not accidentally get overwritten.

v3.1.1

April 4, 2019

  • Removed proxy subclass—The SingleMessageProcessor previously requested a proxy subclass for handlers. This behavior has been deprecated. You must explicitly define proxy subclasses in your di.xml file when registering your own handlers.

  • Order processing after deleting products in Magento Commerce—The OMS now successfully processes orders if products in an order have been deleted in Magento Commerce.

  • Improved unserialized process in the service bus—This fix improves the unserialized process for synchronous messages.

  • Shipments with Connector v2.2.0 are created—Merchants with the v2.2.0 Connector can continue to synchronize shipments based on the customer_shipment_done message.

  • Order creation with gift card support—You can now sucessfuloy create orders with a gift cards in v3.1.0.

v3.1.0

March 19, 2019

  • Added mapper for Adyen payment gateway—We added a mapper to map the gateway_id, account, and transaction_id fields to support Adyen payment gateway processing via the OMS.

  • Added incremental retry policy for orders not loaded—When an order created in Magento Commerce cannot be loaded in the OMS, the message will now be retried for a maximum of 48 hours, after which the message will no longer be retried and the order grid will display a FAILED status in the Order loaded in OMS column.

  • Bundling support—We added support for bundling.

  • Gift card support—We added support for gift cards as a promotional discount/store credit option.

  • Stop retries for duplicated order IDs—When a new order cannot be created in the OMS due to a duplicated order ID the message will not be retried, and the order grid will display a FAILED status in the Order loaded in OMS column.

  • Updated Connector configuration—The StoreID configuration was changed to the Sales Channel ID and the deprecated “Transport - Driver” configuration was removed.

Magento Commerce v2.1.x and 2.2.x

v2.6.0

April 28, 2020

  • Connector compatible with Magento Commerce v2.2.12—The Connector is now compatible with Magento Commerce v2.2.12.

  • Connector supports SHA-2 signature—The Connector now supports the SHA-2 security signature provided by the Order Management System (OMS) Service Bus.

  • See average and historical message time consumed by Connector—Now you can see the average message time and historical message time in each of the endpoints consumed by the Connector module. This information will be available in the Connector system report in the Magento Commerce Admin.

  • Order number pattern configurable—The order number pattern is now configurable via configuration in the Developer view of the Magento Commerce Admin.

  • New health check command—We implemented a command to check the health of the Commerce OMS integration and provide guidance for executing next steps if a problem is found.

  • New Relic logs key performance metrics—You now have access to performance metrics, including memory usage before and after, memory usage difference, peak memory usage before and after, difference between peak memory usage, and time elapsed for each message that is processed.

  • Increased performance from asynchronous option—To increase performance, we added the asynchronous option for JSON RPC.

  • Message processes avoids out of memory limitation—The message processor now avoids out of memory limitations by adding a check to compare usage and limits, and then ending the loop when memory consumption is over threshold (and a warning is logged in the log file).

  • Expanded catalog export task for troubleshooting—We added columns to the catalog export task that allow you to see the reason, start time, and end time of requests for troubleshooting purposes.

  • Added max retries for catalog export task—We added a maximum number of retries to the catalog export task for each item to avoid infinite retries on products not valid for export (per OMS rules).

  • Sales Orders filter option shows date picker—Now, the date picker in the Magento Commerce Admin appears when you select a date in the Sales Orders filter option.

  • Custom message handlers now backward compatible—Custom, third-party or System Integrator (SI), message handlers inside the Connector module are now backward compatible.

  • Stock aggregate info removed from OMS Admin—When a stock aggregate is removed from the OMS Admin, the information for the stock aggregate is also removed.

  • Show related products per rule config—The behavior of showing related products, based on the number of products, is now correctly utilizing the rule’s configuration.

  • NONZERO stock snapshot updates keep bundles in stock—Now, when you manage stock snapshot updates in NONZERO mode bundles do not appear out of stock, and instead remain in stock as expected.

v2.5.0

January 28, 2020

  • Connector compatible with Magento Commerce v2.2.11—The Connector is now compatible with Magento Commerce v2.2.11.

  • Connector compatible with PHP 7.2—The Connector is now compatible with PHP 7.2.

  • Out of stock product shown when inventory greater than 0—We enabled inventory website granularity to allow order placement from the Magento Commerce Admin when a merchant uses specific stock levels on each website to alleviate the out of stock product availability for inventory greater than quantity of 0.

  • Fixed order export functionality—We fixed the inoperable Export Order button (to force the export of orders) in the Magento Commerce Admin.

  • Increased delay for first retry of order_management.create message—We resolved the issue that the Connector could send more than one magento.sales.order_management.create message when the partner configures this communication in asynchronous mode. This fix improves the API Journal functionality.

  • Improved Connector permissions for users—We fixed user roles and permission for the Connector to ensure the admin role is not disabled.

v2.4.0

This release is the first Connector release to be 100% compatible with related Commerce code.

November 6, 2019

  • Enabled advanced inventory functionalities—New capabilities and advanced inventory functionalities have been added out-of-the-box for Magento Commerce.

  • Multiple invoices are now created for each shipment in an order—Invoices are created for each shipment of an order, instead of an invoice being created for each package in the shipment.

  • Credit memo creation for gift cards/store credit—Added the capability to create credit memos of gift cards and store credit.

  • Improved gift card invoice creation—Invoice creation logic for fully or partially paid gift card orders is now aligned with out-of-the-box Magento Commerce logic.

  • Updated store credit payment method logic—Store credit is not treated as a gift card in the OMS or in Magento Commerce. The Connector supports a new structure for store credit and gift cards.

  • Connector now compatible with Commerce v2.3.2 SOAP API—Now the Connector is compatible with Magento Commerce v2.3.2 and its SOAP API communication protocol.

  • Connector now compatible with Magento Commerce v2.3.2 XSD validation—Now the Connector is compatible with Magento Commerce v2.3.2 and its XSD validation files.

v2.1.2

February 4, 2019

  • MCOM Connector compatibility with v2.3 without MSI—Now you can install Magento v2.3 with the latest version of the Connector. By default, an upgrade from v2.2 to v2.3 will maintain the disabled MSI module, but a new v2.3 installation requires you to manually turn off MSI.

January 24, 2019

  • Support all shipping methods—OMS now supports any Magento-configured shipping methods by creating catalog entries.

  • VAT country configuration no longer needed—OMS re-uses the VAT country information previously configured in Sales > Tax > Default Country, instead of requiring additional VAT country configuration (in Stores > Configuration > MCOM Connector).

  • Transitional state LOGISTICSCOMPLETE(COMPLETEDSHIP) not shown in Order Detail page—Now, when OMS sends a magento.sales.order_management.updated message with a status of LOGISTICSCOMPLETE and a status reason of COMPLETEDSHIP, it will be ignored in the API Journal view in MDC and in the comment section of the Order Detail page, to prevent any confusion about this transitional state.

  • Product quantity field in MDC Admin are sortable—Now you can sort the quantity column of the product grid in the MDC Admin to see all products with high stock or zero stock quickly and efficiently.