Rate Calculator using Fees-Creation

What is the purpose of this article?

This article aims to make the reader understand how the backend logic is used to calculate the shipping charges from the warehouse's location to the customer's location based on:

1. Shipment weight,

2. Warehouse and Customer pincodes,

3. Courier type (Standard, Express or Priority),

4. Journey type (Forward, Reverse or Return-to-Origin) and

5. Payment Method

Based on the shipping charges, clients can decide the courier they want to ship the order.

Fees Creation

If the user wants to use different fees for a different client, he needs to create fees mentioned below :

If you want a detailed desiption please refer below link

Payments Team

Rate Calculator Figma

Code Implementation Details

Request Body

Fetching Data

1. Verify the request body is correct.

2. Use fees-types table to create a map in Constants file FEES_ID_NAME_MAP to map every fees with corresponding localId as the key.

3. Fetch portalId of from portals table using externalPortalId=“EBSH"

   1. DB: 35.200.149.199 ➤ eshopbox_client_portal_dev

4. Using accountId,portalId and feesNameList fetch fees details from fees table and fee_portal_mapping table using below query

   1. DB: 35.200.133.164 ➤ eshopbox_wms_dev

   2. SELECT fee_portal_mapping.id, fee_portal_mapping.fee_id, fee_portal_mapping.version, fee_portal_mapping.is_inclusive_tax, fee_portal_mapping.inclusive_tax_percentage, fee_portal_mapping.fixedApplicableOn, fee_portal_mapping.percentageApplicableOn, fee_portal_mapping.dependsOn FROM fees LEFT JOIN fee_portal_mapping ON fee_portal_mapping.fee_id = fees.id WHERE fees.portal_id = :portalId AND fees.account_id = :accountId AND (fees.name IN (:feesNameList) OR fees.actual_name IN (:feesNameList))

5. Using the portalId, fee_id and and version from table to fetch latest and actual fees values from per_fee_ruletable in Mongo DB ➤ payment-reco-dev

6. If the total count of fees is not 25 in either of step 4 or 5, then also fetch fees for accountId=5 .

7. Use the keys from FEES_ID_NAME_MAP and above values from mongo server to create a feesValueMap map.

   1. Sample data structure in Mongo:

   2. { "_id": { "ObjectId": "660be783d8dc732d617dffba" }, "paymentMethod": "cod", "fixed": 54, "fixedApplicableOn": "Per Shipment", "percentage": 1.5, "percentageApplicableOn": "Per Shipment", "feeRuleConditionId": "66069f550b2fd0251e578ad0", "feeRulesStatus": "", "shippingZone": "local", "weightrange": { "unit": "kg", "min": 0, "max": 0.5 }, "variable": 22, "variableApplicableOn": "Per Shipment", "partitionRange": 0.5, "partitionRangeType": "kg", "feePortalId": 1499, "version": 1.1, "feeId": 315, "portalId": 51 }

   3. We have to use either fixed, percentage or variable key value

Base-Rate-Calculation

1. Based on pickup pincode and drop pincode, calculate the zone if not present in request body.

2. Based on the zone and order weight, fetch correct fees from feesValueMap

   1. Example: If Weight = 3600 gm & Zone='Metro' then fees Type used will be:

   2. Open

      

   3. From above fees types we know starting keys is 8

3. Run a outer loop on the fees fetched, till weight reaches in correct weight range and in each iteration:

   1. Calculate number of slabs = (maxWeight - minWeight) / partitionRange

   2. Run a inner loop on the slabs

      1. add weight for each slab and

      2. add actual value i.e. variable in this case

      3. if added_weight >= actual_weight then break the outer loop

Additional Fees Creation

1. Add fuel and base charges to shippingCharges as it is not dependent on any parameter

2. If courier type = express or priority, then

   1. Calculate and add express charges to shippingCharges

   2. Set express charges

3. If courier type =”standard”, then

   1. Set express charges = 0

4. Add estimatedDeliveryTimeInDays based on the courier type and data from zone_courier_type_tats table in wms database.

5. If payment method = “cod” or “cash on delivery”, then

   1. Calculate max of either fixed COD charges or percent of shipment invoice (codAmountToBeCollected)

   2. Add COD charges to shippingCharges

   3. Set COD charges

6. If payment method = “prepaid”

   1. Set COD charges = 0

7. If journey type = “forward” or “return to origin” then

   1. Set Quality Check charges = 0, and

   2. Set Customer initiated return charges = 0

   3. In case of “return to origin”,

      1. substract the cod charges(if added) from shippingCharges

      2. Double the shippingCharges and store in shippingCharges

8. If journey type = “reverse”, then,

   1. If Quality check at the doorstep is true, then

      1. Calculate and add Quality check charges to shippingCharges

      2. Set quality check charges

   2. Calculate and add Customer initiated return charges to shippingCharges

   3. Set Customer initiated return charges

9. Set shippingCharges

10. Calculate 18.0% GST of shippingCharges

11. Set Total charges = shippingCharges + GST

Possible response with eshop auth token