Vin eRetail OMS INTEGRATION

OVERVIEW





Catalogue Creation and Channel Mappings

1. SKU Creation 

Client/Partner can create the SKUs using 2 methods:

  • By Using the SKU Create and Update APIs available at: https://erp.vineretail.com/swagger/#/Products
  • 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.
  • If the Client/Partner is using Vin-CMS for Catalogue management, then Vin-CMS is the source of SKU. Whenever the SKU is created in Vin-CMS, Vin-CMS Push the same to Vin eRetail.



2. Update SKU Channel Mappings 

User can update the SKU Channel Mappings by 4 ways:

  • Configure channel in Vin-eRetail and do the SKU Pull (If that Marketplace supports Product Pull). Once the mappings are pulled in Vin-eRetail. Client/Partner can map the Pulled Mappings with the Vin-eRetail SKU code created by the Partner/Client.
  • Using SKU Channel Linking screen or using the Bulk Upload SKU Channel Link.
  • If the Partner/Client is using Vin-CMS, then the Marketplace/Webshops Channel Mappings will be pushed by Vin-CMS to Vin-eRetail.
  • Using the UpdateChannelSKUDetails API available at: 

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

This API is used to:

  • To map the Vin-eRetail SKUs with the Channel SKUs/Marketplace SKUs and Product Ids of Marketplaces/Webshops.
  • To Mark the Channel link status active or inactive.
  • To Update the Buffer stock of that SKU against that channel.

 

Inventory Update

 

Inventory flow from Partner WMS to Vin-eRetail and from Vin-eRetail to MP/Webshops is described below:

Inventory updates will be sent from Partner WMS system to Vin-eRetail by calling the Update Inventory API.

Process flow for Partner/Client:

  • Partner/Client team will supply the final inventory to the Vinculum system, from where Vin eRetail will publish the same inventory across all the Marketplaces/Webshops linked with that SKU in Vin-eRetail.
  • Inventory displayed at the Marketplace will be visible to the end customers on which orders will be placed.
  • These Orders will be pulled to Vin-eRetail in confirmed status. The inventory present in the system will be allocated to the order and the order status will be changed as allocated.
  • After the allocation, reduction of inventory will happen in Vin-eRetail system, and the remaining inventory will be pushed to Marketplaces.
  • And so, this cycle goes on.
  • Also, in case of returns when any order return is received at warehouse. Depending upon the quality of inventory received in return. Partner/Client team must update/increase the inventory in Vin-eRetail into the respective Bin.
  • If the inventory is Saleable, it should be updated in Good Bin, Else in Bad Bin.
  • Only the inventory present in Good Bin will be sync to Marketplaces/Webshops.
  • API to Update the inventory available at:

https://erp.vineretail.com/swagger/#/Stock/post_RestWS_api_eretail_v2_stock_updateInventory

 

1. Check request Status API 

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 for Partner/Client:

For Inventory API, the request should be made in batches. Example 50 SKUs per batch which Vin-eRetail can process in Async manner.

  • Once the request is successfully submitted, it provides a RequestId in the response.
  • 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



Order Management


Overview of the Order Management process between Partner WMS, Vin eRetail and Marketplaces/Webshops.



1. Order Pull and create 


Vin-eRetail fetches the orders within 5-10 minutes max. from Marketplaces/Webshops etc. These orders can be fetched from Vin-eRetail to Partner WH by calling the Vin-eRetail Order Pull API. This API is used to pull the orders based on: 

1. From Date and To Date of Order Creation and Order Update. 

2. Get the Order Details of any Order. 

3. Get the Orders by Status.


Process flow for Partner/Client:

  • Orders are pulled from the Marketplaces/Webshops to the Vin-eRetail system.
  • Order status can be Pending, Confirmed, Allocated or Cancelled. (this needs to be passed in the order Pull API status Array). More details are available at:

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

  •  Pending orders usually comes in case of Paytm (India) and Amazon (Global), Shopee (SEA) only and for those cases only where the customer have not done the payment. 
  • These Pending payment cases are also possible in Webshops/Frontend platforms like Shopify, Magento, Martjack, Big-commerce, Woocommerce etc depending upon the Requirement of Brand/sellers/Partners on whether they want to Pull the Pending payment orders in VineRetail or not. 
  • We pull these pending orders just to reserve the inventory against them so that the inventory against these orders will not exhaust because of any new order (by the time when the Pending order will be confirmed on Marketplace). 
  • Once the Payment is confirmed on Marketplace, these pending orders will be updated in our system to Allocated with the Updated details. 
  • Order processing for the Pending orders is not allowed. It will only be processed once the status will be changed to confirmed or Allocated. 
  • In case of Flipkart (India), Flipkart provides the Pick after Date/Dispatch after Date in Upcoming orders which means that the orders will be picked/Packed after the Pick after date/Dispatch After date. This date is available in response by the name of processAfterDate.
  • Few Marketplaces/Webshops have the provision of putting the orders on Hold. Example: Nykaa, NykaaFashion, Myntra and Shopee (SEA).
  • If the order status is on Hold. Vin-eRetail Updates the order as HOLD and provides the information of HOLD orders in API response using isonHold Flag. If the isOnHold Flag =1 that means that the order is on Hold on marketplace. Vin-eRetail automatically fetches the UNHOLD status from Marketplace/Webshops and mark the order as UNHOLD. To make the same will be available in the API response, Vin-eRetail update the Update Date of the order so that if the     client/partner passes new fromdate and todate, he/she will get this order in the API response and update the UNHOLD status. 



2. StatusUpdate/Force Order Allocation (Non-Mandatory) 

This API is used to force allocate the orders. 


Process flow for Partner/Client: 

  • When the user wants to allocate the specific order out of the set of confirmed orders for specific SKU having limited inventory in that case this API will be used. 
  • More details available at: 

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



3. Order Processing 

Vin-eRetail have multiple Set of APIs for Order Processing Depending upon the use cases: 

  • Order Have Single Delivery/Shipment. 
  • Order with Multiple Delivery/Shipment. 
  • Order with multiple Box Ids. 


If the Partner/Client have all the orders with 1 Delivery/Shipment, then it is recommended to use the OrderProcess API. The same API can be used to Pick/pack and Ship the Order. API details available at: 

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


3.1 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 Partner/Client:

  • 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. 
  • When An allocated order will be picked and packed physically in the warehouse of Partner/Client then only this API should be called by Partner/Client Team. 
  • 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 the Partner/Client have all the orders with multiple Delivery/Shipment or Shipment with multiple boxes, then it is recommended to use the Order Pick and Pack API to update the order status as Picked and Packed. 


3.2 Order Pick API 

Order Pick API is used to Mark the order status as Picked in Vin-eRetail. Details of the API available at: https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderPick 


Process flow for Partner/Client:

  • 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. 


3.3 Order Pack API


Order Pack API is used to Mark the order status as Packed in Vin-eRetail. Details of the API available at: https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderPack 


Process flow for Partner/Client:

  • 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.


4. 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 for Partner/Client: 

  • OrderInvoice API will be used to fetch the invoice details from Vin-eRetail once the order is picked/packed. The details are available at: 

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

  • This API response includes the tax details, Invoice No. Of Vin-eRetail and the invoice No. of the external system/Marketplace. 



5. Fetch Order Invoice PDF document 

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

Process flow for Partner/Client: 

  • 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 or even in 1-page half of the page have the Shipping label and the remaining half is invoice.
  • Reason behind providing both the Marketplace label and invoice in shippinglabelpdf is that we get both as a single document from Marketplace.
  • There are some cases where the Marketplace provides separate Invoice and Shipping label document like Myntra, Nykaa, NykaaFashion, Amazon Flex etc. Hence, the partner is requested to keep this API call as optional or on config basis and call this API if either the VineRetail invoice document is required or the to fetch the invoices of the Marketplace which provides separate invoice and Shipping label document.
  • In case of Webshop also, this API should be called to fetch the invoice PDF document from Vin-eRetail.
  •  More details are available at:

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



6. Shipping Label PDF document 


Vin-eRetail has ShippingLabelPdf API which is used to fetch shipping label documents from the marketplace. If it is 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) or it provides the PDF label provided by the courier Partners i.e., FEDEX, DHL etc. 


Process flow for Partner/Client:

  • 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.
  • For Marketplaces where invoice and Shipping label are 2 different documents, Vin-eRetail provides the Shipping label document only in this API response.
  • If there is some issue at Marketplace’s end or the order is taking some time to get packed on Marketplace, Marketplace provides some error in the Label API response. Vin-eRetail fetches that error from the Marketplace and provide the same error in this API response. 
  • If the order label is not generated by the Marketplace, Vin-eRetail keeps the delivery/Shipment status as “Pack in Progress” instead of Packed. 



7. Order Shipment and tracking details 

To fetch the order Shipment details i.e., Courier partner Name, AWB No. assigned to the order Partner WH should call the Vin-eRetail Shipment detail API


Process flow for Partner/Client:

  • Once the Partner WH gets the SUCCESS response from the ShippingLabelPdf API, this API should be called to retrieve the Transporter Name, Tracking No and other info related to the Order Shipment.
  • API details available at: 

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



8. Order Process API (Ship Mode) 

Once the order is Shipped or Ready to dispatch at Partner warehouse, Order Process API in Ship Mode must be called. 

Process flow for Partner/Client:

  • Once the order is Packed in Vin-eRetail. This OrderProcess API needs to be called by passing the mode as 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.
  • Details available at: 

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

9. AddToManifest 

AddTOManifest API is used to generate manifest of the Shipped Orders. 


Process flow for Partner/Client: 

  • When the order status is marked as Shipped in Vin-eRetail, Manifest APIs comes into picture to generate manifest of the orders to be handover to the Transporter.
  • This API should be called by passing multiple deliveryNo(s) or Vin-eRetail Shipment Ids depending upon the order and transporter Combination received in Shipment detail API response.
  • Only 1 transporter and the orders of that transporter must be passed in the API request.
  • Once the request is submitted successfully, Vin-eRetail submits the manifest request to transporter if it is Self-Ship order.
  • More details available at: 

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



10. Download Manifest API 

This is used to download the manifest of Transporter wise batches of Orders. 


Process flow for Partner/Client:

  • When the manifest document is generated successfully, Downloadmanifest API will be used to fetch the manifest document from Marketplace or from Transporters (Self-Ship orders) to Vin-eRetail.
  • There are multiple Marketplaces which do not provide any manifest document. For such cases Vin-eRetail Manifest document is used.
  • More details available at: 

https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_downloa dManifest




Order Cancellations (Forward and reverse) 


Overview of the Order Cancellation process between Partner WMS, Vin-eRetail and Marketplaces/Webshops.



1.  Order Cancellation pull from Marketplace/Webshop 

Vin-eRetail fetches the new and Cancelled orders within 5-10 minutes max. from Marketplaces/Webshops etc. These orders can be fetched from Vin-eRetail to Partner WH by calling the Vin-eRetail Order Pull API. 

Process flow for Partner/Client: 

  • Orders are pulled from the Marketplaces/Webshops to the Vin-eRetail system. 
  • To Fetch the Customer cancellations/Marketplace Cancellations, Partner Warehouse must call the order Pull API only by passing the status as Cancelled. 
  • If the Partner/Clients to Fetch new and cancelled orders all together through 1 interface only they can call the Order Pull API by passing the filters as Pending, Confirmed, Allocated and Cancelled.
  • Some Partner WMS have separate interface to fetch the cancelled orders, in this case, partner must call this API by passing the status as Cancelled to fetch the cancelled orders only.
  • More details are available at: 
  • https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderPull



2. Order Cancellation push to Marketplace/Webshop

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


Process flow for Partner/Client:

  • This API is used to mark the order status as Cancelled in Vin-eRetail and Vin-eRetail will further push the cancellation to Marketplaces and mark the order as Seller cancelled or VFS (Vendor failed to Supply). 
  • More details available at: 

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



3. Order Item or Order quantity Cancellation push to Marketplace/Webshop 

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

Process flow for Partner/Client: 

  • This API is used to mark the order item or order item quantities as Cancelled/Closed in VineRetail and Vin-eRetail will further push the cancellation to Marketplaces and mark the order line Item as cancelled. 
  • Partial line cancellation is allowed by limited Marketplace or in Limited Webshops and hence this item cancellation will be pushed to Marketplaces/Webshops if they also support item cancellations.
  • More details available at: 

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





Order Returns and inbound 


Overview of the Order Return and Inbound process between Partner WMS, Vin-eRetail and Marketplaces/Webshops. 



To Fetch the order Returns (Customer Returns and Courier Returns) from Vin-eRetail. Partner WH must call the Vin-eRetail order Return API. This API is used to pull the return orders from Vin-eRetail. 


Process flow for Partner/Client:

  • Marketplace channels are configured in Vin-eRetail. 
  • Based on 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, Partner/Client team will be able to fetch the returns from Vin eRetail.
  • Once the inventory is physically received at the warehouse. Partner/Client team will do the inbound in the warehouse and Partner WMS 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 must sync to Marketplaces or Webshops. 
  • Detail of the API available at: 

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