What is the purpose of this article?

The purpose of this document is to allow the user it change the location of the order items in UI to make them ship from the desired location before they already shipped. The benefit of this is that clients can choose the nearest warehouse which will save high shipping costs as well as order delivery time.

In this technical document, we will discuss the step-by-step implementation logic to achieve the desired task in the backend.

PRD with Figma

Change location PRD

Project And API Details

What is the basic approach to achieving this task?

Steps to achieve the above task

1. The user changes the location on UI and clicks on the save button.

2. Frontend sends the request body to the backend

   1. The request contains the new warehouse name and all those order items of the existing shipment with their shipment ID whose location is to be changed.

      REQUEST BODY :- { "account": "blackberrys", "customerOrderNumber": "3a23131b-72cc-4eab-9c17-2bb310b4665c", "vendorOrderNumber": "3a23131b-72cc-4eab-9c17-2bb310b4665c", "channelId": "2373", "accountId": "12", "newExternalWarehouseId": "Delhi Fc", "shipment": [ { "externalShipmentId": "433-4536456757-1253", "orderItemIds": [ "o1","o2","o3"] }, { "externalShipmentId": "433-4536456758-2673", "orderItemIds": [ "oi1","oi2","oi3"] } ] }

3. Iterate over the List of shipment

   1. Get the first shipment with its order items.

      e.g., { "externalShipmentId": "433-4536456757-1253", "orderItemIds": [ "o1","o2","o3"] }

      1. Cancel the existing shipment whose any of the items' location is to be changed. It means updating their order_items.shipment_id to 0 and shipment_status_logs.status = 'cancelled'.

         1. Prepare and publish event at inventory service pub-sub topic for inventory to get adjusted

            PUB/SUB Details :- topic name -

      2. Prepare an FC-wise list of requested order items whose location is to be changed to the new Ex warehouse ID.

         e.g., {new Ex warehouse id} = ["o1","o2","o3"]

         Here "o1", "o2", "o3", "oi1", "oi2", "oi3" are the items whose location is to be changed to the new Ex warehouse id.

      3. Prepare another list of the pending items in this existing shipment whose location was not requested to be changed.

         e.g., {existingShipmentId##oldExWarehouseId} = ["o4","o5","o6"]

   2. Now get the second shipment with its order items

      1. Updating their order_items.shipment_id to 0 and shipment_status_logs.status = 'cancelled'

         1. Prepare and publish event at inventory service pubsub for inventory to get adjusted

      2. Append the order items whose location is to be changed to new Ex warehouse id in the previous created list

         e.g., {new Ex warehouse id} = ["o1","o2","o3","oi1","oi2","oi3"]

      3. Prepare another list of the pending items in this existing shipment whose location was not requested to be changed.

         e.g., {existingShipmentId##oldExWarehouseId} = ["oi7","oi8","o9"]

4. When the iteration is completed, cancel all those shipments that were

   1. previously created from the requested newExternalWarehouseId

   2. status is not cancelled or ready to ship.
      Append all those shipment items to the previously created list of new Ex warehouse id

      e.g., {new Ex warehouse id} = ["o1","o2","o3","oi1","oi2","oi3","oldItem1","oldItem2"]

5. Prepare the new request body and pass it in the existing inventory allocation API to make their shipment. (Pending to be discussed)

   1. I have attached the present time request body. At present, we get the externalWarehouseId at root level as well as item level.
      Check line number 40 for root level

      { "order_data": { "orderType": "import", "vendorOrderNumber": "TestWouse1", "balanceDue": 0.0, "externalChannelID": "CH5865", "origin": "import", "customerOrderNumber": "TestWouse1", "orderTotal": 3950.0, "paymentType": "Prepaid", "isCOD": 0.0, "subtotal": 3900.0, "shipMethod": "STD", "accountSlug": "tab", "shippingAddress": { "city": "Ranchi", "countryCode": "IN", "postalCode": "835210", "addressLine1": "Infront of sahoo engg works", "countryName": "IN", "state": "Jharkhand", "contactPhone": "8340471229", "customerName": "saurav", "email": "saurav.kumar@eshopbox.com" }, "thirdPartyShipping": false, "billingAddress": { "city": "Khunti", "countryCode": "IN", "postalCode": "835210", "addressLine1": "Infront of sahoo engg works", "countryName": "IN", "state": "Jharkhand", "contactPhone": "8340471229", "customerName": "saurav", "email": "saurav.kumar@eshopbox.com" }, "taxAmount": 0.0, "orderDate": "2023-09-28 13:06:56", "externalWarehouseID": "Tab_InwardTest123", "items": [ { "productImageUrl": "https://cdn.filestackcontent.com/z1guh2R8TFuF30rlncQ8", "quantity": 1.0, "giftMessage": "Happy Birthday.", "discount": 7238.0, "lineItemTotal": 650.0, "isVirtualKit": "0", "shipCharge": 8.333333333333334, "customerPrice": 7888.0, "productName": "Multi color jersey tee", "itemID": "ProductNotExpired", "giftWrapCharges": 0.0, "lineItemSequenceNumber": "1", "isGift": true, "taxAmount": 0.0, "sku": "EDLAH3FOGH3", "externalWarehouseID": "Tab_InwardTest123" }, { "productImageUrl": "https://cdn.filestackcontent.com/z1guh2R8TFuF30rlncQ8", "quantity": 1.0, "giftMessage": "Happy Birthday.", "discount": 7238.0, "lineItemTotal": 650.0, "isVirtualKit": "0", "shipCharge": 8.333333333333334, "customerPrice": 7888.0, "productName": "Multi color jersey tee", "itemID": "ProductNotExpired", "giftWrapCharges": 0.0, "lineItemSequenceNumber": "2", "isGift": true, "taxAmount": 0.0, "sku": "EDLAH3FOGH3", "externalWarehouseID": "Tab_InwardTest123" }, { "productImageUrl": "https://cdn.filestackcontent.com/z1guh2R8TFuF30rlncQ8", "quantity": 1.0, "giftMessage": "Happy Birthday.", "discount": 7238.0, "lineItemTotal": 650.0, "isVirtualKit": "0", "shipCharge": 8.333333333333334, "customerPrice": 7888.0, "productName": "Multi color jersey tee", "itemID": "ProductNotExpired", "giftWrapCharges": 0.0, "lineItemSequenceNumber": "3", "isGift": true, "taxAmount": 0.0, "sku": "EDLAH3FOGH3", "externalWarehouseID": "Tab_InwardTest123" }, { "productImageUrl": "https://cdn.filestackcontent.com/JQaCQEfTQpe2Jh4PdNwG", "quantity": 1.0, "giftMessage": "Happy Birthday.", "discount": 225.0, "lineItemTotal": 975.0, "isVirtualKit": "0", "shipCharge": 12.5, "customerPrice": 1200.0, "productName": "Multi color jersey tee", "itemID": "ASHIUNICOM", "giftWrapCharges": 0.0, "lineItemSequenceNumber": "4", "isGift": true, "taxAmount": 0.0, "sku": "OMC9V3FODSE", "externalWarehouseID": "Tab_InwardTest123" }, { "productImageUrl": "https://cdn.filestackcontent.com/JQaCQEfTQpe2Jh4PdNwG", "quantity": 1.0, "giftMessage": "Happy Birthday.", "discount": 225.0, "lineItemTotal": 975.0, "isVirtualKit": "0", "shipCharge": 12.5, "customerPrice": 1200.0, "productName": "Multi color jersey tee", "itemID": "ASHIUNICOM", "giftWrapCharges": 0.0, "lineItemSequenceNumber": "5", "isGift": true, "taxAmount": 0.0, "sku": "OMC9V3FODSE", "externalWarehouseID": "Tab_InwardTest123" } ], "shipChargeAmount": 50.0 }, "account_id": 758.0, "account_slug": "tab", "channel_id": 5865.0, "integrationType": "4" }

6. Update the productAdditionalInfo column of all the order items from the prepared list that have been assigned a new location. Add a new key “defaultLocation“ in it.