What is the purpose of this article ?

The purpose of this article is develop an API which will generate Label at the time of order creation.

Flow Chart

Open

What are the steps to achieve this task ?

High level Steps :-

1. We will get the below request body to create order in Eshopbox.

   URL - https://wms.myeshopbox.com/api/shipping/order

2. Sample request body -

   API Path - POST https://wms.myeshopbox.com/api/shipping/order GCP Project - ESB integration Engine Service - esb wms API Endpoint - shippingAppEndpoint
   Request Body :- curl --location 'https://wms.eshopbox.com/api/' \ --header 'Authorization;' \ --data-raw '{ "channelId": "TATA CLIQ VELOCY KAPAS KRAFT", "customerOrderId": "OD119208447831346000", "shipmentId": "wdcTest_54-5865-9684",---------------------------M "orderDate": "2020-02-29 15:39:11", "isCOD": true,--------------------------------------------------M "invoiceTotal": 4049.09,----------------------------------------M "shippingMode": "", "invoice": { "number": "C00011323A000002", "date": "2023-06-02T03:06:14+00:00" }, "ewaybillNumber": "", "balanceDue": 0,------------------------------------------------M if COD order "shippingAddress": {--------------------------------------------M "customerName": "John Doe",---------------------------------M "addressLine1": "Kapas Kraft Apparels Limited",-------------M "addressLine2": "Banglore", "city": "bengluru", "state": "Karnataka", "pincode": "560005",----------------------------------------M "country": "India", "contactPhone": "9998889998", "email": "johndoe@gmail.com", "gstin": "" }, "billingIsShipping": true, "billingAddress": { "customerName": "John Doe", "addressLine1": "Kapas Kraft Apparels Limited", "addressLine2": "Banglore", "city": "bengluru", "state": "Karnataka", "pincode": "560005", "country": "India", "contactPhone": "9998889998", "email": "johndoe@gmail.com" }, "items": [-------------------------------------------------------M { "itemID": "DB9U03FMGWZ",---------------------------------M "productTitle": "Pace Barnes",---------------------------M "quantity": 1,-------------------------------------------M "itemTotal": 4049.09,------------------------------------M "hsn": "", "mrp": "", "discount": "", "taxPercentage": "", "itemLength": "", "itemBreadth": "", "itemHeight": "", "itemWeight": "", "ean": "" } ], "shipmentDimension": {-------------------------------------------M "length": "",------------------------------------------------M "breadth": "",-----------------------------------------------M "height": "",------------------------------------------------M "weight": ""-------------------------------------------------M }, "pickupLocation": {----------------------------------------------M "locationCode": "", "locationName": "", "companyName": "", "contactPerson": "", "contactNumber": "", "addressLine1": "", "addressLine2": "", "city": "", "state": "", "pincode": "", "gstin": "" }, "package": { "type": "", "code": "", "description": "", "length": "", "breadth": "", "height": "" } }'

3. Mapping of these keys to our Database

High level Steps :-

1. Request body to create order in Eshopbox hits the /shipping/order API.

   API URL - https://wms.eshopbox.com/api/createOrder Project - ESB-WMS-API

2. Check if this order details already exists in our system (DB) by calling the function doesOrderAlreadyEsist()

   1. If order details are already present,

      1. check if its label details are also present, then return the same label in response

      2. If label details are not present then simply generate label and return it in response

   2. If order details are not present in present in DB, then start from step 3.

3. Create Model class for orders, order_items, shipments and shipment_statusLogs table

4. Call a function processRequestData(requestMap) which will be created in service class

   1. Create a function - processOrderAndOrderItemDetails()

      1. Create isRequestBodyValid(requestBody) function to check if all mandatory keys are present

      2. Create a function assignmentOfChannelID(). This function will get channelID which needs to be saved in orders table orders.channel_id in DB.

      3. Check if location details already exists in our system. If Yes, then get warehouseId If no, then create location in background through taskqueue by calling the common function assignmentOfLocationCode()

      4. Create another method - checkIfProductExistsInEshopbox(). This function will check if productDetails already exists in our system by calling product API.

         1. If product API returns response, then it means that product details already exist in our system then store all product details to save them in order_items table

         2. If product API returns response then it means that product does’t exist in our system then

            1. First save all required details in orders and order items table. Us the common method saveOrderAndOrderItemDetails().

            2. In the background (taskqueue), create a draft project with the product details and save them in order_items table. This will be done in a function - createDraftProduct()

      5. Create a method() - saveOrderAndOrderItemDetails(requestBody).

         1. Create objects for order and order_items model.

         2. Set the details in the models from the request body and insert in orders and order_items table in DB.

   2. Create a function - createShipmentForOrder().

      1. Use the common function - assignmentOfLocationCode(). This function will check if location is already created or not. If not created, then we will need to create the location in real time

      2. Create another method() - saveShipmentDetails().

         1. Set the details in shipments and shipment_status_logs models

         2. Insert the details in shipments table, order_items table, shipment_status_logs table with “created“ status.

   3. Create a method - packTheShipment().

      1. Call recommendation API of Clickpost

         1. If recommendation API gives error/Pincode not serviceable in response, make entry in SSL table with “failed_to_rts“ status in DB for this shipment and return the error

         2. If recommendation API gives success response, then call Manifestation API to get the trackingID and assign Courier.

            1. If Manifestation API gives error in response, make entry in SSL table with “failed_to_rts“ status in DB for this shipment and return the error

            2. If Manifestation API gives success response, make entry in SSL table with “packed“ status in DB for this shipment. Make entry for label details in shipments table and return the lebel generated

Low level Explanation of Functions :-

doesOrderAlreadyEsist()

1. Get accountId from session , customerOrderNumber from request.shipmentID and externalChannelID from request.channelID

   1. If request.channelID = null or blank then get the value of default custom app channelID by calling the common method assignmentOfChannelID()

2. Query from DB to check for existing order and store the result in a list

   SELECT sh.externalshipmentId, sh.label_url, sh.dimension_height, sh.dimension_width, sh.dimension_length, sh.weight, sh.cp_id, sh.trackingID, sh.courierName FROM orders LEFT JOIN order_items ON order_items.order_id = orders.id LEFT JOIN shipments sh ON sh.id = order_items.shipment_id LEFT JOIN courier_partners ON courier_partners.id = sh.courier_partner_id WHERE orders.customerOrderNumber = "wdcTest_54" AND orders.channel_id = 5865 AND order_items.brandAccountId = 758

   1. If the query returns the result, then it means that the order already exists in DB.

      1. If queryResult.label_url is not null or blank then return the courier details in response of the API

      2. If query result.label_url is null or blank

         1. call the common function packTheShipment() which will pack the shipment

         2. Make entry in shipment_status_logs table with "packed" status and update label details (trackingID, courier name, label url) in shipments table

         3. Return the courier details in response of the API

   2. If the query returns the result null, then it means that the order doers not exist. In this case move to step 3.

isRequestBodyValid(requestBody)

1. Declare Boolean variable isRequestBodyValid = true

2. Make 3 sets In Constants file

   Set<String> ordersMandatoryKeys = [] Set<String> orderItemsMandatoryKeys = [] Set<String> shipmentsMandatoryKeys = []

   1. Iterate over the request body and check

      1. if ordersMandatoryKeys contains the request body.key, if yes then remove that particular key from ordersMandatoryKeys set

      2. if orderItemsMandatoryKeys contains the request body.key, if yes then remove that particular key from orderItemsMandatoryKeys set

      3. if shipmentsMandatoryKeys contains the request body.key, if yes then remove that particular key from shipmentsMandatoryKeys set

   2. Check if ordersMandatoryKeys, orderItemsMandatoryKeys, shipmentsMandatoryKeys set is empty

      1. return isRequestBodyValid

   3. Return false

processOrderAndOrderItemDetails(requestBody)

1. Create objects of orders and order_items model class.

2. validate request body

3. Create a function assignmentOfChannelID().

   1. Get the value of key “channelId“ from request body. This is actually externalChannelId in our system.

   2. If the value of “channelIdis null or empty,

      1. Get account id from session and value of cacheKey “customChannelIdAndAccountMapping“

      2. If the value from cacheKey is null, then use below query to get the result and set the data in cacheKey in map form where key = account_id and value = channelId. This cacheneeds to be flushed whenever new account is created

         SELECT account_id, channelID FROM channels WHERE TYPE = 'MANUAL';

      3. Get the value of channelId from cacheKey and return it.

   3. If the value of “channelIdis not blank, Get the value of cacheKey “channelIdAndExternalChannelIdMapping“.

      1. If the value from cacheKey is null,

         1. use below query to get all details from DB

            SELECT id, externalChannelID FROM channels;

         2. Iterate over the query result and prepare details in a map and set them in cacheKey cacheKey.“channelIdAndExternalChannelIdMapping”.
            Note : The cache will store values in Map format => key = externalChannelID , value => channelId. This cache will refresh whenever new channel is created

      2. Get the channelID (Primary key) from the value of cacheKey set above by request.channelId.

      3. If channelId is still null then throw Exception “ChannelId is Invalid“ else return channelID

4. Set channel ID in orders model object

5. Create a function - assignmentOfLocationCode()

   1. Get pickupLocation.locationCode from requestBody

   2. If it's value is null or blank, then throw Exception “locationCode cannot be blank“ and exit the flow

   3. If its value is present then check if this location code exists in our DB using the below query

      SELECT party.name,party.refPartyID,party.partyID, warehouses.externalWarehouseID FROM warehouses LEFT JOIN party ON party.warehouse_id = warehouses.id WHERE party.refPartyID = '';

      1. If query returns null result, it means location details does not exist in our system.

         1. Call taskqueue where which will create a new location by calling create location API

            1. In the taskqueue listener API, call a function createNewLocation() This function will be used to create a new location whose details are in request.

               GCP Project - Staging : ,Prod : Project Repo - Endpoint - curl --location -g --request POST 'https://{{accountSlug}}.auperator.co/api/v1/party' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik1UaERRamxDUlRJelJVUTRRVU0wUVRJNU1FSkVOVGszUVVFeU5qVXdSa1JDTmpBeU16WTROQSJ9.eyJodHRwczovL2FwcERhdGEiOnt9LCJodHRwczovL3VzZXJEZXRhaWxzIjp7ImlkIjoxMDAzLCJ1c2VyVHlwZSI6ImRlZmF1bHQiLCJlbWFpbCI6ImFudXNoaS5kQGVzaG9wYm94LmNvbSJ9LCJodHRwczovL2FjY291bnRzIjpbInRjbnNnZ24iLCJ0Y25zYTQ4NCIsInRjbnN3OTk2IiwidGNuc2E0OTIiLCJ0Y25zZTAwMyIsInRjbnN3OTc1IiwidGNuc3c5NDAiLCJ0Y25zdzc0MCIsInRjbnN3NDA0IiwidGNuc3c0MTYiLCJ0Y25zdzUzMiIsInRjbnN3ODM4IiwidGNuc3c3MTUiLCJ0Y25zd2ExMDciLCJ0Y25zdzg2MCIsInRjbnNwYXRsaWJnZ24iLCJ0Y25zZXNiZm5mcnNodmlydHVhbG1vdmVtZW50IiwidGNuc2FnZ24iLCJ0Y25zIl0sImh0dHBzOi8vd2FyZWhvdXNlV29ya3NwYWNlcyI6WyJ0Y25zZ2duIiwidGNuc2E0ODQiLCJ0Y25zdzk5NiIsInRjbnNhNDkyIiwidGNuc2UwMDMiLCJ0Y25zdzk3NSIsInRjbnN3OTQwIiwidGNuc3c3NDAiLCJ0Y25zdzQwNCIsInRjbnN3NDE2IiwidGNuc3c1MzIiLCJ0Y25zdzgzOCIsInRjbnN3NzE1IiwidGNuc3dhMTA3IiwidGNuc3c4NjAiLCJ0Y25zcGF0bGliZ2duIiwidGNuc2VzYmZuZnJzaHZpcnR1YWxtb3ZlbWVudCIsInRjbnNhZ2duIl0sImh0dHBzOi8vd2FyZWhvdXNlcyI6W10sImh0dHBzOi8vcGFydG5lcnMiOlsiNDMxODk1IiwiMjg0MTY2IiwiODk4Njg1IiwiNjc4MTUxIiwiMTIyMDg1IiwiMjk1MzUyIiwiMTg2MTk2IiwiMTYzNTA5IiwiNTYzMzg1IiwiODIwMDYxIiwiOTI5MTMyIiwiOTI2NzY2IiwiMzExMTkxIiwiMTMwNTQxIiwiMTYzNjI0Il0sImlzcyI6Imh0dHBzOi8vZXNob3Bib3guYXV0aDAuY29tLyIsInN1YiI6ImVtYWlsfDYwODk2ZWVlYjYwODcxMDMyZTZjOGVjMyIsImF1ZCI6WyJodHRwczovL3dtcy5teWVzaG9wYm94LmNvbSIsImh0dHBzOi8vZXNob3Bib3guYXV0aDAuY29tL3VzZXJpbmZvIl0sImlhdCI6MTcxNTMyNDQ1NCwiZXhwIjoxNzE1NDEwODU0LCJzY29wZSI6Im9wZW5pZCBwcm9maWxlIGVtYWlsIiwiYXpwIjoiSUlOSjZrbjNFQkZLZDJlVEZ6TW9ZZ0tmaGw2NTQwMkwifQ.DM_FojYYcLRgxQHJ0XpGROWyfcQQIbGW_-iU_Di5gkRVVq1Ww32wke8LTmbyD_fi2tuFPjCRk67G6-iRQr9avEnCYHaX1hGoTcszUqb7z6uJG-fQi0asPDa-IvAN-Zx32cKzJhyuVYx1BsNWcVpja5OkhtSBAigrbeLLkNbGUAcK2f7CP_PqtAPDO5CoS8Vv5nmxSffqPze6mh6uY-YKu7u_VjUBi7Q8jhO7fSMiLy6_rUT8NOuIJwM0Sy_SM0UgIvULt-_BZf8XnEy_MhSEbOlFaenlgH8jAICU2IV6dyQwvRFyAkoj4EvYf1wn_7RAJki1cx5OPcnGHpX25vI6bQ' \ --header 'Content-Type: application/json' \ --data-raw '{ "partyName": "DELHI 001", "refPartyId": "DEL001", "flexStatus": "0", "fcTraceability": "Sku level", "addressLine1": "Gurgaon\nGurgaon", "addressLine2": "Gurgaon\nGurgaon", "city": "New Delhi", "pincode": 110001, "state": "Delhi", "country": "India", "gstin": "07AAFCD5862R007", "primaryPhone": 9999999999, "contactPerson": "Anushi Dhaketa", "companyName": "Eshopbox" }' Response :- { "id": "52046", "accountId": 1653, "partyId": "D000152046", "refPartyId": "DEL001", "partyName": "DELHI 001", "type": "Supplier", "gstin": "07AAFCD5862R007", "addressLine1": "Gurgaon\nGurgaon", "addressLine2": "Gurgaon\nGurgaon", "city": "New Delhi", "state": "Delhi", "pincode": "110001", "country": "India", "primaryPhone": "9999999999", "isDefault": "0", "companyName": "Eshopbox", "flexStatus": "1", "contactPerson": "Anushi Dhaketa", "fcTraceability": "Sku level" }

            2. Return the response

      2. If query return a result, it means the location is already created in our system. Set the warehouseId in order_items model

6. Create another method checkIfProductExistsInEshopbox().

   1. If ItemID is present, then call Product API by passing itemID

      curl --location 'https://esb-product-engine-prod.appspot.com/_ah/api/esb/v1/products?fields=esin%2Cspecification%2CgroupCode%2Ccomponents%2Cstatus%2CaccountSlug%2Ccombo%2CchannelCode%2Cbrand%2Ctype%2Csku%2Cweight%2CdimensionHeight%2CdimensionLength%2CdimensionWidth%2CweightUnit%2CdimensionUnit&ids=70MRB3HGFW6' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik1UaERRamxDUlRJelJVUTRRVU0wUVRJNU1FSkVOVGszUVVFeU5qVXdSa1JDTmpBeU16WTROQSJ9.eyJodHRwczovL2FwcERhdGEiOnt9LCJodHRwczovL3VzZXJEZXRhaWxzIjp7ImlkIjoyOTQsInVzZXJUeXBlIjoic3lzdGVtIiwiZW1haWwiOiJwbF9wcm9kX3VzZXJfaW52X2VuZ2luZUBlc2hvcGJveC5jb20ifSwiaHR0cHM6Ly9hY2NvdW50cyI6W10sImh0dHBzOi8vd2FyZWhvdXNlV29ya3NwYWNlcyI6W10sImh0dHBzOi8vd2FyZWhvdXNlcyI6W10sImh0dHBzOi8vcGFydG5lcnMiOltdLCJpc3MiOiJodHRwczovL2VzaG9wYm94LmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw1ZTRhN2VlYmFjY2Q4OTBlNjgxNGJlMTYiLCJhdWQiOlsiaHR0cHM6Ly93bXMubXllc2hvcGJveC5jb20iLCJodHRwczovL2VzaG9wYm94LmF1dGgwLmNvbS91c2VyaW5mbyJdLCJpYXQiOjE3MTE0NTI2NzAsImV4cCI6MTcxNDA0NDY3MCwic2NvcGUiOiJvcGVuaWQgcHJvZmlsZSBlbWFpbCBhZGRyZXNzIHBob25lIHJlYWQ6cHJvZHVjdHMgd3JpdGU6cHJvZHVjdHMgcmVhZDppbnZlbnRvcnkgcmVhZDpwcm9kdWN0X2xpc3RpbmdzIHdyaXRlOnByb2R1Y3RfbGlzdGluZ3MgcmVhZDppbndhcmRfY29uc2lnbm1lbnRzIHJlYWQ6cmVjYWxsX2NvbnNpZ25tZW50cyB3cml0ZTpyZWNhbGxfY29uc2lnbm1lbnRzIHJlYWQ6b3JkZXJzIHdyaXRlOm9yZGVycyByZWFkOnJldHVybnMgd3JpdGU6cmV0dXJucyByZWFkOnJlY2VpdmFibGVzIHJlYWQ6cGF5YWJsZXMgcmVhZDpwYXlvdXRzIHdyaXRlOnBheW91dHMgcmVhZDpmZWVzIHdyaXRlOmZlZXMgcmVhZDp0cmFzbmFjdGlvbl9ydWxlcyB3cml0ZTp0cmFuc2FjdGlvbl9ydWxlcyByZWFkOm1lbWJlciB3cml0ZTptZW1iZXIgcmVhZDpjdXN0b21fZmllbGRzIHdyaXRlOmN1c3RvbV9maWVsZHMgcmVhZDpsb2NhdGlvbnMgd3JpdGU6bG9jYXRpb25zIHJlYWQ6cG9ydGFsIHdyaXRlOnBvcnRhbCByZWFkOndvcmtzcGFjZSByZWFkOnNhbGVzX2NoYW5uZWwgcmVhZDpmdWxmaWxsbWVudF9jZW50ZXIiLCJndHkiOiJwYXNzd29yZCIsImF6cCI6Ik1pYzVRY2M5RTVNY1hUNUYxY0hYREJhbUYxVzNqSTY1In0.F5jidN2pUA4Ef4hhTu60aXnTQ0H08Y-DSszTA9KLqt8y3xnJHJJ8D2T4rhbe4zCtrKvYMYu4POwXD_vtyYUrHJMENT1Tgk-bVHq1QIEhRff72CAPL5n-F1v9HLFCJP-QEEBfVa1_02fhw_oB-uxGe1vBwlSVih-trkDbaSrv0XclTOYePP0JHOpRo6gHmyNob96UcgpqO8kQv7EDIOcJ-n1UfW_beJ1WdlLJfQ2MyYCFP7cjDiD45wPVKU9a9lQFocmse-10YGgDLiPOIQujOE8_Uy4bnr0P8magsHXZc6wqOTluIsjEjIwIpkX6uXISZuA9pI1WVglbQe_3tqvIrA' \ --header 'ProxyHost: eshop'

      1. If response is found then set the value of “esin” in order_items model to be saved in SKU column.Also Set all product details in order_items model to be in productAdditionalInfo variable.

      2. If response from product API is null or blank

         1. Set itemID in order_items model object

         2. Call saveOrderAndOrderItemDetails() method.

         3. Create a task in which createDraftProduct() function will be called. Pass all the details of product and order_items.id (primary key). order_items.id is required because once product is created in taskqueue, we have to save all product details in productAdditionalInfo column in order_items table for this particular created order_items.id.

            1. Backgound working In the taskqueue listener API where draft product is to be created,

               1. Call create product API

                  Project repo - GCP Project - Service - API curl curl --location 'https://esb-product-engine-staging.appspot.com/_ah/api/esb/v1/products' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJVVXdSREZCUVRSRFFqQkdORFUxTVVZeE16ZEdPRFJHTnpORk5EaEJSVEU0TVVORk5qVTJOdyJ9.eyJodHRwczovL2FwcERhdGEiOnt9LCJodHRwczovL3VzZXJEZXRhaWxzIjp7ImlkIjozMjE1LCJ1c2VyVHlwZSI6ImRlZmF1bHQiLCJlbWFpbCI6ImhhcnNoaXRhLnNoaW5kZUBlc2hvcGJveC5jb20ifSwiaHR0cHM6Ly9hY2NvdW50cyI6WyJlbGVjdHJvbmljc2VsbDgyNTMxNCIsImVsZWN0cm9uaWNzZWxsNDIxMzAyIiwiZWxlY3Ryb25pY3NlbGwiXSwiaHR0cHM6Ly93YXJlaG91c2VXb3Jrc3BhY2VzIjpbImVsZWN0cm9uaWNzZWxsODI1MzE0IiwiZWxlY3Ryb25pY3NlbGw0MjEzMDIiXSwiaHR0cHM6Ly93YXJlaG91c2VzIjpbXSwiaHR0cHM6Ly9wYXJ0bmVycyI6W10sImlzcyI6Imh0dHBzOi8vZXNob3Bib3gtcGF5bWVudC1yZWNvLmF1dGgwLmNvbS8iLCJzdWIiOiJlbWFpbHw2NGE1MDE0ZTgxNzFiYmRmZTNhOTgzNDAiLCJhdWQiOlsiaHR0cHM6Ly9lc2hvcGJveC1wb3J0YWwtZGV2LmFwcHNwb3QuY29tIiwiaHR0cHM6Ly9lc2hvcGJveC1wYXltZW50LXJlY28uYXV0aDAuY29tL3VzZXJpbmZvIl0sImlhdCI6MTcxMjU2MzYwMywiZXhwIjoxNzEyNjUwMDAxLCJzY29wZSI6Im9wZW5pZCBwcm9maWxlIGVtYWlsIiwiYXpwIjoiVFNIMlRYeDdXdmZ4NmhwcElGZnpsNWNiMU1HcXY5VnAifQ.laEtyREGnjJ5hg_VnW_F6ID36RCqzzh2EQ1TTOwn3Ib5cYfV2ftu9Ft3nqHl8NOQImGj9713JVSQyxxhB9IS5MoRaAZaJHcVUHTXXVi7JsuFyxux0_0SbjnU0xEbcngQX7O5mdvOwRnnLkSGr-ZBjWpGmdWbPELFowt7Is2V6ulxnyEBCVr-LSQD1ss-MVT6FhMTW2CePB8Ar4gL80xkpOT_m8N2Q6OjK791DQQTCehl-PgpFYoW8TmioHn4evMkH0sUl5W63GgnO5TNjHQsKOC_DTcpCdO8hM_jvEvT_H0eKEUWscwhHAbf0h9tciMzCQKI6nxy-l_7l6-ARp5Q-w' \ --header 'proxyHost: trendy' \ --header 'Content-Type: application/json' \ --header 'Cookie: JSESSIONID=txcZG8pxy_boRavyTK6W-g' \ --data '{ "type": "BASE", "sku": "kurtaset09", "description": "hello", "imageUrl": "https://i0.wp.com/mayurkarwa123.wpcomstaging.com/wp-content/uploads/2024/03/organicproducts1-1.jpg?fit=500%2C329&ssl=1", "mrp": 123, "unitPrice": 123, "weight": 0.5, "dimensionLength": 13, "dimensionWidth": 12, "dimensionHeight": 11, "dimensionUnit": "cm", "weightUnit":"g", "batchTrackingEnabled" : false, "taxCode" : "ESBHH1,ESBHH2", "hsnCode": "574638" }'

               2. When the response is returned, write an update query to save all the product details in order_items table in DB

                  update order_items set sku = "", asin = "", productName, "", productAdditionalInfo, mrp = "" where id = 123;

7. Create a method() - saveOrderAndOrderItemDetails(). (common method for order/return)

   1. In this method, pass the request body as a parameter

   2. Using if else statement, set all the details in orders and order_items model

   3. Once the details have been set, insert in orders and order_items table in DB using hibernate save() method.

createShipmentForOrder()

1. Create a function - assignmentOfLocationCode()

   1. Get pickupLocation.locationCode from requestBody

   2. If it's value is null or blank, then throw Exception “locationCode cannot be blank“ and exit the flow

   3. If its value is present then check if this location code exists in our DB using the below query

      SELECT party.name,party.refPartyID,party.partyID, warehouses.externalWarehouseID FROM warehouses LEFT JOIN party ON party.warehouse_id = warehouses.id WHERE party.refPartyID = '';

      1. If query returns null result, it means location details still does not exist in our system and has not been created through taskqueue till now. So, now we will need to create the location in real time.

         1. Now call the common function createNewLocation(). This function will be used to create a new location whose details are in request in real time.

         2. Return the response

      2. If query returns the data, it means location is already present in our system.
         Note : we have to save warehouse_id in order_items and shipments table in DB too.

2. Create object of shipments and shipment_status_logs table.

3. Create another function - saveShipmentDetails().

   1. In this method, using if else statement, set all the details in shipments model and shipment_status_logs table.

   2. Once the details have been set,

      1. Open the hibernate session

         1. insert the details in shipments table in DB using hibernate save() method

         2. fetch shipment_id from shipments table

         3. insert the details in Shipment-status_logs table with “created“ status and shipment_id fetched above using hibernate save() method

         4. Update shipment_id in order_items table using update query

            Update order_items set shipment_id = 123 where id = 78456;

      2. Commit the session

packTheShipment()

1. Call Generate Label API

   GCP Project - Staging : ,Prod : Project Repo - Endpoint - API Type & path - POST: Staging : https://eshopbox-wms-api-dot-eshopbox-wms-staging.el.r.appspot.com/api/generateLabel
   Request Body :- { "actionType": "generateLabel", "actor": "email id of the actor", "externalShipmentId": "DRM3607-2397-7375", "orderItems": [ { "orderItemID": "#DRM3607-33553001" } ] }
   Response :- { "courierName": "Self", "waybill": "874320208625", "label_url": "https://storage.googleapis.com/eshopbox_wms_uploads_staging/myntraLabel/202405061317301511071119.pdf", "shipmentId": "wdcTest_54-5865-9684", "routingCode": "ASB-ZBX", "labelStream": "", "shippingMode": "Express" }

2. If label is returned in response, then make entry in shipment_status_logs table with packed status for this particular shipment_id and return the same response of label API to client.

3. If label is not returned in response, then make entry in shipment_status_logs table with “failed_to_rts“ status for this particular shipment_id and return the same response of label API to client after adding a key “errorMessage“ in response.

4. In both the case the response will be a success response.

Mapping of request body keys with respect to columns in DB

1. Mapping of request body keys with order_items table :-

2. Mapping of request body keys with orders table :-

3. Mapping of request body keys with shipments table :-

4. Keys in the create location request body