Vin eRetail Custom Website Integration

 Guide



SKU Creation and Channel Mappings


1. SKU Creation


Client/Partner can create the SKUs using 2 methods:

  1. By Using the SKU Create and Update APIs available at: https://erp.vineretail.com/swagger/#/Products
  2. Using the SKU Create and SKU Update API, Client/Partner can push the catalogue/SKUs from Website to Vin-eRetail. (API credentials will be shared separately).
  3. 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 the SKU Import Bulk upload file.
  4. 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

Users can also Update the SKU Channel Mappings in 4 ways:

  1. Configure channel in Vin-eRetail and update the mappings of SKUs (If multiple website SKUs are linked with 1 Client SKU in Vin-eRetail) else this API is not required.
  2. Client can also use SKU Channel Linking screen or using the Bulk Upload SKU Channel Link to manually create/Update Channel Mappings.
  3. If the Partner/Client is using Vin-CMS, then the Marketplace/Webshops Channel Mappings will be pushed by Vin-CMS to Vin-eRetail.
  4. 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 as active or inactive.
  • To Update the Buffer stock of that SKU against that channel.

Inventory Sync


Vin-eRetail is the source of Inventory for the website and for all other channels that the client is using.


Process flow for Partner/Client:

  • Client can call the Inventory status API after a fixed time interval like 5 minutes to 10 minutes.
  • Inventory displayed at the website 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 the Vin-eRetail system and all the SKUs on which Transaction is done will be available in Inventory Status API and based on the response received, the inventory is updated on the website.
  • And So, this cycle goes on.
  • Also, in case of returns when any order return is received at the warehouse. Depending upon the quality of inventory received in return. Partner/Client team must do the inbound and If it is a good inventory, the SKU will be available in Inventory status API Response again and inventory is updated on the website against that SKU.
  • Only the inventory present in Good Bin is available in the Inventory Status API response.
  • API to sync the inventory available at: https://erp.vineretail.com/swagger/#/Products/post_RestWS_api_eretail_v3_sku_inventoryStatus

Order Management


Below is the flow diagram showing the flow of orders:



1. Order Creation

Once the customer places the order on the website, this order is pushed to Vin-eRetail using the Vin-eRetail Create Order API.


Details of the API available at: https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_create

To create the Orders in Bulk, Details of the API available at: https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_createBulk


Process flow for Partner/Client:

  • Order status can be Pending, Confirmed. This status depends on:
    • If the Customer has selected the Payment Mode as Prepaid but the payment is not successful, this order can be created in “Pending” status. Once the order is created in Pending Status in Vin-eRetail, Inventory is reserved against this order.

This step should be followed if and only if there is an option available to re-try the payment against the same error. If the re-try option is not available, then reserving the inventory of order which will never get confirmed is of no use.

  • If the Customer has selected the Payment Mode as Prepaid and the payment is also successful, this order can be created in the “Confirmed” Status. Once the order is created in Confirmed Status in Vin-eRetail and inventory is available. Vin-eRetail allocates the order automatically.
  • This API has the handling of capturing the entire info of the order i.e., Billing/Shipping address, Payment/Transaction details, Pricing, Discount etc. (all those attributes which are required to create order).
  • If there is any additional info required that needs to be captured in order. The client can pass this info in User-defined fields i.e., UDFs.
  • If Bulk Order create API is used to push the orders in Vin-eRetail, On API Request submission, Vin-eRetail generates a Request Id in response, Final status of the Request can be retrieved by calling the Check
  •  Request Status API and details of the API available at: https://erp.vineretail.com/swagger/#/Common/post_RestWS_api_eretail_v1_common_checkRequestStatus
  • To Update the order details like: Hold/Un-Hold Status, Payment verified or not, Address verified or not, change in Ship date, Pick After Date or to assign a specific logistics partner, Vin-eRetail order Update API is used. Details available at: https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v2_order_orderUpdate


2. Order Processing and Status Updates

a. Order Status

Complete order processing is done in Vin-eRetail. Status of the Orders can be fetched and updated on the website using the Vin-eRetail order Status API.


Details of the API available at: https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v2_order_status


Order status can be fetched based on:

  • Status Update Date and time range. By using the date and time filter, the Client can fetch all those orders which are updated within that date and time range.
  • By Passing specific Order Ids (Max 10 orders at a time).
  • The client can Call this API after a frequency of 15 minutes to 30 minutes and fetch the details of all those orders which are updated within last 15-30 minutes.

Once the Order is Packed in Vin-eRetail, The Invoice and tracking No. of the Order is generated. Using this API, the Client can fetch the Status, Invoice no, Tracking No., Transporter Name, Expected Delivery date, Details of Open order line items/Processed line items etc and update the website.


In the very same way, the Client can Update the status as Shipped, Delivered or Shipped & Returned etc.


b. Fetch Order Invoice Details

  • OrderInvoice API is used to fetch the order invoice details from Vin-eRetail. That includes the tax details, Invoice No. Of Vin-eRetail.
  • 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. generated by Vin-eRetail. Using this API, the Client can show the Invoice summary of the Order/Shipment.


c. Fetch Order Invoice PDF document 

This API is used to get the Vin-eRetail Invoice no and order invoice pdf document. The end customer can login to the website, check the order history, and can download the invoice of his/her order.


More details are available at: https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_orderinvoicepdf


Order Cancellations (Forward and reverse)

Overview of the Order Cancellation process between Vin-eRetail and Client Website:



a. Order Cancellation from Website to Vin-eRetail

Whenever the order is canceled on the website or any Item is canceled on the website, the client can call the:

  1. Order Cancel (If the order is completely canceled on the website). API details available at: https://erp.vineretail.com/swagger/#/Orders/post_RestWS_api_eretail_v1_order_cancel
  2. Order Line Cancel (If any line Item or if any quantity of any line item is partially canceled). API details available at:

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


b. Order Cancellation pull from Vin-eRetail to Website (If the WH/Store team have canceled the Customer order)



Order Returns and inbound


Overview of the Order Return and Inbound process between Vin-eRetail and client website is shown below:



a. Return Creation in Vin-eRetail 

When customers have requested the Return on the website, Below API used to create the Return in Vin-eRetail: https://erp.vineretail.com/swagger/#/Order_Returns/post_RestWS_api_eretail_v1_order_return

Process flow for Partner/Client:

  • If the request type is “request” only then it will create the Return request only and if the Reverse logistics partner is configured in the system, The Reverse Pick-up request is initiated and Vin-eRetail fetch the Tracking No. etc from the logistics partner.
  • Vin-eRetail tracks the status of the Return and update the tracking statuses in Vin-eRetail like Reverse Pick-Up initiated, Reverse Pick-Up done, Reverse Pick-Up Delivered etc.
  • Once the return is delivered at the WH/Store, WH/Store team can do the inbound.
  • If the Request type is “request & inbound” then it will create the Return request and do the inbound in the default Bin/Rack defined in the system, the order will be moved to Shipped & Returned status.

b. Return Status Update from Vin-eRetail to Website

Below is the API available to check the status of the Return: https://erp.vineretail.com/swagger/#/Order_Returns/post_RestWS_api_eretail_v1_order_orderreturn


Process flow for Partner/Client:

  • Based on the last mile Return order tracking, Vin-eRetail keeps updating the status of the Return.
  • To update the status of the Return, the client must call the Order Return API to check the status by passing the date and time range filters. In the response, Vin-eRetail provides the details of all the returns which are updated within that date-time range, and based on the response, the Status of the Return is updated on the website status.


Other APIs


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:

2. Customer wise order fetch

This API is used to fetch the customer-wise list of Orders.


Process flow for Partner/Client:

Annexure

Vin-eRetail– Order Status



Vin-eRetail Delivery/Shipment status



Vin-eRetail - Order Payment Mode



Vin-eRetail – Return order Status