Order Management System (OMS) reached end of support in October 2024.
The documentation available here is intended for historical reference only and is not maintained.
For other Commerce-related documentation, see Adobe Commerce Documentation.

Global Settings

The System Integrator (SI) Portal is not yet accessible externally. Contact Magento Support for assistance.

The Global Settings configuration tab offers the ability to configure settings that apply everywhere in an OMS instance. Add tracking link info, set remorse time standards, add or edit custom attributes, and much more right from this Global Settings tab.

Global Settings configuration tab

Global Settings

To enable (make active and visible) the Categories for configuration, select a scope from the Select scope dropdown.

To make changes to a value or setting, deselect DEFAULT so that you can override the existing default value. To make your new changes the default setting, select UNSET, click Yes in the confirmation dialog that appears, and then click Save Rule.

Backoffice category

The Backoffice category allows you to revise he background colour and client logo.

Backoffice category

Field Description
Background colour Change the background colour of the admin pages via a hex code.
Client logo URL Add a client logo to the client instance via an image URL.

Customizations category

The Customizations category allows you to revise custom attributes and toggle the visibility of due time information.

Customizations > Custom Attributes

Customizations > Due Time

Field Description
Custom attributes Add a new custom attribute or define an existing one via Attribute Name (string format), Type (equal to one of the allowed values), Regular Expression (string format), and Enum Values (for custom atributes of the enum type) fields.
Hide due time information Enable or disable the visibility of due time information in the OMS Admin.

See the Custom attributes topic for more information about custom attributes details and configuration.

Integration category

The Integration category allows you to enable or disable the integration with the logistics provider (a warehouse or physical store, for instance).

Integration > Aggregated quantities in LSP integration

Field Description
Aggregated quantities in LSP integration Enable or disable the ability to integrate with the logistics provider(s) by sending aggregated quantities by SKU via the aggregated_items field of the request_shipment command in the magento.logistics.warehouse_management message.

Omnichannel category

The Omnichannel category allows you to enable the use of carrier integration for tracking purposes and define shipping methods for Ship from Store (SFS) items.

Omnichannel > Enable carrier integration Omnichannel > Enable carrier integration

Omnichannel > SFS Available shipping methods

Field Description
Enable carrier integration Enable or disable the use of carrier integration to receive tracking information for shipments. Specify the default item weight, default carrier, and carrier integrations enabled per source.
SFS Available shipping methods Define available shipping methods for SFS orders, such as STANDARD and EXPRESS.

Order category

The Order category allows you to define exception rules for aging orders, configure remorse time, and configure tracking links.

Order > Exceptions rules

Order > Remorse time Order > Remorse time

Field Description
Exceptions rules Configure the exceptions rules for aged orders, including the number of days in which an order is considered “aged”, the time frame for resubmitting aged orders, whether aged backorders should be marked as ready to be sourced if stock is received for an order line, and the number of hours before an order should be flagged as a high exception (dependent on shipping method).
Remorse time Define the patterns for applying remorse time for an order (normal production orders), including enabling or disabling the functionality, the time in seconds, restrictions for specifically flagged orders, the expiration mode (all or excludeWeekends), and order restrictions based on custom factors (Type, Value, Time, and Notification email options).
Remorse time (Test) Define the patterns for applying remorse time for an order (test orders), including enabling or disabling the functionality, the time in seconds, restrictions for specifically flagged orders, the expiration mode (all or excludeWeekends), and order restrictions based on custom factors (Type, Value, Time, and Notification email options).
Tracking links configuration Add or edit tracking links, via Key, Name, Tracking_link, and Tracking comment (enable or disable) options.

Payments category

The Payments category allows you to define the behavior of the capture payment flow, special functionalities for credit card payment methods, the configuration of payment gateways and handlers, and the configuration of enabled multiple capture payment gateways.

Payments > Capture configurations

Payments > Credit Card features

Payments > Payment gateway handlers configuration

Payments > Multiple capture enabled gateways configuration

Field Description
Capture configurations Define the behavior of the payment flow for captures, depending on the payment method selected. Specify the payment methods to be captured after shipment, payment methods that must be requested before shipment happens, payment methods that must be completed before any shipment, the point at which offline payments should be marked as captured, and the status reasons that signify that an order is on hold and is pending capture processing.
Credit card features Define the special functionalities, such as the days to authorization expiration, for credit card payment methods and enable or disable the ability to request the payment capture for custom orders before shipment, enable the full capture of payment for partially shipped orders, and capture payments for a sub-method prior to shipping (you can also set the time frame in days for this feature).
Payment gateway handlers configuration Define the relationship between payment gateways and payment handlers via Key and Value options.
Multiple capture enabled gateways configuration Configure enabled gateways for use with multiple payment captures, via Gateway (payment gateways), Method (payment methods), and Submethod (payment sub-methods) options.