Product Sync : Woo-commerce

Step 1: Enable Auto-Import in Eshopbox

When a seller toggle on the auto-import of products , and configure the below settings-

• Map the tax classes of Woocommerce with those of Eshopbox. You can also select the default tax code for your products. If the tax code is not the same for all products, then leave it blank.

  • Open

    

    The mapped tax classes will be saved in DB.

• The HSN code is not a default field saved with the WooCommerce product catalog. If seller has selected the HSN code attribute while creating a product then will mention the same here. If there are no attributes, can select the default HSN code of the products. If the HSN code is not the same for all products, then leave it blank
  
  
  

  Open

  

Once the configurations are saved will register webhook for products.

Create Webhook URL:

Request Body:

Whenever event will be triggered on the delivery URL:

• The Woocommerce catalog comprises four types of products, out of which simple, variable and bundle products are synced in the Eshopbox catalog. The products in Woocommerce have three publishing status, namely Draft, Pending Review, and Published. All products, regardless of their status, will be pulled into the catalog.

   

• We will log the response received and push it in taskqueue, their will be a taskqueue listener in default service which will process and pass it to pubsub topic.

  • “listener/woocommerceproducts”

The delivery URL : https://default-dot-esb-integration-engine-staging.appspot.com/_ah/api/esb/v3/woocommerce-productwebhook/connectionId
has parameter connectionId actual identifier of the connection for which you want to receive product import data.

• We will get the connectionId from the endpoint to fetch the authentication token details and also against which account, we have to create a product.

Will execute the below query to fetch the connections details againts which we have received an event

for that connection run the below query to fetch the channel Data

• Fetches channel data from cache, if not in cache it fetches data from Database.

• .String cacheKey = connection_channeldata + connectionId;

Channel connection map object:

We will push the channel connection data in the middlelayer along with product details received from webhook event and create products in WMS.

Before creating product in Eshopbox we have to check that if attributes.variation= true and variation list is not empty then call the API for each variations.

Variant cases:

If in products response we get key type=”variable” and also “attributes.variations” is “true” then, iterate through each variations and fetch the product details for each

Iterate through each variationId and call API for each variantId

variations API for each variationId

Response

In this case for every variant will get unique SKU accordingly will create the product in Eshopbox.

If the SKU is blank, Eshopbox will use the Woocommerce unique ID of the product with the prefix "woo-" as the SKU.

To Create or Update Product -

Step 1 : Check if product exist or not in Eshopbox based on “active” inventoryItem Id from listing table and if it exist then update the Product else Create new Product in Eshopbox.

We will pass the list of itemId to check the status of itemId which we receive

Case 1 : If record exist from the above query, then update the Product in Eshopbox.

Update Product API:

Request Body:

• In case dimensions are updated in Woocommerce, the corresponding dimensions will be updated in Eshopbox, if Weight and dimensions are not verified.

• According to Product and Inventory Team,Dimension and product Images are not update when ProductWeightVerification status is in inverification status other then this user is allowed to change the Dimension of the product

• Case 2 i) : Else, check product exist in Eshopbox or not,

  • https://{workspace}.myeshopbox.com/product-engine/api/v1/products

We will save the mark available response body and when will create the products will together mark it as avaialble.

ii) : If product does not exist in Eshopbox create product.

Create a Product:

Mapping for creating product in WMS

Similarly if there are updates in fields in Eshopbox workspace, corresponding product should be updated in Woocommerce catalog then will update it in Woocommerce whenever will receieve event from of update product from WMS by the productId will update it in woocommerce also.

Update Product API in woocommerce

In request body will mention the fields which need to be updated in woocommerce

Response

Delete Product if it is deleted in Woocommerce Mark it unavailble in Eshopbox.

In case we recieved event for delete product through webhook on delete delivery url.

Response:

We will pass the data to taskqueue and fetch all the connectionId with channeldata details and pass it in pubsub and delete/mark unavailable the product on Eshopbox.

In case of product is deleted ,mark it as unavailable by calling unavailability API.

CRON to Create Product :

We pass modified_after date in parameter to sync the product if their is any update in that, which will be the latestsynctimestamp in Eshopbox.

Step 1: Cron Endpoint /_ah/api/esb/v1/woocommerce/productupdate/sync

Use-case: It fetches the active connectionIds:

Fetch the Connections data for all connectionId’s where stepId for product Update Sync is on.Push the data to taskqueue.

Step 3:TaskQueue Listener: /_ah/api/esb/v1/productupdate/cron/listener

For Active connectionId it fetches their respective channel data

for that connection run the below query to fetch the channel Data

• Fetches channel data from cache, if not in cache it fetches data from Database.

• .String cacheKey = connection_channeldata + connectionId;

Push the connectionchannel data in the Taskqueue

Use-case: It listens and prepares woocommerce product update Sync url to fetch product update Details :

Woocommerce URL:

Response :

Pagination will be applied per page will fetch 10 response until we do not received empty response.

Before creating product in Eshopbox we have to check that if attributes.variation= true and variation list is not empty then call the API for each variations.

Variant cases:

If in products response we get key type=”variable” and also “attributes.variations” is “true” then, iterate through each variations and fetch the product details for each

Iterate through each variationId and call API for each variantId

variations API for each variationId

To Create or Update Product -

Step 1 : Check if product exist or not in Eshopbox based on “active” inventoryItem Id from listing table and if it exist then update the Product else Create new Product in Eshopbox.

We will pass the list of itemId to check the status of itemId which we receive

Case 1 : if record exist from the above query, then update the Product in Eshopbox.

Update Product API:

Request Body:

Case

1. Will get sku from listing table for respective itemId which is ESIN in Workspace.

2. Will call Get product API with esin.

Response :

If weight_dimension_status = inverification/verified in two status we can not update the weight dimension in such cases will be notified of such a mismatch in the product availability section of dimension

Case 2 : Else,

• Case 2 i) : Else, check product exist in Eshopbox or not,

  • https://{workspace}.myeshopbox.com/product-engine/api/v1/products

We will save the mark available response body and when will create the products will together mark it as avaialble.

ii) : If product does not exist in Eshopbox create product.

Create a Product:

Mapping for creating product in WMS

In case of Delete Cron will mark the product Unavailable in Eshopbox by calling unavailable API.

If grouped products are to be fetched, in case of grouped product :

Grouped Product -

We have option of grouped Product in Woocommerce , In which seller can grouped 2-3 products together and create a product.

when we create order the behvaiour of grouped products -

We get line_items in response where we do not get the individual products details.
But if we will be fetching the Grouped Products in Eshopbox then,

API to fetch Grouped Product -

If type = grouped
Response :

If type = grouped , then will check for key “grouped_products“ where will get the products which are grouped.

Product API :

Will call the product API of Woocommerce for each product_id listed in grouped_products ,fetch the product details and will check is it available in Eshopbox if not create the product in Eshopbox.