Integration between Ongoing WMS and Adobe Commerce (former Magento)
Table of contents
Introduction
Adobe Commerce, former Magento, is one of the world's largest eCommerce platforms. With the integration to Adobe Commerce, a fulfilment provider can connect their customer's platform and seamlessly perform the logistics tasks in Ongoing WMS. An e-retailer can also use Ongoing WMS to develop their picking efficiency by utilizing for example picking carts and automated packing. Note that the integration only works for Magento 2 or newer.Features
Article registry
Ongoing WMS pulls article registry updates from Adobe Commerce to the WMS. Adobe Commerce contains the master data.
Field mapping
| Ongoing WMS field name | Adobe Commerce field name |
|---|---|
| ArticleDefinition ⇒ ArticleNumber | Product ⇒ SKU |
| ArticleDefinition ⇒ ArticleName | Product ⇒ Name (SKU if no name is given) |
| ArticleDefinition ⇒ Unit | Default set to pieces |
| ArticleDefinition ⇒ Product Code | Product ⇒ Id |
| ArticleDefinition ⇒ Weight | Product ⇒ Weight / 1000 |
Custom attributes are not included in the default set up. If you wish to add custom attributes to the integration you will have to provide a list with the attribute codes/names that you want to include in the integration and in which field in Ongoing they should be stored.
Product images (thumbnails) stored in Adobe Commerce as a custom attribute can be fetched from Adobe Commerce by a manually triggered import. By default, it will fetch the image stored in the custom attribute with the code "thumbnail".
Orders
The WMS downloads new and updated orders which are not yet handled. If an order is updated, the change is transferred unless the warehouse workers have started working on it. When orders are fulfilled, the WMS creates a shipment in Adobe Commerce with the delivered quantities and the tracking information.
Optionally, when returns are processed in the WMS, a refund can be created in Adobe Commerce.
Field mapping
| Ongoing WMS field name | Adobe Commerce field name | |
|---|---|---|
| OrderInfo ⇒ GoodsOwnerOrderId | Adobe Commerce order ⇒ entity id | |
| OrderInfo ⇒ GoodsOwnerOrderNumber | Adobe Commerce order ⇒ increment id | |
| OrderInfo ⇒ WayOfDelivery | shipping method | |
| OrderInfo ⇒ DeliveryInstruction | Adobe Commerce order ⇒ shipping description | |
| OrderInfo ⇒ SalesCode | shipping address → first name + last name (if shipping address ⇒ company has value, which is then stored as customer name) | |
| Customer ⇒ Name | shipping address ⇒ company has value or shipping address ⇒ first name + last name | |
| Customer ⇒ Address | shipping address ⇒ street | |
| Customer ⇒ Address2 | shipping address ⇒ street (field 2) | |
| Customer ⇒ PostCode | shipping address ⇒ postcode | |
| Customer ⇒ City | shipping address ⇒ city | |
| Customer ⇒ CountryStateCode | shipping address ⇒ region code | |
| Customer ⇒ CountryCode | shipping address ⇒ country id | |
| Customer ⇒ ExternalCustomerCode | shipping address ⇒ entity id | |
| Customer ⇒ TelePhone | shipping address ⇒ telephone | |
| Customer ⇒ MobilePhone | shipping address ⇒ telephone | |
| Customer ⇒ Email | shipping address⇒ email | |
| Customer ⇒ NotifyByEmail | true if value set in shipping address⇒ email | |
| Customer ⇒ NotifyBySms | true if value set in shipping address ⇒ telephone | |
| Orderline ⇒ ExternalOrderLineCode | Adobe Commerce order →item ⇒ id | |
| Orderline ⇒ ArticleNumber | Adobe Commerce order ⇒ Item ⇒ SKU | |
| Orderline ⇒ NumberOfItems | Adobe Commerce order ⇒ Item ⇒ quantity ordered | |
| Orderline ⇒ LinePrice | Adobe Commerce order ⇒ Item ⇒ base row total incl tax | |
| Orderline ⇒ CurrencyCode | Adobe Commerce order ⇒ currency code |
* = effected by filters or settings. The set value might vary, or it might not be used by default.
Stock values
Stock balance is sent from Ongoing WMS to Adobe Commerce. The WMS should be master data when it comes to available stock. This is especially important if you sell across multiple channels.
MSI (Multi Source Inventory)
If you are using MSI (Multi Source Inventory) in Adobe Commerce, the integration should be setup to update source items in Adobe Commerce to ensure that the stock in Magneto is updated for the correct source. To do this you can select the source when setting up the integration. For this the API user needs access to InventoryAPI::source.
Ingrid Adobe Commerce plugin
The delivery platform Ingrid has a module for Adobe Commerce which is supported by Ongoing WMS. The module handles the conversation towards Ingrid API and rendering of the Delivery Checkout. Find out more information about the plugin on Ingrid's support website.Default Set Up and considerations
-
Which status should orders have to be fetched by the WMS?
Default: processing -
Should invoice be created when order is reported to Adobe Commerce?
Default: no -
Should invoice be activated/captured when order is reported to Adobe Commerce?
Default: no -
Should stock synchronization be activated?
Default: no -
Should customer be notified when order has been sent? This notification is sent from Adobe Commerce so if the look of it is configurable it can be done in Adobe Commerce.
Default: no
Preparations
For us at Ongoing WMS to implement the integration for the specific Adobe Commerce store, we need the following operations to be performed by you:
- To access the Adobe Commerce REST API, Ongoing WMS needs an access token. How to generate an access token is described here. We only need the access token. The other keys can be ignored.
-
Make sure that the provided access token has the following permissions:
- Stores > Settings > Configuration > Inventory Section
- Catalog > Inventory > Products
- Sales
- We need the URL to the shop.
Please see this guide on how to set up an integration between Adobe Commerce and your Ongoing WMS.