Release notes for OMS

These release notes document numerous functional fixes and enhancements of the Order Management System (OMS). Release notes are published in conjunction with the release to staging, approximately one week before the production release.

To see release notes specifically for hotfixes, check out Hotfixes.

Release notes include:

  • New features
  • Improvements
  • Known issues


Staging release—February 16, 2021 (EU and APAC regions)

Production release—February 23, 2021 (EU region) and February 24, 2021 (US and APAC regions)


Staging release—January 5, 2021 (EU and APAC regions)

Production release—January 12, 2021 (EU region) and January 13, 2021 (US and APAC regions)

  • Support Live Reports in the OMS backoffice—Now, the OMS backoffice supports live reports. A user can asynchronously request several live reports from the OMS that provide information about performance and results in the OMS.

  • Handle ISPU orders without pickup location information—Implemented new validation to verify that all order lines related to an In Store Pick Up (ISPU) shipping line have a valid ISPU pickup location.


Staging release—August 11, 2020 (EU and APAC regions)

Production release—August 18, 2020 (EU region) and August 19, 2020 (US and APAC regions)


Staging release—July 28, 2020 (EU and APAC regions)

Production release—August 4, 2020 (EU region) and August 5, 2020 (US and APAC regions)

  • Fix export for unlimited SKUs and NONZERO—Now, unlimited items are included when you export stock in NONZERO mode.

  • weight_unit and dimensions_unit included in customer_shipment_done message—When the pack_lines message contains weight_unit and dimensions_unit keys, that information is also included in the customer_shipment_done message.


Staging release—July 7, 2020 (EU and APAC regions)

Production release—July 14, 2020 (EU and APAC regions), July 15, 2020 (US region), and July 16, 2020 (rate limiting in all regions)

  • Updated specifications with rate limiting—Applied rate limits for message specifications. See individual specifications for rate limiting info. Now, rate limits control traffic rates and prevent system overload, service attacks, spread request spikes, and queue overfilling. We also added information about how the OMS handles rate limiting in the Magento Integration Bus topic.


Staging release—June 16, 2020

Production release—June 22, 2020 (EU region), June 23, 2020 (US region), and June 23, 2020 (APAC region)


Staging release—May 28, 2020

Production release—June 8, 2020 (EU region), June 9, 2020 (US region), and June 9, 2020 (APAC region)

  • Improved API Journal pagination—We improved the performance of our API Journal pagination. Now, you can successfully paginate 10,000 lines. Past that, you must refine your search.

  • Improved source stock exporting to account for real quantities—When the Publish a source stock updated message every time we receive a stock adjust message configuration is enabled and we receive a magento.inventory.source_stock_management.update or a magento.inventory.source_stock_management.adjust message, we now export the units in the magento.inventory.source_stock_management.updated event with consideration for inflight and safety stock quantities.

  • New Stock Export Report config for large stock data reports—There is a new root level Stock Export Report configuration option in the SI Portal that allows you to compress large stock data reports in excess of the 20MB limitation for attachments. Now, when exporting source or stock aggregate data in the OMS Admin, you can compress the report into a .zip file.


Staging release—May 5, 2020

Production release—May 19, 2020 (EU region), May 20, 2020 (US region), and May 20, 2020 (APAC region)

  • Added a refund button in the OMS admin—We added a new mechanism in the Customer service view of the OMS Admin to release a refund. You can also do this via the magento.postsales.refund_management.release message. You can configure refunds to be automatically released when a return is triggered.

  • Search for an aggregate via stock filter—Now, you can search for aggregates in the Aggregate stock view filter.

  • Synchronize pick list after force cancellation—When a force cancellation is applied for the request_lines of a picklist, the status of the pick list items and the pick list are synchronized.

  • Date and signature sections in packing slip document—You can now print hold documents, which includes new sections for date and signature, during the pick list stage for the in-store pickup (ISPU) shipping method.

  • New config allows available sources for returns to be enabled—When the Available sources for return configuration is enabled, you will only see a list of sources that have the Accept returns capability also enabled. If the source from which the order item was delivered does not have this capability enabled, it does not appear in the menu options.

  • Non-admin users can view pick list orders—Non-admin users can now see orders included in the pick list during the ship from store (SFS) picking stage in the OMS admin.

  • Improved usability for payments summary in Order details—Now, payment totals in the Order details view help clarify any cancellations or refunds made for the order, as well whether the order total includes gift cards and store credit.


Staging release—April 6, 2020

Production release—April 15, 2020 (EU region), April 16, 2020 (US region), and April 20, 2020 (APAC region)

  • Added a new credit_note_number field—Added a new optional credit_note_number field to the magento.postsales.credit_memo_management.created message to improve the compatibility between OMS and Magento Commerce (MC).

  • Relate refund payment operations to original post-sales refund—When the magento.postsales.credit_memo_management.created message is received with a non-blank credit_note_number value, that value is used to relate any refund payment operations to the original post-sales refund.

  • Optimized order search in the OMS Admin—Updated the search with filters Customer Firstname and Customer Lastname in the Dashboard for the OMS Admin.

  • Improved customer attributes for ISPU fulfillment—Now, it is possible for you to add custom attributes for in-store pickup (ISPU) orders and fulfillment method when in the picking or collection stage.

  • Updated return_management.update_line_custom_attributes message with return_line_number field—The return_management.update_line_customer_attributes message uses the return_line_number field instead of the order_line_number field. The new update command and updated event include the line_number as an integer.

  • Use default filter to sort orders in the OMS Admin—When the default filter is applied to the Sales > Orders view in the OMS Admin you can use it to sort columns.

  • Updated tracking link configuration—Now, the tracking link configuration is set up at the sales channel level instead of at the root level to avoid issues when setting up a client.

  • Orphaned shipping charges assigned to next shipment request—When a shipment request is canceled, any related shipping charges are assigned to the next shipment request to ensure the merchant receives them.

  • New common status date in refund_management.updated—The status date in the magento.postsales.refund_management.updated message now shows the correct date for all statuses.

  • ISPU ship-request-item status changes from RECEIVEDBYLOGISTICS to PICKCONFIRMED—Now, when processing the magento.logistics.fulfillment_management.pick_lines message the ship-request-item status changes from RECEIVEDBYLOGISTICS to PICKCONFIRMED, if the magento.logistics.fulfillment_management.receive_lines message was received previously.

  • Tracking information for STS visible in Order overview—Tracking information for a ship from store (STS) shipment is visible in the Shipment view of the Order details view.

  • Fixed carrier packing retry for SFS orders—When a user clicks Retry in the error dialog (which appears after a first confirm packing attempt) to retry, the confirm packing action is available.

  • Carrier integrations in a SFS process allows to check if box details are configured—When using carrier integration in a SFS process, the box and its details can be configured by client.

  • When auto-approve return for reshipments is enabled, refunds are auto-released—When the auto-approve return feature is disabled, the refund of a reshipped order is not released until the return in the corresponding child order is approved.

  • Refunds auto-released for exchanges with enabled auto-approve—When a return for an exchange order is released, the refund of the original order is automatically released (if auto-approve return functionality is enabled).

  • Order details view redirect when search returns one result—When searching for an order in the Orders or Customer service views return only one result, you are directed to the Order details view for that order.

  • Upload multiple sources via CSV—Now, you can upload multiple sources from a CVS file to the OMS Admin.

  • New exchange from canceled exchange now allowed—A new exchange can be requested from an order line with an existing canceled exchange if the previous exchange order line is canceled.

  • Change shipping address/method for reshipments and exchanges—For reshipments and exchanges, you can independently change both the shipping address and shipping method.

  • Fixed magento.sales.order_management.updated message—Now, every time there is a change from the LOGISTICS order status and the PENDING_FIRST_SHIPMENT_REQUEST order status reason to the LOGISTICS order status and the READYTOSHIP order status reason in an order, the magento.sales.order_management.updated message is triggered.

  • Payment summary for reauthorizations shows correct amounts—When payments are expired and reauthorized, the payment summary in the Order details view now correctly calculates the order total and amount due and includes the initial payment amount.

  • Required values for creating sources and aggregates—Not allowed creating an external id at source, Sales channel, or aggregate level with a null value.

  • List of pick lists in the SFS view show correct order number—The list of pick lists in the ship from store (SFS) view displays the right number of orders, which is the same as the orders shown in the main Dashboard of the OMS Admin.


Staging release—February 18, 2020

Production release—March 3, 2020 (EU region) and March 5, 2020 (other regions)

  • Activated rate limiting—We activated default rate limits for message specifications. These limits control traffic rates and prevent system overload, service attacks, spread request spikes, and queue overfilling. We also added information about how the OMS handles rate limiting in the Magento Integration Bus topic.

  • Journal service deployed to staging environments—We deployed the new journal service to staging environments and started synchronization with the current journal service.

  • AM/PM timestamp added to Sales Order report—When exporting a Sales Order report from the OMS Admin Sales Order view, the date fields now include AM/PM information.

  • Force cancellation message correctly displays—When a user force cancels an order, the success message now displays correctly as “Force cancel success for requests”.

  • Error highlighting visible for Admin exceptions/errors—Now, when the OMS Admin experiences an exception or error in the external information of an order, a red highlight appears in the external tab view.

  • lines_declined message now showing status reason—When you send a status reason in the item collection field of a magento.logistics.warehouse_management.lines_declined message we now update the order item in the OMS with the communicated status reason.

  • Custom attribute of “0” value order included in request_shipment—Custom attributes for orders with a value of “0” are now included in the magento.logistics.shipment_request_management.request_shipment message.

  • Appeasements auto-created when return approved—An appeasement is now created for an order when a return is approved, not when a child order return is requested.

  • Order search now returns the Customer Service Orders view—Previously, when an order search in the Customer Service > Orders or Sales > Orders views of the OMS Admin returns only one order, the user is taken directly to the individual order view. Now, to enable the user to revise their search criteria, a search returning one order will direct the user to the Customer Service Orders view instead.

  • Custom attribute show option uses labelId—The Custom attribute show functionality now utilizes a labelID, instead of an external ID number that uses special characters, which errantly disabled the functionality temporarily.


Staging release—January 14, 2020

Production release—January 28, 2020 (EU region) and January 29, 2020 (other regions)


Staging release—October 31, 2019

Production release—January 8, 2020 (EU region) and January 9, 2020 (other regions)

  • Preventative scheduled maintenance in Maintenance calendar—We added a Platform maintenance section—with region and maintenance window time frames—to the Maintenance calendar topic. This pre-determined maintenance schedule will help ensure that your OMS is healthy and performant and your production systems are running smoothly, freeing you to stay focused on addressing the ever-changing needs of your business.

  • Service Bus updated to v2.1.9—The Magento Service Bus has been updated to version 2.1.9, which implements several stability improvements and adds a configurable journal store.

  • Field validation for magento.sales.order_management.create message—We added a field validation for the magento.catalog.product_management.create message.

  • Field validation for magento.catalog.product_management.updated message–We added a field validation for the magento.catalog.product_management.updated message.

  • Date filter in Backorders—We added a date filter to the Backorders view in the OMS Admin.

  • Updated packSlipCompanyInfo and packSlipFooter SFS configuration—Now, the packSlipCompanyInfo and packSlipFooter configuration fields in a Ship from Store (SFS) fulfillment process are based on source level information.

  • Returns for order lines containing a service—Now, returns including an order line with a service, such as gift wrap, are authorized and do not show a 500 error.

  • Improved uncaught exception TypeError logs—We improved the log information within a uncaught exception TypeError. When you attempt to cancel an order within an order status in_logistics, a new warning messages appears.

  • Improved user roles security functionalities—Security functionalities for user roles were improved to allow you to modify user roles from your OMS Admin.


Staging release—October 2, 2019

Production release—October 30, 2019

  • Service Bus updated to v2.0.6—The Magento Service Bus has been updated to version 2.0.6, which allows deleting expired messages from the SQS queue.

  • Block search engine indexing with robots.txt—We updated the robots.txt file to ensure the Order Management System (OMS) Admin is not indexed by web search engines.

  • order_line_number added to line_cancelled message—The order_line_number was added to the magento.sales.order_management.line_cancelled specifications message.

  • New specifications for ISPU decline/cancel flow—We added a new set of fulfillment specification messages so that you can extend the current In-store Pickup (ISPU) decline/cancel picking/collection fulfillment flows to integrate your own ISPU fulfillment operations described in the fulfillment section.

  • New specifications for ISPU ship/confirm collection flow—We added a new set of fulfillment specification messages so that you can extend the current In-store Pickup (ISPU) ship/confirm collection fulfillment flows to integrate your own ISPU fulfillment operations described in the fulfillment section.

  • New specifications for ISPU pick flow—We added a new set of fulfillment specification messages so that you can extend the current In-store Pickup (ISPU) pick/confirm picking fulfillment flows to integrate your own ISPU fulfillment operations described in the fulfillment section.

  • New specifications for SFS ship flow—We added a new set of fulfillment specification messages so that you can extend the current Ship from Store (SFS) shipping fulfillment flows to integrate your own SFS fulfillment operations described in the fulfillment section.

  • Tracking info displayed in predictable format—The carrier, tracking link, and tracking number information now display in a consistent, easy-to-read format.

  • Canceled ISPU - STS shipment request items move to canceled status—Now, when canceling an In-store Pickup (ISPU) - Ship to Store (STS) order in the Customer Service view after declining the items in the STS flow, the shipment request items are moved to a canceled status instead or remaining in a pending arrival status.

  • Single lists created when customizing generation of pick list—A previous issue, in which multiple pick lists were created when customizing the generation of the pick list during the Ship from Store (SFS) flow, has been resolved. Now, only one pick list is created during this customization.

  • Start Packing button now visible—The Start Packing button within the Ship from Store (STS) process is now active, and not grayed out (caused by the latest version of Google Chrome).

  • Multiple clicks of Start Packing button incurs single distribution—Multiple clicks of the Start Packing button now only produce one distribution action, instead of attempting to distribute the pick list multiple times and encountering an error.


Staging release—August 27, 2019

Production release—September 5, 2019

  • New warehouse fulfillment flow specifications—We integrated a new set of fulfillment specification messages for the warehouse flow described in the fulfillment section, which expands the existing flow.

  • New Ship from Store (SFS) flow for picking—We integrated a new set of fulfillment specification messages for the picking flow described in the fulfillment section, which expands the current OMS fulfillment flow to allow merchants to integrate their own custom SFS fulfillment operations.

  • New specifications for the Ship from Store (SFS) cancellation flow—We integrated a new magento.logistics.fulfillment_management.cancel_lines specification for the cancellation flow, described in the fulfillment section.

  • New specification for the Ship from Store (SFS) decline picking flow—We integrated a new magento.logistics.fulfillment_management.decline_lines specification in the decline picking flow, described in the fulfillment section.

  • Implemented a status validation for shipment request items—A new validation was created for status transitions of the new set of fulfillment specification messages.

  • New payment summary feature—Added a new payment information summary to the Order details page.

  • Payment information in the Order details view—Added payment information to the Order details page, with improvements in both the Customer Service and Sales views.

  • New standard error handling warning for the fulfillment specification messages—We added a new standard warning exception that is shown when there is a problem with the fulfillment flow, as described in the fulfillment section and the new set of fulfillment specification messages.

  • PickListController method checks the carrier integration configuration—Updated the PickListController method that checks whether the carrier integration is enabled to use the Order_Sales sales channel, instead of the default configuration client.

  • Shipping address update validation fix—Now, once orders are in the remorse period, the customer service agent can change the shipping address.

  • UpdateShippingAddress configuration shows the change shipping address functionality—Now if the UpdateShippingAddress configuration is disabled, it does not hide the action for changing the shipping address in the Customer Service view.

  • Force shipment button creates a single package for all items—The Force shipment button now creates a single package for all items.

  • Defined ItemName in the order_line_cancelled template—Order product name is now shown in the customer service view. Appears in the history details section when an order line has been cancelled.

  • Added address custom attributes for generated shipment requests—Address custom attributes are now created when a shipment request is generated, via the magento.logistics.shipment_request_management spec.


Staging release—June 4, 2019

Production release—June 12, 2019

  • Recommended limit of order lines that can be correctly processed—The recommended number of order lines is 200 lines per order. See the Orders page for more information.

  • Order creation date available in the Admin export—The order export functionality in the Admin now exports the order_creation_date attribute.

  • Maximum number of characters allowed in the product_name field increased—This fix allows the product_name description field on the order.create message to be updated from 300 to a maximum of 1000 characters.

  • shipment_date allowed when shipment_done event is triggered—Now, there is a shipment_date event available when the customer_shipment_done is triggered.


Staging release—May 7, 2019

Production release—May 21, 2019

  • Loader shows progress of mass actions—We have implemented a visual loader to indicate the status of the batch operation, or mass action, during the picking and collection processes.


Staging release—April 9, 2019

Production release—April 16, 2019

  • Expanded Manual Actions functionality—Users with roles restricted by Sales Channel can now access the Manual Actions tab for a specific order in the OMS Admin.

  • Decline collection of all items—We added the ability to decline the collection of all lines and items of an ISPU bulk pick list.

  • Decline picking of all items—We added the ability to decline the picking of all lines and items of an ISPU bulk pick list.

  • Confirm Picking and Decline Picking options—Availability of new Confirm Picking and Decline Picking options when confirming or declining ISPU orders and Confirm Collection and Decline Collection options when confirming or declining customer collection.

  • Show number of items in pick list—Now you can see the total number of items in the pick list.

  • Decline reason in Customer Collection View—We have added the ability to select the decline reason in the Customer Collection view for declined lines of an ISPU bulk pick list.

  • Confirm/decline collection of multiple items—Store assistants can now Confirm & Collect or Decline the collection of multiples lines of an ISPU pick list in the Customer Collection view.

  • Confirm/decline collection of all items—Store assistants can now Confirm & Collect or Decline the collection of all lines of an ISPU pick list in the Customer Collection view.

  • Select decline reason in PickList view—Store assistants can now select the decline reason of selected lines of an ISPU bulk pick list.

  • Confirm/decline picking of multiple items—Store assistants can now confirm and decline multiple items of selected lines of an ISPU bulk pick list.

  • Confirm picking of all items—Store assistants can now confirm all lines of an ISPU bulk pick list.

  • Improved custom attributes modification—The process of modifying customer attributes has been greatly improved with the addition of a dropdown menu showing valid values for selection, including supported attribute types and associated validations, and modifiable entities.

  • Re-trigger payment capture—In a payment capture exception, you now have the ability to re-trigger the payment capture to recover captures during a payment integration outage or other similar event.

  • Inflight stock info available at source level—To ensure the most up-to-date info for available stock per source, information about inflight stock is available at the source level to the broadcasted event via the source_stock_management.updated message.


Staging release—March 12, 2019

Production release—March 19, 2019

  • Implement feedback banner in Magento Admin—To gather helpful feedback from users/clients, we have implemented a feedback banner in the Magento Admin requesting information from users about the system’s capabilities and functionality.

  • Add shipment date in order view—The shipment date for an order is now visible in the order view for Shipment Requests and Shipments.

  • Dashboard to display exceptions—The dashboard will provide users, with the appropriate permissions, visibility to pending payment issues.

  • Revise user configuration template—The previous configuration option for adding new users in the CSV template file for user creation, “access_all_sales_channels_and_sources”, was removed from the CSV template so that only current functionality and options are visible.

  • Provide notification for payment event failure—Payment events failures will now generate a magento.common.error_management.notify message to allow the System Integrators (SIs) to understand which events were not correctly processed by the OMS.

  • Custom attributes search usability improvements—We improved the usability of the custom attributes search field. Values are shown in a dropdown menu to assist in properly filling in this field.

  • Add the custom attribute type URL—Now you can define a custom attribute as a URL to access an external source.

  • Custom attributes showing properly in the In Store Pickup page—Custom attributes are now properly visible in the In-store Pickup Magento Admin page.

  • Order ingestion validations—Custom attributes are now received with matching definitions, defined by the business, so that if you receive invalid data you can prevent any corrupted data coming from integrations like ERP or CRM.


Staging release—February 12, 2019

Production release—February 19, 2019

  • Promotional info added to shipment request message—Line level promotional information was added to the magento.logistics.warehouse_management.request_shipment message.

  • Configure order attributes visibility in Sales grids—You can now configure which custom order attributes are visible on some Sales grids in Admin (Sales, Customer service, and ISPU). The newly configured customer order attribute columns will be saved in your user profile, and are visible when you log back in.

  • Custom attributes and promise delivery date added to sourcing request—Custom attributes prefixed with mom_srcrr_ and the promise delivery date have been added to the sourcing request, so that you can overwrite specific sourcing rules via custom attributes provided in the order and source orders by promise date.

  • Access to manual order actions—New comprehensive user and roles functionality now provides the ability to perform manual actions for an order.

  • Support bundles with multiple quantities—We now support bundles with multiple quantities via the parent_line_number field in the order create message, which allows you to provide definition of the parent/child relationship. The parent_line_id field is now deprecated.

  • Generate a payment ingestion failure message—A message will be generated each time a payment event fails to be ingested by the OMS, and will provide helpful information for troubleshooting the integration or other issues, via the magento.common.error_management specification.

  • agedBackorders sourced at same time—Now, instead of submitting orders in the sourcing wave every X hours when stock is received in the warehouse/source, the stock snapshot is used to validate which of the agedBackorders received stock. Then the agedBackorders be re-queued for the next allocation wave (same day).

  • Information is searchable by sales channel—You can search for information per sales channel with the optional (for search fields and response) sales_channel_id in the command.


Staging release—January 14, 2019

Production release—January 23, 2019

  • Overwrite bundle sourcing rule—You can now overwrite the bundle sourcing rule at the order level using a custom attribute.

  • Define order-specific sourcing override rules—You can now overwrite the generic order configuration to treat single-shipment orders as split orders if stock is available in different sources, but should not be partially sourced due to stock availability or rule limitations.