Integration between Ongoing WMS and WooCommerce
Table of contents
Introduction
WooCommerce is the world’s largest e-commerce platform. WooCommerce has a REST-based API which covers most of the information available in the platform. Integrating your WooCommerce-based shop with your third-party logistics provider via Ongoing WMS provides you with a seamless logistics experience.
When an order is placed by your customer it is automatically transferred to the WMS for the warehouse workers to immediately start picking and packing it. When a shipment has been booked, the WMS marks the order as completed in WooCommerce and posts the tracking number.
Ongoing WMS continuously pulls information about the products from WooCommerce and the available stock in the warehouse is continuously pushed to WooCommerce. The integration between Ongoing WMS and WooCommerce eliminates the manual and repetitive task of keeping two registers in sync and automates the information change in the logistics process.
Features
Article registry
Ongoing WMS pulls article registry updates from WooCommerce to the WMS. WooCommerce contains the master data. Both products and variants in WooCommerce will be mapped to articles in Ongoing WMS. Virtual products/variant are by default not synchronized to Ongoing WMS, but the synchronization of them can be activated.
Field mapping
| Ongoing WMS | WooCommerce | |
|---|---|---|
| field name | field name for products | field name for variants |
| ArticleDefinition ⇒ ArticleNumber | Product ⇒ SKU | Variant ⇒ SKU |
| ArticleDefinition ⇒ ArticleName | Product ⇒ Title | Product ⇒ Title + Variant ⇒ Name |
| ArticleDefinition ⇒ ProductCode | Product ⇒ Id | Variant ⇒ Id |
| ArticleDefinition ⇒ Unit | Default set to 'st' | Default set to 'st' |
| ArticleDefinition ⇒ Categories | Product ⇒ Categories* | |
| ArticleDefinition ⇒ IsStockArticle* | Product ⇒ Virtual | Variant ⇒ Virtual |
* = Synchronization is turned off by default.
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 marks the order as completed in WooCommerce and tracking numbers are transferred. If the app Shipment Tracking is used in WooCommerce it is possible to setup the integration to use the extended functionality accompanied with that, otherwise the tracking information will be reported using order notes.
Field mapping
| Ongoing WMS field name | WooCommerce field name |
|---|---|
| OrderInfo ⇒ GoodsOwnerOrderId | Order ⇒ Id |
| OrderInfo ⇒ GoodsOwnerOrderNumber | Order ⇒ Order number |
| OrderInfo ⇒ DeliveryDate | Order ⇒ Created st |
| OrderInfo ⇒ WayOfDelivery | Order ⇒ Shipping method** |
| OrderInfo ⇒ WayOfDeliveryType ⇒ Code | Order ⇒ (first) Shipping lines ⇒ Shipping method ⇒ Id |
| OrderInfo ⇒ WayOfDeliveryType ⇒ Name | Order ⇒ (first) Shipping lines ⇒ Shipping method ⇒ Title |
| OrderInfo ⇒ OrderRemark | Order ⇒ Note |
| OrderInfo ⇒ SalesCode | Order ⇒ Shipping address ⇒ First name + Last name (only set when company name set on order, otherwised first and last name is stored at customer name) |
| OrderInfo ⇒ OrderNotification ⇒ MobilePhone | order ⇒ Billing address ⇒ Phone |
| OrderInfo ⇒ OrderNotification ⇒ Telephone | order ⇒ Billing address ⇒ Phone |
| OrderInfo ⇒ OrderNotification ⇒ Email | order ⇒ Customer (if set else billing address) ⇒ Email |
| OrderInfo ⇒ OrderNotification ⇒ NotifyBySms | True* |
| OrderInfo ⇒ OrderNotification ⇒ NotifyByEmail | True* |
| Orderline ⇒ ExternalOrderLineCode | Order ⇒ Line Item ⇒ Id |
| Orderline ⇒ ArticleNumber | Order ⇒ Line Item ⇒ SKU |
| Orderline ⇒ ArticleName | Order ⇒ Line Item ⇒ Name |
| Orderline ⇒ NumberOfItems | Order ⇒ Line Item ⇒ Quantity |
| Orderline ⇒ CustomerLinePrice | Order ⇒ Line Item ⇒ Total |
| Orderline ⇒ LinePrice | Order ⇒ Line Item ⇒ Price |
| Orderline ⇒ CurrencyCode | Order ⇒ Currency |
| Customer ⇒ Name | Order ⇒ Shipping address ⇒ Company (if set, otherwise first name + last name) |
| Customer ⇒ Address | Order ⇒ Shipping address ⇒ Address1 |
| Customer ⇒ Address2 | Order ⇒ Shipping address ⇒ Address2 |
| Customer ⇒ PostCode | Order ⇒ Shipping address ⇒ Postcode |
| Customer ⇒ City | Order ⇒ Shipping address ⇒ City |
| Customer ⇒ CountryCode | Order ⇒ Shipping address ⇒ Country |
| Customer ⇒ Email | Order ⇒ Customer (if set else billing address) ⇒ Email |
| Customer ⇒ MobilePhone | Order ⇒ Billing address ⇒ Phone |
| Customer ⇒ Invoice address ⇒ Name | Order ⇒ Billing address ⇒ Company (if set, otherwise first name + last name) |
| Customer ⇒ Invoice address ⇒ Address | Order ⇒ Billing address ⇒ Address1 |
| Customer ⇒ Invoice address ⇒ Address2 | Order ⇒ Billing address ⇒ Address2 |
| Customer ⇒ Invoice address ⇒ PostCode | Order ⇒ Billing address ⇒ Postcode |
| Customer ⇒ Invoice address ⇒ City | Order ⇒ Billing address ⇒ City |
| Customer ⇒ Invoice address ⇒ CountryCode | Order ⇒ Billing address ⇒ Country |
| Customer ⇒ Invoice address ⇒ Email | Order ⇒ Billing address ⇒ Email |
| Customer ⇒ Invoice address ⇒ MobilePhone | Order ⇒ Billing address ⇒ Phone |
* = effected by filters or settings. The set value might vary, or it might not be used by default.
** = Only available in API verison 3
Stock values
Stock balance is sent from Ongoing WMS to WooCommerce.
Shipment tracking app
Ongoing WMS supports the WooCommerce Shipment tracking app for improved handling of tracking numbers and links. The app lets you add shipment tracking information to your orders and provides your customers with easy access to the shipment tracking through emails, the order tracking page, and the order view in their account section.
You can enable support for the app in the Administration ⇒ Integrations page in Ongoing WMS.
Default settings and considerations
The integration provides default settings which are suitable in most cases. However, there are some possibilities for customization.
-
Synchronization interval.
Default: Every 15 minutes. It is usually a suitable balance between responsiveness and band-width usage. -
Which version of WooCommerce is your customer using?
Preferably version 3.0.x or later. Support exists for 2.2.x or later. -
Is HTTPS used?
Default: Yes (strongly recommended).
If not, we use oAuth. Which hash function is used?
Default: SHA256. -
Are any plugins used?
The use of plugins might complicate the setup of the integration. -
Which status should a product have in WooCommerce for it to be transferred to the WMS?
Default: "Publish". -
Do you have any variant of your articles without unique article numbers? For example, colors, sizes, packaging.
Default: No. -
Are virtual products used in WooCommerce?
The use of virtual products is not included in the basic integration and might complicate the setup of the integration. -
Should the available stock be synchronized from the WMS to WoCommerce?
Default: Yes. -
Which status should an order have in WooCommerce for it to be transferred to the WMS?
Default: "Processing". -
Should fulfilled orders be automatically set as completed and tracking numbers sent?
Default: Yes. If yes, answer the following questions:-
When during the order handing process should the order be reported as completed in WooCommerce?
Default: When a tracking number has been received from the shipping platform (e.g., nShift Delivery). -
Should tracking numbers or tracking links be transferred to WooCommerce?
Default: Yes.
-
When during the order handing process should the order be reported as completed in WooCommerce?
Preparations
For us at Ongoing WMS to implement the integration for the specific WooCommerce store we need the following operations to be performed by you:
Activate the REST API
If it is not yet activated please follow the instructions on the following website: https://docs.woocommerce.com/document/woocommerce-rest-api/ You do not need to enable the legacy REST API.
Generate API keys
We require both "ConsumerKey" and "ConsumerSecret". Follow the instructions in the link above to get the keys for the API.
The URL to the API of the web shop
Generally something like: https://mynewwebshop.com/wp-json/wc/v2/. When setting up the integration at the integration page in Ongoing WMS, you should set the URL to, in this example, https://mynewwebshop.com/
Please see this guide on how to set up an integration between WooCommerce and your Ongoing WMS.