eRetail-POS Integration (Using POS WMS)


Overview 

At present there are two models for this integration.


A. Partial Integration

In this scenario, Orders flow from eRetail to POS after allocation and pick, pack activities are performed on the POS. Shipping of orders done in eRetail. Example: Logic POS



B. Complete Integration

In this scenario, eRetail is used as an Order Management System. Orders flow from eRetail to POS after allocation. All warehouse activities related to orders such as pick, pack, ship, etc. is done at the POS end and the same is posted to eRetail via standard eRetail APIs. Example: Wondersoft POS.

A. Partial Integration

In this integration the below touchpoints are required:

1. SKU Creation

Client/Partner can create the SKUs using 2 methods:

  • Using the SKU Create and SKU Update API, Client/Partner can push the catalogue/SKUs to
     Vin-eRetail. (API credentials will be shared separately).
  • If the Partner/Client wants to manage the SKUs manually, He/she can create the SKUs in Vin-
     eRetail using the SKU create/Edit screen or using SKU Import Bulk upload file.

Process flow:

  • Any new SKU created, or existing SKU updated at the POS side will flow to eRetail via this API.
  • More details available at:

https://erp.vineretail.com/swagger/#/Products/post_RestWS_api_eretail_v1_sku_create

 

2. Inventory Update

Update Inventory API is used to updating the inventory. That means, for pushing the inventory into the system and adjusting the stock. Inventory updates will be sent from Partner POS to Vin-eRetail by calling the Update Inventory API. API to Update the inventory available at:

 Process flow:

  • Any change in inventory at the POS will be sent to eRetail.
  • If the inventory is Saleable, it should be updated in Good Bin, Else in Bad Bin.
  • More details available at:

https://erp.vineretail.com/swagger/#/Stock/post RestWS api eretail v2 stock updateInventory

 

3. Check Request Status

This API is used to fetch the status of the request (If the API call is made with a batch of more than 1 record).

Process flow:

  • When API request for create sku or inventory update is made with a batch of more than 1 record, the response provided from the api will provide a RequestId. Using this RequestId, this "check request status" API should be called to fetch the final status of the request. 
  • More details available at: 

https://erp.vineretail.com/swagger/#/Common/post_RestWS_api_eretail_v1_common_checkRequestStatus

 

4. Order Process API (Pack Mode)

Order Process API is used to process the orders by picking, packing and shipping. That means when an allocated order needs to be processed, this API comes into the picture.

Process flow:

  • For the order to process, order must have the status as Allocated.
  • If the order is available in confirmed status and inventory will come soon. Based on inventory availability, Update inventory API needs to be called. Once the inventory is available then the orders will be Auto Allocated in Vin-eRetail. Else this order will remain stuck in confirmed status and SLA of the order will be breached. Because of this penalty from the Marketplace will be incurred.
  • This API should be called by Client Team to mark the order status as packed into the vin eretail system.
  • On calling the Order Process API, Vin-eRetail calls the Marketplace API (API of that channel) to update the status as packed on Marketplace and to fetch the Shipping Labels and invoice from Marketplace.
  • If any error occurred from the Marketplace, the same will be reflected in response of this API
  • More details available at: 

https://erp.vineretail.com/swagger/#/Orders/post RestWS api eretail v1 order orderProcess

 

5. Order Pick API

Order Pick API is used to Mark the order status as Picked in Vin-eRetail.

Process flow:

  • For the order to Pick, order must have the status as Allocated.
  • If the order is available in confirmed status and inventory will come soon. Based on inventory availability, Update inventory API needs to be called. Once the inventory is available then the orders will be Auto Allocated in Vin-eRetail. Else this order will remain stuck in confirmed status.
  • When An allocated order will be picked physically in the warehouse of Partner/Client then only this API should be called by Partner/Client System.
  • On calling the Order Pick API, Vin-eRetail Update the order status as Picked in System.
  • For Multi box Shipment, Client must pass the Box Ids along with the Item details added to that box.
  • More details available at: 

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderPick

 

6. Order Pack API

Order Pick API is used to Mark the order status as Packed in Vin-eRetail.

Process flow:

  • For the order to Pack, order must have the status as Picked.
  • When the order is packed physically in the warehouse of Partner/Client then only this API should be called by Partner/Client System.
  • If It is a Marketplace order having the Ship by Seller/Self Ship Mode, then client must supply the transporter name using which he wants to Pack the order.
  • Once the Request is received at Vin-eRetail system. Depending upon the Transporter Name/Logistics partner Name/Aggregator passed in request, Vin-eRetail calls the API (depending upon the mode whether it is an online transporter of Offline transporter) of that transporter and update the AWB in that order.
  • Partner/Client can also supply the AWB No at the time of order Pack if he/she do not want to use the Transporter integration.
  • On calling the Order Pick API, Vin-eRetail Update the order status as Picked in System.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderPack

 

7. Fetch Order Invoice

OrderInvoice API is used to fetch the order invoice details from Vin-eRetail. That includes the tax details, Invoice No. Of Vin-eRetail and the invoice No. of the external system/Marketplace.

Process flow:

  • OrderInvoice API will be used to fetch the invoice details from Vin-eRetail once the order is picked/packed.
  • This API response includes the tax details, Invoice No. Of Vin-eRetail and the invoice No. of the external system/Marketplace
  •  More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v2_order_orderInvoice


 

B. Complete Integration

In this integration the below touchpoints are required:

1. SKU Creation

Client/Partner can create the SKUs using 2 methods:

  • Using the SKU Create and SKU Update API, Client/Partner can push the catalogue/SKUs to
     Vin-eRetail. (API credentials will be shared separately).
  • If the Partner/Client wants to manage the SKUs manually, He/she can create the SKUs in Vin-
     eRetail using the SKU create/Edit screen or using SKU Import Bulk upload file.

Process flow:

  • Any new SKU created, or existing SKU updated at the POS side will flow to eRetail via this API.
  • More details available at:

https://erp.vineretail.com/swagger/#/Products/post_RestWS_api_eretail_v1_sku_create

 

2. Inventory Update

Update Inventory API is used to updating the inventory. That means, for pushing the inventory into the system and adjusting the stock. Inventory updates will be sent from Partner POS to Vin-eRetail by calling the Update Inventory API. API to Update the inventory available at:

 

Process flow:

  • Any change in inventory at the POS will be sent to eRetail.

  • If the inventory is Saleable, it should be updated in Good Bin, Else in Bad Bin.
  • More details available at:

https://erp.vineretail.com/swagger/#/Stock/post RestWS api eretail v2 stock updateInventory

 

3. Check Request Status

This API is used to fetch the status of the request (If the API call is made with a batch of more than 1 record).

Process flow:

 

4. Order Process API (Pack Mode)

Order Process API is used to process the orders by picking, packing and shipping. That means, when an allocated order needs to be processed, this API comes into the picture.

Process flow:

  • For the order to process, order must have the status as Allocated.
  • If the order is available in confirmed status and inventory will come soon. Based on inventory availability, Update inventory API needs to be called. Once the inventory is available then the orders will be Auto Allocated in Vin-eRetail. Else this order will remain stuck in confirmed status and SLA of the order will be breached. Because of this penalty from the Marketplace will be incurred.
  • This API should be called by Client Team to mark the order status as packed into the vin eretail system.
  • On calling the Order Process API, Vin-eRetail calls the Marketplace API (API of that channel) to update the status as packed on Marketplace and to fetch the Shipping Labels and invoice from Marketplace.
  • If any error occurred from the Marketplace, the same will be reflected in response of this API.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderProcess

 

5. Order Pick API

Order Pick API is used to Mark the order status as Picked in Vin-eRetail.

Process flow:

  • For the order to Pick, order must have the status as Allocated.
  • If the order is available in confirmed status and inventory will come soon. Based on inventory availability, Update inventory API needs to be called. Once the inventory is available then the orders will be Auto Allocated in Vin-eRetail. Else this order will remain stuck in confirmed status.
  • When An allocated order will be picked physically in the warehouse of Partner/Client then only this API should be called by Partner/Client System.
  • On calling the Order Pick API, Vin-eRetail Update the order status as Picked in System.
  • For Multi box Shipment, Client must pass the Box Ids along with the Item details added to that box. 
  • More details available at: 

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderPick

 

6. Order Pack API

Order Pick API is used to Mark the order status as Packed in Vin-eRetail.

Process flow:

  • For the order to Pack, order must have the status as Picked.
  • When the order is packed physically in the warehouse of Partner/Client then only this API should be called by Partner/Client System.
  • If It is a Marketplace order having the Ship by Seller/Self Ship Mode, then client must supply the transporter name using which he wants to Pack the order. 
  • Once the Request is received at Vin-eRetail system. Depending upon the Transporter Name/Logistics partner Name/Aggregator passed in request, Vin-eRetail calls the API (depending upon the mode whether it is an online transporter of Offline transporter) of that transporter and update the AWB in that order.
  • Partner/Client can also supply the AWB No at the time of order Pack if he/she do not want to use the Transporter integration.
  • On calling the Order Pick API, Vin-eRetail Update the order status as Picked in System.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderPack

 

7. OrderStatus API

OrderStatus API is used to fetch the order status from Vin-eRetail (This API also indicates the order status of Marketplace).

Process flow:

  • OrderStatus API is used to check the order and line level status of the order in Vin-eRetail.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v2_order_status

 

8. OrderInvoice API

OrderInvoice API is used to fetch the order invoice details from Vin-eRetail. That includes the tax details, InvoiceNo. Of Vin-eRetail and the invoice No. of the external system/Marketplace.

Process flow:

  • OrderInvoice API will be used to fetch the invoice details from Vin-eRetail once the order is picked/packed.
  •  There is no Picked status, the order will directly updated from Allocated to Packed.
  • This API response includes the tax details, Invoice No. Of Vin-eRetail and the invoice No. of the external system/Marketplace.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v2_order_orderInvoice

 

9.Order Invoicepdf API

This API is used to get the Vin-eRetail Invoice no and order invoice pdf document.

Process flow:

  • Ideally for most of the Marketplaces, we provide the invoice and Shipping label both in ShippingLabelPdf in Merged format where 1 page contains the invoice and another page contains the Shipping Label.
  • Reason behind providing both the Marketplace label and invoice in shippinglabelpdf is that we get both as a single document from Marketplace.
  • So, If the Vin-eRetail Invoice is required that this API should be integrated else not.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderinvoicepdf

 

10. Shipmentdetail API

This API is used for getting order shipment details such as AWB Number, Courier details assigned to that order by the Marketplace or Vin-eRetail.

Process flow:

  • This API will be used for getting order shipment details such as AWB Number, Courier details.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_shipmentDetail

 

11. GetShippingLabelPdf API

Shipping Label API will be used to fetch shipping label documents from the marketplace. If it’s not the order of Marketplace, then Vin-eRetail’s shipping label will be generated (having the tracking No. of the 3PL using which this order is packed in Vin-eRetail)

Process flow:

  • Ideally for most of the Marketplaces, we provide the invoice and Shipping label both in ShippingLabelPdf in Merged format where 1 page contains the invoice and another page contains the Shipping Label.
  • Reason behind providing both the Marketplace label and invoice in shippinglabelpdf is that we get both as a single document from Marketplace.
  • So using a single API, Client Team will get both the shipping label and invoice of Marketplaces.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_getShippingLabelPdf

 

12. Order Process API (Ship Mode)

Order Process API is used to process the orders by picking, packing and shipping. That means, when an allocated order needs to be processed, this API comes into the picture.

Process flow:

  • Once the order is Packed in Vin-eRetail. This OrderProcess API needs to be called by passing the mode as SHIP.
  • This API needs to be called only the order is ready to ship.
  • By Calling this API, the order status will be updated as Shipped in Vin-eRetail.
  • At the very same time, pull the Manifest No. in Vin-eRetail.
  • If any error occurred from Marketplace end, the same will be reflected in the API response.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderProcess

 

13. AddToManifest API

AddTOManifest API is used to generate manifest of the shipped order

Process flow:

  • When the order is shipped and ready to be handed over, Manifest APIs comes into picture to generate manifest of the shipped orders to handover to the Transporter.
  • More details available at: 

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_addToManifest

 

14. Download Manifest API

Download Manifest API is used to download the manifest of the order

Process flow:

  • When the manifest is generated, Downloadmanifest API will be used to download the manifest document pulled from Marketplace to Vin-eRetail.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_downloadManifest

 

15. Order Cancel API

This API is used to mark the orders as cancelled in Vin-eRetail system.

Process flow:

  • This API is used to mark the order status as Cancelled in Vin-eRetail.
  • This API has no relation with the Marketplace integration cancellation. (For the Marketplace cancellation cases, the orders will be automatically marked as cancelled in Vin-eRetail).
  • Cancel orders details can be fetched using OrderPull API only by passing the status as Cancelled.
  • Orders cannot be marked as cancelled after the packed status.
  • More details available at:

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_cancel

 

16. Order Cancel Line Level API

This API is used to mark the order line item as cancelled in Vin-eRetail system.

Process flow:

  • This API is used to mark the order line item status as Cancelled in Vin-eRetail.
  • This API has no relation with the Marketplace integration cancellation. (For the Marketplace cancellation cases, the orders will be automatically marked as cancelled in Vin-eRetail).
  • More details available at: 

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_cancelLineLevel

 

17. OrderReturn API

This API is used to pull the return orders from Vin-eRetail.

Process flow:

  • Marketplace channels are configured in Vin-eRetail.
  • On the basis of Return pull enable flag on those channels, the returns will be pulled from the Marketplaces and created in Vin-eRetail at a frequency of 5-10 minutes.
  • Using the OrderReturn API, client team will be able to fetch the returns from Vin-eRetail.
  • Once the inventory is physically received at the warehouse. Client team will call the Update Inventory API and update/increase the inventory in the respective Bin i.e. good or Bad.
  • Only that inventory needs to be updated in Good Bin which is saleable and has to sync to Marketplaces.
  • More details available at:

https://erp.vineretail.com/swagger/#/Order_Returns/post_RestWS_api_eretail_v1_order_orderreturn

 

18. Create Order Return API

This API is used to create a return order in Vin-eRetail.

Process flow:

  • This API is used to create a return order in Vin-eRetail.
  • More details available at:

https://erp.vineretail.com/swagger/#/Order_Returns/post_RestWS_api_eretail_v1_order_return