Ongoing WMS and Webshipper order integration
Table of contents
Introduction
Ongoing has developed an integration with the Danish delivery management system Webshipper which can sync orders from Webshipper and create them in Ongoing WMS.
The integration works well together with the Ongoing WMS workflow. It uses the Webshipper API. Most functions run every 15 minutes, but some functions are based on user actions.
Scheduled functions
Some functions in the integration run on a schedule. Orders are synced automatically from Webshipper to Ongoing WMS.
Orders
Orders are read automatically from Webshipper to Ongoing WMS.
Field mapping
| Ongoing WMS field name | Webshipper field name |
|---|---|
| Order info ⇒ Order number | Order ⇒ id |
| Order info ⇒ Goods owner order id | Order ⇒ Visible reference |
| Order info ⇒ Customs currency | Order ⇒ Currency |
| Order info ⇒ Order remark | Order ⇒ External comment |
| Order info ⇒ Warehouse instruction | Order ⇒ Internal comment |
| Customer ⇒ Address | Delivery address ⇒ Address1 |
| Customer ⇒ Address2 | Delivery address ⇒ Address2 |
| Customer ⇒ City | Delivery address ⇒ City |
| Customer ⇒ Country code | Delivery address ⇒ Country code |
| Customer ⇒ Country state code | Delivery address ⇒ State |
| Customer ⇒ Email | Delivery address ⇒ Email |
| Customer ⇒ Name | Delivery address ⇒ Att. contact or Company name |
| Customer ⇒ Mobile | Delivery address ⇒ Phone |
| Customer ⇒ Name | Delivery address ⇒ Name |
| Customer ⇒ Post code | Delivery address ⇒ Zip |
| Customer ⇒ VAT number | Delivery address ⇒ Vat number |
| Order line ⇒ Article number | Order line ⇒ Sku |
| Order line ⇒ Article name | Order line ⇒ Description |
| Order line ⇒ Number of items | Order line ⇒ Quantity |
| Order line ⇒ Discount | Order line ⇒ Discount value |
| Order line ⇒ Should be picked? | Order line ⇒ Is virtual (pick if line is virtual) |
| Order line ⇒ Customs value | Order line ⇒ Quantity * Discounted unit price |
Filters
By default, any orders matching the following filter in Webshipper are synced to Ongoing WMS. Note that if the order exists in Ongoing WMS, it will only be updated if the status of the order in Ongoing WMS allows it to be updated!
| Webshipper field name | Default filter |
|---|---|
| Order ⇒ Status | Pending |
| Order ⇒ Updated at | Later than the last time the integration synced |
| Order ⇒ Order channel id | Provided on setup |
Return orders
The integration can be setup to automatically read return orders from Webshipper to Ongoing WMS. This is done by activating the return order module on the page where you can modify the integration settings in Ongoing WMS.
Field mapping
| Ongoing WMS field name | Webshipper field name |
|---|---|
| Return order info ⇒ Order number | Return order ⇒ Id |
| Return order info ⇒ Order Id | Determined using the order Id found on the first return order line |
| Return order line ⇒ Article number | Return order line ⇒ Sku |
| Return order line ⇒ Number of items | Return order line ⇒ Quantity |
| Return order line ⇒ Return cause ⇒ Code | Return order line ⇒ Cause ⇒ Id |
| Return order line ⇒ Return cause ⇒ Name | Return order line ⇒ Cause ⇒ Name |
| Return order line ⇒ External order line code | Return order line ⇒ Order line Id |
Filters
By default, any return orders and return order lines matching the following filter in Webshipper are synced to Ongoing WMS. Note that if the return order already exists in Ongoing WMS no updates will be made!
| Webshipper field name | Default filter |
|---|---|
| Return order ⇒ Status | Sent |
| Return order ⇒ Line ⇒ Status | Pending |
Functions based on user actions
Outbound deliveries
When an order has been set to status Sent or Collected in Ongoing WMS a call is sent to the Webshipper API to create a shipment for the order. This will also update status of the order, and the status of each order line. If all order lines are picked the status of the order will be updated to dispatched, and the status for each order line will be updated to dispatched. If only some order lines are picked the order status will be updated to partly_dispatched, and the status for each picked order line will be updated.
Any eventually created labels for the shipment will be downloaded to Ongoing WMS, which can be setup to automatically print the labels using the Ongoing Printer Service..
Note that at most one shipment can be created per order.
Return order deliveries
When the status on a return order in Ongoing WMS is set to a status stating that the return has been handled a call is sent to the Webshipper API to update the status in Webshipper to Processed.
Getting started
To configure this integration Ongoing WMS will need the account name of the Webshipper account, and an API token. The account name can be found in the URL when you use Webshipper, where the URL will look like https://account_name.webshipper.io. The API token is generated inside Webshipper by navigating to Settings -> Access and tokens, and then using the button Create API token. This integration needs the following scopes:
- write_orders
- read_orders
- write_shipments
- read_shipments
- read_order_channels