Nykaa Order Processing Flow
- Rashi Mishra (Unlicensed)
- Anushi Dhaketa
STEPS:
Step1. The request is received from WMS in the default service. The input fields and accessToken is extracted using connectionId.
Query:
SELECT inputFields, accessToken
FROM ie_appinstall_connection
WHERE id =:connectionIdStep2. Prepare the request body and URL to fetch the invoice and label.
Step2.1. Generate Invoice:
The API below is used to invoice the order.
https://xxxxx/RestWS/api/sellerPanel/v3/generateInvoiceSample Request Body:
{
"orderItemsList": [
{
"orderNo": "MPTESTP-002-1",
"lineNo": "1",
"invoiceNo": "",
"transporterName": "",
"trackingNo": "",
"weight": "0.5" // weight should be in KGs
}
]
}Success Response Body from Nykaa:
{
"responseCode": 0,
"responseMessage": "Success",
"invoiceNo": "3457899883249"
}Step2. As the invoice number is extracted from the Generate Invoice API response, prepare the fetch document URL to generate the invoice and Shipping Label.
Step2.1. Fetch Document:
https://xxxxx/RestWS/api/sellerPanel/v3/fetchDocumentsInvoice:
Sample Curl:
curl --location --request POST 'http://preprod.vinsupplier.com/RestWS/api/sellerPanel/v3/fetchDocuments' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'apiKey: NTF0ZXN0fjU3NWViMjcwN2RiZDRiODVhZWRlNjE3NDk1NGE1OTg3YmM0NDZhNzgyNmZlNDQxODk0MzllNzM=' \
--data-urlencode 'RequestBody={ "invoiceNo": "TEST1819000001",
"documentType": "Invoice"
}'Request Body:
Set the document-type as 'invoice'.
RequestBody:{
"invoiceNo": "TEST1819000001",
"documentType": "Invoice""
}Response:
The response received will be a pdf stream.
Shipping Label:
Sample Curl:
curl --location --request POST 'http://preprod.vinsupplier.com/RestWS/api/sellerPanel/v3/fetchDocuments' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'apiKey: NTF0ZXN0fjU3NWViMjcwN2RiZDRiODVhZWRlNjE3NDk1NGE1OTg3YmM0NDZhNzgyNmZlNDQxODk0MzllNzM=' \
--data-urlencode 'RequestBody={ "invoiceNo": "TEST1819000001",
"documentType": "ShippingLabel"
}'Request Body:
Set the documentType as 'ShippingLabel'.
RequestBody:{
"invoiceNo": "TEST1819000001",
"documentType": "ShippingLabel""
}Response:
The response received will be a pdf stream.
Step3. Store the extracted data in the ‘shipments’ table of the database.
As the invoice and shippingLabel are generated, call the orderFetch API to get the “awbNo".
The API URL is mentioned below:
https://nykaauat.vineretail.com/RestWS/api/sellerPanel/v3/orderFetchRequest Body:
{
"orderNo": [
"MPTESTP-002-1"
]
}Response Body:
{
"responseCode": 0,
"responseMessage": "Success",
"orders": [
{
"orderNo": "83724872-1",
"orderStatus": "5",
"orderDate": "14/06/2019 16:53:44",
"sla": null,
"customerName": "saswati p",
"paymentMethod": "1",
"orderAmount": "1479.00",
"orderCurrency": "INR",
"orderTaxAmount": "0.00",
"onHold": "0",
"shippingCharge": "200.00",
"discountAmount": "120.00",
"discCouponCode": null,
"storeCredit": "0.00",
"gvAmount": "0.00",
"codCharge": "0.00",
"address1": "flat D - 10, jrm pearl",
"address2": null,
"address3": null,
"phone": "0085980000",
"email": "pani@gmail.com",
"countryCode": "IND",
"state": "Haryana",
"city": "Humla",
"pinCode": "786007",
"billToName": "saswati p",
"bill_Address1": "flat D - 10, jrm pearl",
"bill_Address2": null,
"bill_Address3": null,
"bill_Phone": "0085980000",
"bill_Email": "pani@gmail.com",
"bill_CountryCode": "IND",
"bill_State": "Haryana",
"bill_City": "Humla",
"bill_ZipCode": "786007",
"cancelRemark": null,
"reasonForCancellation": null,
"priority": null,
"orderLastUpdateDate": "26/06/2019 17:22:13",
"masterOrderNo": "NYKL00003378",
"gstin": null,
"sellerId": "TEST4",
"orderItems": [
{
"lineNo": "1",
"deliveryMode": "1",
"skuCode": "TEST-55829-00006",
"skuName": "Test4 vendor SKU6",
"orderQty": "1",
"rejectedQty": null,
"cancelledQty": null,
"shippedQty": null,
"returnedQty": null,
"deliveredQty": null,
"lineAmount": "698.93",
"lineTaxAmount": "0.00",
"unitPrice": "699.00",
"mrp": "699.00",
"discountAmount": "100.00",
"shippingCharge": "99.93",
"codCharge": null,
"invoiceNo": null,
"transCode": "999904",
"transName": "NykaaSelf",
"awbNo": null,
"imeiNos": null,
"confirmDate": "26/06/2019 17:22:13",
"gvAmount": null,
"storeCredit": "0.00",
"lineStatus": "5",
"cst": null,
"vat": null
}
]
}
]
}Step4. Order Ship:
This API below is used to mark the orders as Dispatched.
https://xxxxx/RestWS/api/sellerPanel/v3/orderShipping100 orders can be passed by the integrator in a single request.
API Limit: 200 hits in 300 seconds
Sample Curl:
curl --location --request POST 'http://nykaauat.vinsupplier.com/RestWS/api/sellerPanel/v3/orderShipping' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'apiKey: NTFURVNUMX5hMjdkOGMyYzVmNGU0ZDVhYjA5MTcyOGMxOGIxNGEzZWMyNGMxYTBlMmI4YTQyODhhOWVhYWFj' \
--data-urlencode 'RequestBody={ "shipDetails": [{
"orderNo": "71988508-1",
"awbNo": "NYK-3299-SP"
}]
}'API Request Field Mapping:
Prepare the request body using the extracted keys.
Field Name | WMS Keys | Mandatory (Y/N) |
|---|---|---|
orderNo | orderItemsList[].orderNo | Y |
awbNo | orderItems[].awbNo | Y |
Request Body:
RequestBody:{
"shipDetails": [
{
"orderNo": "71988508-1",
"awbNo": "NYK-3299-SP"
}
]
}Response Body:
{
"responseCode": 0,
"responseMessage": "Success"
}API Response Field Mapping:
Field Name | Description |
|---|---|
responseCode | Specify whether there was any error |
responseMessage | specify “Success” or not |