Order Sync : Woocommerce

When you turn this automation on, Eshopbox will automatically import and fulfill all orders that are not completed. User can select the start date to avoid orders which are already fulfilled outside of Eshopbox / before integrating with Eshopbox

Open

Orders setting will be save in otherDetails column in ie_app_automation_steps_config table against the WooCommerce order stepId.

Open

Step 1 : We will listen to Webhook order event on /webhooklistener/woo/orders/{connectionId}

Order Event Listener : /webhooklistener/woo/orders/{connectionId}

Event Received from Webhook :

Step 2: Upon receiving the event, will extract the connectionId from the URL. Using this connectionId, it will retrieve the corresponding channel data and credentials (consumer_key and consumer_secret) from the cache.

The WooCommerce API credentials (consumer_key and consumer_secret) will be obtained from the cache using the key inputFields_{connectionId}.

Additionally, the channel data associated with the connection will be fetched from the cache using the key channeldata_{connectionId}.

If Channel Data does not exist in Cache will get it from below query and set it in the cache

Step 4 :Now, we will prepare an object as shown below from the data received by executing the above query and send it further in the TaskQueue

Takqueue endpoint : woo/listen/createOrders/{connectionId}

Step 5 : In the task queue, we will listen to the event and checks if order exists in the database. If the order exists, update the order. If the order does not exist, create a new order. In both scenarios, an order event is sent to Pub/Sub. Additionally, the eventSubtype is added to categorize whether the operation is to update an existing order or create a new order.

Step 6 :We will create a list of customerorderNumber but in case of webhook will get single order and in case of cron-based event we can get the list of all orders recieved.

1 .Query to check do orders already exist in DB :

Will divide the orders in two list , Orders which already exist in database and orders which needs to be created.

Step 7 : For the order list which exist in database, check the status of orders and fetch all details from from below query ,

We will retrieve the status of all orders and then check the state of each order one by one. Orders in any state except "packed" will be updated.

We will fetch all the details from the above query and set them in a DTO to compare it with WooCommerce Response in the middlelayer.

Step 8 :

Step 9 : We will iterate through the orders that need to be created in Eshopbox. If an order does not exist in the database will create it in eshopbox.

a. First, we will check if the order meets the criteria for creation in Eshopbox under the "unhold" condition based on the filters applied when enabling the order sync toggle. If the criteria are not met, the order will be created in the "on hold" condition.

b. For the payment method filter, if the method is COD, we will verify if the order satisfies this condition. If it does, the order will be pushed to Pub/Sub with the "on hold" status set to 0. If it does not meet the COD condition, the "on hold" status will be set to 1.

MiddleLayer Listener: /listener/createwoo/order

It will listen to event published on pubsub and on the basis of eventSubType will decide whether the event pulled will follow create order flow or update order flow

Create Order Flow :

WMS create API URL for creating orders in Eshopbox is as follows:

Authorization Token:

We will retrieve the WMS token from the cache using the key WMSTokenCache_key. If the token is not found in the cache, it will be fetched by calling the WorkspaceToken API.

Request Body :

Update Order :

• Cases to update the order if order is not packed

Case 1 : If item is removed from Order on Woocommerce ,cancel it in Eshopbox and also if it is in mentioned status(Unfulfillable, New, Processing, or On Hold), will fetch the data from DTO which is saved after executing the OrderDetails query.

Upon receiving the list of line_item[].id from the WooCommerce response, we will compare them with the lineItemSequenceNumber set in DTO to identify any items that do not exist.

Once we received data from DTO create request body to cancel order-item in Eshopbox

Create Request-Body to Cancel Order in Eshopbox :

Cancel-Order API :

Authorization Token:

We will retrieve the WMS token from the cache using the key WMSTokenCache_key. If the token is not found in the cache, it will be fetched by calling the WorkspaceToken API.

RequestBody :

Case 2: If an item is added to a WooCommerce order, it should also be added to the corresponding Eshopbox order.

Case 3 : In case of customer's details such as phone number, shipping details are updated in the WooCommerce store, the corresponding details in Eshopbox should be updated as well if the order status is Unfulfillable, New, Processing, or On Hold.

Get the data from DTO and compare it with the shipping and contact details received from Woocommerce and update the details which are changed from woocommerce end.

Case 4 : If order status is cancelled in Woocommerce, Cancel it in Eshopbox get order details from DTO for the order to cancel in Eshopbox.

Create Request-Body to Cancel Order in Eshopbox :

Cancel-Order API :

RequestBody :

Eshopbox to Woocommerce Cancel Sync :

We will listen to below cancel event from wms : /eshopbox/cancelevent/listener

Step 1 : For the above event we will check few points-

1. source = workspace

2. eventSubType= updated

3. resource = order_item

If event has above mentioned cases then we will create cancel request body to get the order cancelled on Woocommerce.

Step 2 : Fetch the connectionId from channel_data

After obtaining connectionId from the query result, will retrieve channeldata and Inputfields from cache, if not present in cache will get it from database.

Order Update API on Woocommerce

RequestBody :

Update Order Webhook

Event Listener : /webhooklistener/woo/updateorder/{connectionId}

Event Received from Webhook :

Step 2: Upon receiving the event, will extract the connectionId from the URL. Using this connectionId, it will retrieve the corresponding channel data and credentials (consumer_key and consumer_secret) from the cache.

The WooCommerce API credentials (consumer_key and consumer_secret) will be obtained from the cache using the key inputFields_{connectionId}.

Additionally, the channel data associated with the connection will be fetched from the cache using the key channeldata_{connectionId}.

If Channel Data does not exist in Cache will get it from below query and set it in the cache

Step 3 : Fetch the Reconciliation Connection data from below Query :

Step 4 :Now, we will prepare an object as shown below from the data received by executing the above query and send it further in the TaskQueue

Once the above data is pushed to the task queue, the process will follow the same steps mentioned for webhooks, ultimately pushing the orders to PubSub for further processing.

Order Reconcilation :

Step 1: At first, we will fetch all the active connections on the basis of integration type of WooCommerce.

Step 2: Secondly, we will iterate over the connection id

Using this connectionId, it will retrieve the corresponding channel data and credentials (consumer_key and consumer_secret) from the cache.

The WooCommerce API credentials (consumer_key and consumer_secret) will be obtained from the cache using the key inputFields_{connectionId}.

Additionally, the channel data associated with the connection will be fetched from the cache using the key channeldata_{connectionId}.

If Channel Data does not exist in Cache will get it from below query and set it in the cache

Step 3 : Fetch the Connection data from below Query :

Step 6 : From above Query we can get latestSyncTimeStamp then call the get all Order API of Woocommerce with modified_after filter.

Order API :

Response :

Step 6 : Create the Object with channel- connection data and Order data we received from woocommerce and push it in taskqueue for each connection
TaskQueue Endpoint : /woo/listen/createOrders/{connectionId}

Once the above data is pushed to the task queue, the process will follow the same steps mentioned for webhooks, ultimately pushing the orders to PubSub for further processing.

Updating Tracking Details to Woocommerce :

Step 1 : We will listen for the "shipment packed" event from the WMS in order to fetch tracking details from Eshopbox and update them in WooCommerce.
listener : listen/woo/packed/shipment

Event from WMS :

From the "shipment packed" event, we will retrieve the tracking ID and courier name. These details will be used to update WooCommerce. Additionally, we will fetch the WooCommerce credentials from the cache using the inputFieldskey_{connectionId} cache key.

Woocommerce Update Order API :

RequestBody :

Update completed status on Woocommerce :

Step 1 : We will listen to "shipment delivered" event from the WMS to update the order status on Woocommerce

listener : listen/woo/complete/shipment

Event from WMS :

We will listen for the "shipment delivered" event and update the order status to "completed" on WooCommerce. Additionally, we will retrieve the WooCommerce credentials from the cache using the inputFieldskey_{connectionId} cache key.

Woocommerce Update Order API :

RequestBody :

Open points to discuss -
1.While canceling an order from the Eshopbox workspace, you will have the option to select if the order should be canceled on Woocommerce or not. This option should be available and will work even if you keep the order cancellation sync off. In this case we are listening to a wms event need to ask wms service to send the event on topic only when user agree to get it sync on woocommerce?

We are not able to update any status except pending payment, processing, on-hold, completed on woocommerce, also customer can not edit the product once the order status is in processing state on woocommerce.

Getting below Response when trying to update the status-

Open