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

LLD link

Create order API new flow | LLD Link

Request Mapping With Unicommerce Link

Request Mapping with Unicommerce for Esb shipping create order

Request Mapping with Fynd link

Shipping App Create Order - request Mapping with Fyndd

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
   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": "", "country" : "", " ": "", "gstin": "" }, "package": { "type": "", "code": "", "description": "", "length": "", "breadth": "", "height": "" } }'

2. 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(). In this function 2 sub functions will be made :-

   1. assignmentOfChannelID(). This function will fetch channelID which needs to be saved in orders table orders.channel_id in DB. Also channelId is required for query to check if order already exists.

   2. fetchOrderAndShipmentDetailsQuery(). This fuction uses a real time query to fetch already existing orders and shipments details in our DB by customerOrderNumber and channel id.

   3. Based on the query result, check and set the following if query result is not null and empty

      1. set isOrderItemAlreadyCreated = 1

      2. isShipmentAlreadyCreated = 1

      3. if no. of items in the request is same as present in DB. i.e., requestBody.items list size == Query result list size, set isItemsCountMatch = 1

      4. if query result. orderItemStatus is ONHOLD, set orderItemStatus = ONHOLD

3. If order Details are already Present i.e.,isOrderItemAlreadyCreated = 1 OR isShipmentAlreadyCreated = 1, then do the following :-

   1. isItemsCountMatch != 1 then return Error in api response.

   2. If orderItemStatus = ONHOLD then return error “Your order cannot be processed due to high risk of failed delivery“

   3. Now check if if Location code of the order in the API belongs to no_inventory using the function doesPickupLocationBelongToNoInventoryBarcode(). This function uses a cache to check if location already exists. If it does not exists then it uses a real time Query to check this. This function will return a response be it either null or location details.

   4. Based of the query result, set the value -

      1. If response .barcodeType = no_inventory, then it means location is already exising and is of no_inventory facility type. In this case set doesLocationExist = true

      2. If response .barcodeType = sku/item, then it means location is already exising and is of sku or item facility type. In this case throw Exception “You can only create orders in Eshopbox for locations where inventory is not managed.“

      3. If response .barcodeType = null, then it means location does not exists. In this case set doesLocationExist = false

      4. If response.label_url is not null and not blank then return the courier details in response of the API

      5. If response.label_url is null or blank, then

         1. Call label generation function. generateShippingLabel(). This function is responsible for generating label and returns the label in response.

         2. Pass the request body and response from label generation function in common taskqueue. orderAdditionalInfoData. This taskqueue is responsible is responsible for performing all the background work like saving order and shipment details and publishing events.

         3. Returns the response of generate label function in API response.

4. If order Details are not Present i.e.,isOrderItemAlreadyCreated != 1 AND isShipmentAlreadyCreated != 1, then do the following :-

   1. Check if request body is valid by calling the function isRequestBodyValid(requestBody). This function has two sub functions to validate this.

      1. Check for all mandatory Keys areAllMandatoryKeysPresent()

      2. Now check if if Location code of the order in the API belongs to no_inventory using the function doesPickupLocationBelongToNoInventoryBarcode(). This function uses a cache to check if location already exists. If it does not exists then it uses a real time Query to check this. This function will return a response be it either null or location details.

      3. Based of the query result, set the value -

         1. If response .barcodeType = no_inventory, then it means location is already exising and is of no_inventory facility type. In this case set doesLocationExist = true

         2. If response .barcodeType = sku/item, then it means location is already exising and is of sku or item facility type. In this case throw Exception ““

         3. If response .barcodeType = null, then it means location does not exists. In this case set doesLocationExist = false

   2. Check If risk score is enabled for this account. if query result.IsRiskScoreEnabled == 1. it means riskScore is enabled

      1. If enabled, then calculate riskScore by calling risk score API in real time.

         1. If riskScore = HIGH, then set RiskScore = HIGH.

            1. send the reqest body to taskqueue.

            2. Return the response in API that "the order can't be processed due to high risk of failed delivery"

         2. if riskScore != HIGH

            1. Call label generation function. generateShippingLabel(). This function is responsible for generating label and returns the label in response.

               1. In case of error response from label generation function, return the same error in API response.

               2. If success response from label generation function :-

                  1. Pass the request body and response from label generation function in common taskqueue. orderAdditionalInfoData. This taskqueue is responsible is responsible for performing all the background work like saving order and shipment details and publishing events.

            2. Return the label details in response of the API

      2. If Risk score is not enabled

         1. Call label generation function. generateShippingLabel(). This function is responsible for generating label and returns the label in response.

            1. In case of error response from label generation function, return the same error in API response.

            2. If success response from label generation function :-

               1. Pass the request body and response from label generation function in common taskqueue. orderAdditionalInfoData. This taskqueue is responsible is responsible for performing all the background work like saving order and shipment details and publishing events.

            3. Return the label details in response of the API

Low level Explanation Of functions :-

isRequestBodyValid(requestBody)

areAllMandatoryKeysPresent()

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

doesPickupLocationBelongToNoInventoryBarcode()

1. Get pickupLocation.locationCode from request body and all mandatory address details from request body and accountSlug from session.

2. If pickupLocation.locationCode from request body is null or empty

   1. If address details (any mandatory keys) are also null or empty then throw Exception “Pickup location details unavailable. Please provide the complete address.“

   2. If address details (all mandatory keys) are present,

      1. Check if address is already present in auto-generated location. How to check if location details are already present in autogenerated location?

      2. If present then return the location details in response of the function else return null.

3. If pickupLocation.locationCode from request body is present

   1. check if pick up code is available under location with do not manage inventory in the cacheKey “shippingappByLocationCode_{accountSlug}“.

      1. If pickup code is available in cache then return the location details in response

      2. If cache doesn’t contain the location code then check using the below query and set a new cache.

         SELECT facility.barcodeType, facility.`facility`, warehouses.id FROM facility LEFT JOIN warehouses ON warehouses.facility_id = facility.id LEFT JOIN account_warehouse_mapping awm ON awm.warehouse_id = warehouses.id LEFT JOIN accounts ON accounts.id = awm.account_id WHERE facility.facility = "Testotp_TestAlphaLocation" AND accounts.account_slug = "testotp";

      3. Return the response. The response of this function will either be null or location details.

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 method assignmentOfChannelID(). This method will return the channelId which needs to be saved in orders table in DB.

      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 “channelMappingByAccountId_{accountId}“

         2. If the value from cacheKey is null, then use common query to get the result and set the data in cacheKey.

         3. Iterate over the value of cacheKey and return the channelId whose type = 'MANUAL'

      3. If the value of “channelIdis not blank, Get the value of cacheKey “channelMappingByAccountId_{accountId}“.

         1. If the value from cacheKey is null then use common query to get the result and set the data in cacheKey.

         2. Check if cacheKey contains request.channelId.

            1. If yes, then get the value of “channelID” from cacheKey and return it.

            2. If No, then throw Exception “ChannelId is Invalid“.

         Common query to set cache key “channelIdByAccountId_{accountId}”. Note that AccountId is dynamic

         SELECT externalChannelID, id, type FROM channels WHERE account_id = 1;

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

         Sample cache :- { "CH1234": { "channelId": "1234", "type": "manual" }, "CH1235": { "channelId": "1235", "type": null } }

      4. Return channel ID in response of this function.

   2. Get shipment_id from requestBody. This is the customerOrderNumber for our query

   3. Create a function fetchOrderAndShipmentDetailsQuery() which queries from DB to check for existing order and store the result in a list

      SELECT order_items.status, 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

   4. Returns the result of the query

generateShippingLabel()

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" } ] }
   success 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" } Failure Response :- { "errors": [ { "code": "400", "message": "Label couldn't be generated due to pincode not serviceable" } ] }

common taskqueue orderAdditionalInfoData

1. This is the common taskqueue where all the background (taskqueue) works will be achieved It will contain the below 3 functions :-

   1. assignmentOfLocationCode()

   2. checkIfProductAlreadyExists()

   3. saveOrderItemDetails()

   4. saveOrderDetails()

   5. saveShipmentDetails()

   6. publishShipmentEvents()
      
      

2. assignmentOfLocationCode()

   1. Get pickupLocation.locationCode from request body and all mandatory address details from request body.

   2. If pickupLocation.locationCode from request body is null or empty

      1. If address details (any mandatory keys) are also null or empty then throw Exception “Pickup location details unavailable. Please provide the complete address.“

      2. If address details (all mandatory keys) are present,
         Check if address is already present in autogenerated location
         If location is not created then Create location in Eshopbox with a auto generated ID.
         From next order onwards, verify if address is available in already created location with only do not manage inventory.
         If location is already created: use the same location code and generate shipping label

         How to check if location details are already present in autogenerated location?
         Prepare this combination from request body and store it in a String variable locationCombnation => addressLine1#addressLine2#city#state#country#pincode

         If cachekey "autoGeneratedLocationByPincode_{pincode}" value is null or empty,

         • use below query to check if location already exists or not

         SELECT * FROM facility WHERE pincode = 711411;

         • Prepare adress combinations from query result (addressLine1#addressLine2#city#state#country#pincode) and set it in value of cachekey.
           Note - cacheKey will contain the vaue in Map format. It will be unique for every pincode.

           Check in cacheKey "autoGeneratedLocationByPincode".

           { "add1#add2#city#state#country#110011": "locationCode1", "add1#add2#city#state#country#110012": "locationCode2" }

           • Check in cacheKey "autoGeneratedLocationByPincode".
             - If the value of autoGeneratedLocationByPincode containsKey locationCombnation, then it means location is already auto generated and we have to use the same locationCode.
             - If the value of autoGeneratedLocationByPincode does not contain the key locationCombnation, then it means location is not created, Call common taskqueue where a new location will be created with auto generated ID by calling the create Location API

   3. If pickupLocation.locationCode from request body is present

      1. check if pick up code is available under location with do not manage inventory in the cacheKey “shippingappByLocationCode_{accountSlug}“.

      2. If cache doesn’t contain the location code then check using the below query

         SELECT facility.barcodeType, facility.`facility`, warehouses.id FROM facility LEFT JOIN warehouses ON warehouses.facility_id = facility.id LEFT JOIN account_warehouse_mapping awm ON awm.warehouse_id = warehouses.id LEFT JOIN accounts ON accounts.id = awm.account_id WHERE facility.facility = "Testotp_TestAlphaLocation" AND accounts.account_slug = "testotp";

         1. If available,

            1. If result from query is fetched and facility.barcodeType = no_inventory then we have to create the order. set the result in cacheKey and return the cacheKey value in response

            2. If result from query is fetched and facility.barcodeType is not “no_inventory“, then throw Exception in the below given format.

               Format of Exception :- { "errors": [ { "code": "400", "message": "You can only create orders in Eshopbox for locations where inventory is not managed." } ] }

         2. If pickup location code is not available in our system,

            1. If address details (any mandatory keys) are also null or empty then throw Exception “Pickup location details unavailable. Please provide the complete address.“

            2. If address details (all mandatory keys) are present, then call common taskqueue to create location in Eshopbox with do not manage inventory.

               How to check if pick up code is available under location with do not manage inventory ?

            3. Get account slug from session and pickupLocation.locationCode from request body.

            4. Get the value of cacheKey “LocationCodeAndWarehouseMapping“ in a Map<String, Object>

            5. If the value of cacheKey is null or empty. Then use the below query to set the value. This query fetches all available locations with do not manage inventory. The cacheKey will store the value in Map<String, object> format where key = accounts.account_slug and value = accounts.warehouseId.

               SELECT facility.barcodeType, facility.`facility`, warehouses.id FROM facility LEFT JOIN warehouses ON warehouses.facility_id = facility.id LEFT JOIN account_warehouse_mapping awm ON awm.warehouse_id = warehouses.id LEFT JOIN accounts ON accounts.id = awm.account_id WHERE facility.facility = "Testotp_TestAlphaLocation" AND accounts.account_slug = "testotp";

            6. Check if the value of key requestedLocationCode exists in cache “LocationCodeAndWarehouseMapping“.

               1. If Not exists, then it means location details does not exist in our system.

               2. If exists, then it means Location details exists in our system.

                  How to create location in Eshopbox with do not manage inventory ?

            7. Call a function createNewLocation() This function will be used to create a new location whose details are in request.

               GCP Project - Staging : eshopbox-client-portal-dev ,Prod : eshopbox-client-portal-prod Project Repo - Inventory Engine - Client Portal Endpoint - PartyEndPoint 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" }

            8. Using the API response, set the value in cacheKey “LocationCodeAndWarehouseMapping“

            9. Return the value of cacheKey “LocationCodeAndWarehouseMapping”.

3. checkIfProductAlreadyExists()

   1. Create another method checkIfProductAlreadyExists().

      1. This function is to be made in common taskqueue (orderAdditionalInfoData) listener API. In this Function, pass request.itemID and order_items.id (primary key)

      2. call GET Product API

         Repo name - ESB Peoduct Engine GCP Project - esb-client-portal-prod API Path - GET 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 it means product already exists in our system. 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, then it means product does not exist in our system

            1. Call createDraftProduct() function. 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. Call create product API

                  Repo name - ESB Peoduct Engine GCP Project - esb-client-portal-prod API Path - GET 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;

4. saveOrderItemDetails()

5. saveShipmentDetails()

   1. Create object of shipments and shipment_status_logs table.

   2. Create another function - saveShipmentDetails().

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

         1. Note - Package details also needs to be saved (logic similar to location)

      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

generateShippingLabel()

6. 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" } ] }
   success 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" } Failure Response :- { "errors": [ { "code": "400", "message": "Label couldn't be generated due to pincode not serviceable" } ] }

7. If label is returned in response :-

   1. Call common taskqueue orderAdditionalInfoData. In this taskqueue lstener API, Make entry in shipment_status_logs table with packed status for this particular shipment_id. Aso update the label details in shipments table and publish event.

   2. Return the label details in response of the API.

8. If label is not returned in response,

   1. Call common taskqueue orderAdditionalInfoData. In this taskqueue lstener API, then make entry in shipment_status_logs table with “failed_to_rts“ status for this particular shipment_id and publish event

   2. return the same response of label API to client after adding a key “errorMessage“ in response.

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

Frequetly Asked Questions

• Which events will be generated?

  • shipment create, failed_to_rts and packed events

• Should the order be reflected in the process order section?

  • Yes

• How do we realize this is the same or different location?

  • Logic is given below in Excel sheet. (Implementation logic I am deciding as of now)

• What happens if the shipment details are edited? and the shipment was infailed to rts in eshopbox.

  • we will generate label with the previous shipment details

• Double check on if same order is called for label generation on clickpost then does it give error like Order is already created?

  • Same label is returned by clickpost with an additional message “You have already placed this order.” along with the reference number.

• Check if different pincode is passed and a different city, does it give error in clickpost ?

  • Order got created with correct city state against the pincode, even if wrong details were provided when creating the order.

• If the order is already existing and is in ONHOLD status, then what is to be done ?
  ANS) => If status is ONHOLD => give error; if status is NOT ONHOLD but riskScore is high => give label
  Note - risk score will not work if order is created using this api

• If risk score is high for an order, then do we have to return label ?

  • If status is ONHOLD => give error; if status is NOT ONHOLD but riskScore is high => give label

• As these orders are to be created in flex, we have to send shipment created event and handling to be done in reconsitaion flow too

  • Currently Flex picks only those shipments which are in created status, need to add check for Failed to RTS and Ready to ship as well.

• if location code exists in our system , then other details not mandatory and vice-versa.

  If location code exists but location details are different, then what is to be done ?

  • Same logic will be applied to packaging code.Same logic to packaging code.

• Vice-versa RTS flow from both OMS

  • Yes, flex can also pack the shipment as well as the channel from which the order originated can pack the order

• Cache mechanism.

• Whether product details exists or not ? can we check in taskqueue by calling product API?

  • Yes

• Check shiprocket for partial item fulfilment after failed to RTS: Create order with multiple items > Failed to RTS > Cancel partial item > Update the address > Request label. Check items in Shiprocket.

  • Address needs to be manually updated in Shiprocket, Address is not updated automatically is order is already created in Shiprocket. And shiprocket provided shipping label of 3 items.

• Clcikpost check when pincode and city state does not map:

  • Order got created with correct city state against the pincode, even if wrong details were provided when creating the order.

• On hold order requested for label.

  • Pass error “The order is on hold due to (high risk of failed delivery/customer address not serviceable). Please release the order from Eshopbox workspace, to generate shipping label.”

• High risk order on Shiprocket

  • Risk score is not calculated on the order which are created directly requesting for shipping label.

• If product is already created in Eshopbox, and HSN code or any other details is different in the order create API.

  • The product is not updated, but  the details against the orders are reflected of the updated product available in the API.

• Clickpost error message mapping for last 90 days

• Location configuration (do not track)

• Custom sales channel integration with Eshopbox shipping App article

• To be eligible for weight overcharge protection program for Eshobpox shipping app.