Inventory Allocation Rule (PHP-JAVA)

• Inventory Allocation Rule API (request + url to be added)

• Response of API to be added .

• Sequence diagram

• Database + Tables + Queries to be used in Inventory Allocation Rule

• Resources used such as GCP project, service, Clickpost API etc.

• API to consist of :-

  • Inventory Allocation rule

  • pincode serviceable rule

  • RTS TAT for integration type 4, 7

Item 1 (40 Qty) - M, K, G

Item 2 (5 Qty) - G

Item 3 (15 Qty) - G

What is the purpose of this article?

The purpose of this article is to inform Warehouse Management System (WMS) that in which warehouses the products are out of Stock. This will keep our clients updated about out of Stock orders ( unfulfillable orders ). And they can send inventory for only those items which are unfulfillable.
In this article, we will thoroughly discuss how we can inform our warehouse if the inventory is not available in the warehouse and on which basis and its infrastructure diagram.

What is the approach to achieve this task ?

We are taking the below approach to achieve this task.

1. WMS will provide us a request body mentioning the externalChannelID, shippingAddress, Items and their quantity.

2. For those items, we need to inform them from which warehouse we have picked up their inventory (Inventory will be picked up on a priority basis if available in more than 1 warehouse). This is termed as Inventory Allocation Rule.

3. Using this information, WMS will create shipments for those order items or mark them as unfulfillable on workspace through which the client will come above the status of the product and can send more products in warehouse if needed.

Sequence diagram for the approach taken for Inventory Allocation Rule

Open

What are the technical steps to achieve the above task ?

1. After order is created in WMS, a request body is prepared and sent
   to POST Api api/v2/inventoryAllocation in ESB-CLIENT-ORDER-RETURN project.

• API Request Body Structures Below(to be sent by WMS):

  {     "externalChannelID": "CH1299",     "customerOrderNumber": "4571602911385",     "shippingAddress": {         "city": "Churcha colliery",         "countryCode": "IN",         "postalCode": "497339",         "addressLine1": "Shreya poultry farm, Ward number 06",         "addressLine2": "East nepal gate, Near balaji beauty parlour",         "countryName": "INDIA",         "state": "Chhattisgarh",         "contactPhone": "9131786078",         "customerName": "Anamika  Dad",         "email": "nomailprovided@gmail.com"     },     "integrationType": "7",     "items": [         {             "itemID": "44372319699097",             "quantity": 1         }     ] }

• Now verify if the request body is correct and if found correct then pass it in the taskqueue to run inventory allocation rule and create shipment.

  • Checks for verifying request body - request body must contain externalChannelId, state and itemIdList

    To be changed later taskqueue name - shipment-additional-details-queue path- /_ah/api/esb/v2/shipmentAdditionalInfoData

2.Now in the taskqueue listener Api, Based on externalChannelID and state sent in request body, find the channel ids and zone priority respectively.

3. Fetch all the active warehouses in zonepriority basis along with their externalWarehouseID and facility.type

4. Store the prioritywise found warehouseIDS in an array.

5. Now check if the item is of virtual kit or non virtual kit. Write a query as follows.

6. If itemID are having isVirtualKit = 1, then for those items, Based on itemID, warehouse_id and channel id found from the above queries, write a query to fetch the number of inventories present in warehouseId. Write query from inventories table, pass all warehouse ids irrespective of facilityType.

7. If itemID are having isVirtualKit = 0,

• if facilityType is auperator then for those items, Based on skus and externalWarehouseID found from the above queries, fetch the number of good inventories present there.

• if if facilityType is not auperator , then for those items, Based on itemID, warehouse_id and channel id and non auperator itemIDs found from the above queries, write a query to fetch the number of inventories present in warehouseId . write query from inventories table, pass only those warehouse ids which are of non auperator type.

8. Combine all the data in one map.

9. Based on warehouse priority which was set in array, keep iterating and check their inventory and set the details accordingly.

• if “inventories.inventory = 0“ OR “warehouse_inventories.good_inventory = 0" or then then set outOfStock = true

• else if "warehouse_inventories.good_inventory != 0" OR “inventories.inventory != 0“, then check :-

  • if inventoy >= requested item quantity

  • if true , set outOfStock = false

  • prepare response body

  • if false,

    • Check how many inventories can be found, for inventories available set outOfStock = false else set set outOfStock = true

• EXAMPLES

  request body :- "items": [         {             "itemID": "44372319699097",             "quantity": 1         }     ] response body : "items": [         {             "itemID": 44372319699097,             "externalWarehouseID": "Eshopbox_Mumbai",             "quantity": 1,             "outOfStock": "false"         }     ]

10. Check for pincode serviceability by calling the pincode serviceability API from POE Backend Service.

• if pincode = serviceable, then set "isServiceable" : "true",

• if pincode = not serviceable, then set "isServiceable" : "false",

11. Now prepare a response body as shown below :-

Note - if inventory is not available in any warehouse then shipment is to be created as sidelined.

API Response Body for POST: api/v2/inventoryAllocation (to be sent back to WMS)

TEST CASES TO CHECK INVENTORIES

Open

Code for Sequence Diagram ?

Open