Seller Panel V3 APIs Integration Guide

Technology Stack: Rest Framework 

Version 3.2

eRetail V3 JIT APIs

eRetail V3 JIT APIs

Generic Information

Date Fields:

• Date Format: dd/MM/yyyy
• Date Time Format: dd/MM/yyyy HH:mm:ss
• Time Zone: IST

Authentications:

ApiKey in Request Headers (ApiKey retrieved through AuthToken Call.)

Web Service Details:

• Technology: Restful Web Services
• Request Type: Post (Except: AuthToken)
• Encoding: application/x-www-form-urlencoded
• Communication Type: JSON
• Page Number and limit are optional (default PageNumber 1 limit 100)
• Maximum Limit 100.

Username and Password:

Developer or Integrator must get in touch with the Marketplace Team or account Manager to get the Username and password.

1. AuthToken

The Auth Token generated in response is a Static Token and is having a validity of 10 years. The

developer/integrator should make this call only once. There is no need to keep calling this API in

repeat mode.

Also, In case of a Seller/vendor having multiple Warehouse, This token remains the same for all

the locations/Warehouses/Child Sellers of that seller.

• API URL: https://xxxxx/RestWS/api/sellerPanel/v3/authToken
• Method: GET
• Request Params: username=50TEST&password=pass
• Sample Request: http://preprod.vineretail.com/RestWS/api/sellerPanel/v3/authToken?username=51TEST4&password=sa@321

Sample Response:

2. Product Fetch

This API is used to fetch the Product details from Seller Panel.

This API can be called either to fetch the entire list of SKUs created/updated created or Updated

after a specific date or to fetch the Detail of 1 Product.

Best Practice is to Pull all the Product details from Seller Panel go Live date to the integration go live

date. Once the entire list is pulled/created. It is advised that the developer/integrator should call this

API on passing the date and time of the current date so that only the Updated records/ New created

records will be pulled.

• API URL: https://xxxxx/RestWS/api/sellerPanel/v3/productFetch
• Method: POST
• API Hit Rate: 40 hits in 300 Seconds
• Content-Type: application/x-www-form-urlencoded

Sample Curl:

Case 1: To fetch the list of Products created/Updated after a specific date.

Request: (to be passed as key Value Pair)

RequestBody:{"updatedDate": "01/01/2015 00:00:00",↵"skuCode":

[],"pageNumber":1,"limit":100}

Response:

Case 2: To fetch the details of specific Product.

Request: (to be passed as key Value Pair)

RequestBody:{ "updatedDate":"", "skuCode":[ "TEST-55829-00007", "TEST-55829-00011"

], "pageNumber":1, "limit":100 }

Response:

SkuCode and Updated date both filters are provided, Updated date filter will be ignored.

API Request Field Mapping

API Response Field Mapping

3. Inventory Price Update

This API is used to Update the available inventory or Price of the seller. The seller can pass 100 SKUs in 1

Batch.

Best Practice is to Hit the API If and only If there is a transaction happened at seller’s end. (Increase

or decrease in inventory).

For the inventory reconciliation on daily or weekly basis or for the first-time inventory Update for all

the SKUs. It is advised to call this API in such a way that the batch size is 100 and the No. of requests

should not be greater than 40 per 5 minutes (means in 5 minutes, Inventory of 4000 SKUs gets

updated). Pick the remaining SKUs in another batch and execute it after 5 minutes.

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/authToken

Method: GET

Request Params: username=50TEST&password=pass

Sample CURL:

Case 1: If the Vendor has 1 single Warehouse

Sample Response:

Case 2: If the Seller have multiple locations.

(Request to be used as a form Data)

RequestBody:{↵"invPriceList":[↵{ "sku":"CSKU1", "salePrice":"205",

"invQty":11,"sellerId":"MWHP"},↵{ "sku":"CSKU2", "salePrice":"230",

"invQty":14,"sellerId":"MWHP"}↵]↵}

Response:

Case 3: Response if the SKU code does not exist in system:

API Request Field Mapping

API Response Field Mapping

4. Inventory Price Status

This API is used to fetch the final Status of the inventory Update API calls made in Batches.

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/inventoryPriceStatus

API Hit Rate: 40 hits in 300 Seconds

Request:

RequestBody = {

"moderationIdsList": [ 108, 109 ]

}

Response:

Maximum 100 ModerationsIds can be pushed in one call.

API Request Field Mapping

API Response Field Mapping

5. Order List /Order List JIT

This API is used to fetch the List of Orders created after a specific date. The No. of orders in 1 Page in the response is 100.

It is advised that the developer or integrator should store the Last Order Create date in the System and make the next call from that time at which the last order is pulled. This can provide the most relevant response else the same No. of orders keeps on repeating in every response.

Filter Status List is available in the Annexure in the last of this document.

This API provides all the orders in response (both the created as well as If an old order is updated after the date-time passed in the API request). Hence it is not required to check the details of an individual orders by calling the OrderFetch API after a specific interval of time for every single order.

Possible cases because of which an older order (order date older than the filter passed in the request but updated within the filter passed).

1. If a new order is created
2. If an order is partially canceled.
3. If an order is fully canceled.
4. Any details on the existing order is updated.

To Pull the new and canceled or partially canceled orders, please pass the filter status 5, 8 as mandatory status in every request.

For a Dropship Seller, 

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/orderList  

For JIT Seller, 

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/orderListJIT  

API Hit Rate:  40 hits in 300 Seconds  

Case 1:  For a seller having 1 single warehouse.

Request:  

RequestBody:{"updateDate":"01/08/2015 21:00:00", "filterStatusList":"5,8,15,25","pageNumber":1,"limit":200}  

Case 2: For a seller having multi Warehouse

Request:

RequestBody:{"updateDate":"30/07/2020 17:55:09", "filterStatusList":"5,8,15,25,10,18","sellerId":"mwhc2","pageNumber":"1","limit":"200"}

Response: 

Please Note: Order List in output is ordered by OrderLastUpdateDate ASC  

API Request Field Mapping  

API Response Field Mapping

6. Order Fetch /Order Fetch JIT

This API is used to fetch the details of the Orders received in the response of OrderList API.

It is advised that the developer or integrator should not call this API to fetch the status of the individual order. Use this API to fetch the info of the Orders coming in the response of Order List API as that already have all those orders in response that got updated, canceled, created.

For Dropshipping,  

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/orderFetch  

For JIT,

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/orderFetchJIT 

API Hit Rate:  80 hits in 300 Seconds  

Request:

RequestBody:{"orderNo" : ["83724872-1"] }  

CURL:

Response:

API Request Field Mapping

API Response Field Mapping

7. Generate Invoice  

This API is used to invoice the Order.

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/generateInvoice   

API Hit Rate:  80 hits in 300 Seconds  

CURL:

Request:

RequestBody:{"orderItemsList": [{"orderNo": "639-1","lineNo": "1","invoiceNo":

"VANHEUSEN00001","transporterName": "","trackingNo": "","weight":"0.5"}]}

Response:

API Request Field Mapping  

API Response Field Mapping

8. Fetch Invoice  

This API is used to Fetch the invoice info of the order.

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/fetchInvoice  

API Hit Rate:  80 hits in 300 Seconds  

CURL:

Request:

RequestBody:{"invoiceNo" : "TEST11920000005" }

Response:

API Request Field Mapping

API Response Field Mapping 

9. Fetch Documents  

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/fetchDocuments  

API Hit Rate:  80 hits in 300 Seconds  

CURL:

Request:

RequestBody:{   "invoiceNo": "TEST1819000001",  "documentType": "ShippingLabel"}

Response:   

(the output will be a pdf stream).

%PDF-1.5

%����

2 0 obj

<</Length 28/Filter/FlateDecode>>stream

x�+�r

�26S�03QI�r

�

�

API Request Field Mapping

API Response Field Mapping  

10. Order Ship  

This API is used to mark the orders as Dispatched. Developer or integrator can pass 100 hundred orders in 1 single request.

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/orderShipping  

API Hit Rate:  200 hits in 300 Seconds  

CURL: 

Request: (in Key value Pair)

RequestBody:{ "shipDetails": [{ "orderNo": "71988508-1", "awbNo": "NYK-3299-SP"

}]}

Response:

API Request Field Mapping

API Response Field Mapping

11. Order Cancellation

This order is used to push the seller's cancellation. 1 order will be cancelled in 1 request.  

API URL: https://xxxxx/RestWS/api/sellerPanel/v3/orderCancellation  

API Hit Rate:  40 hits in 300 Seconds  

CURL:

Request:  

RequestBody:{"orderNo": "59878966-1"}

Response: 

API Request Field Mapping

API Response Field Mapping 

12. Back Order Fetch API

This API is used to fetch the Pendency or Back Order inventory or Reserved inventory against the Orders and applicable to JIT vendors only. This API provides all the SKUs with their Back Order quantity in response.

API URL: https://xxxxx.vineretail.com/RestWS/api/sellerPanel/v3/skuBackOrder 

Method: GET

API Hit Rate: 40 hits in 300 Seconds

CURL: 

Response: 

API Response Field Mapping  

Swagger Link: 

https://erp.vineretail.com/SellerPanelV3/#

Annexure - Error Codes  

Annexure – Order Status

Annexure – Order Payment Method

Annexure – Delivery Mode