/
Seller/Admin Actions on Weight discrepency

Seller/Admin Actions on Weight discrepency

Owned by Saurav Kumar Ram
Last updated: Mar 26, 2024
4 min read

What is the purpose of this article?

This article aims to develop an API that would allow clients(sellers) and Eshopbox users to take necessary actions on an order (shipment) for which a weight discrepancy has been raised.

This is required because sellers provide the weight and dimensions of the product while creating products in Eshopbox. As these details are not verified, issues like weight discrepancies and inaccurate shipping charges get applied. To resolve these issues, sellers raise disputes via email if they believe the shipping charges are inaccurate. This takes a lot of time and effort to get it corrected and to apply a correct shipping charge.

Thus, the idea behind resolving this issue is to develop the API which would onsolidate all details and workflow within the workspace.

Figma

https://www.figma.com/proto/LURem3BZz7dFNbUTvN6hDj/WIP-%7C-Nov-2023?page-id=704%3A12680&type=design&node-id=1887-18237&viewport=2014%2C9098%2C0.28&t=2WyzjI2IHpxVRSKE-1&scaling=min-zoom

Basic points to keep in Mind

  1. When Weight discrepancy is created by an Eshopbox user, status will NEW.
    On the sidebar ACCEPT and DISPUTE will be visible to the seller.

    1. If Seller accepts it then entry will happen in logs table with status - not_disputed
      Status on UI will change from NEW to LOST

    2. If seller clicks on dispute then entry will happen in logs table with status - disputed.
      Status on UI will change from NEW to DISPUTED

      1. Since DISPUTE has been raised, now the work of Eshopbox user (admin) will begin. On UI, there will be 2 options visible - ACCEPT and REJECT

        1. If ESB user accepts it, then entry will happen in logs table with status WON
          Status on UI will change from DISPUTED to WON

        2. If ESB user rejects it, then entry will happen in logs table with status LOST
          Status on UI will change from DISPUTED to LOST

          On the sidebar ESCALATE will be visible for next 2 days. This is because since eshopbox has rejected the dispute and seller has LOST, they can escalate.

          When seller escalates, then entry will happen in logs table with status escalate
          UI status will remain as LOST but on the sidebar ESCALATED will also be visible
          Now for Eshopbox users, again 2 options- ACCEPT and REJECT will be visible.

          1. If ESB user accepts it, then the entry will happen in the logs table with the status WON
            The status on UI will change from LOST to WON and ESCALATED will not be visible anymore.

          2. If ESB user rejects it, then the entry will happen in the logs table with the status LOST
            Status on UI will remain LOST and ESCALATED will not be visible any more.

  2. Note:-

    1. The seller can raise dispute/escalate only once.

    2. The seller can raise dispute/escalate only within 2 days after discrepancy is created

What are the steps to achieving this task?

  1. Frontend will send the below request body in PUT /weightDiscrepencyAPI in WeightDiscrepency Endpoint of shipping service project

    API Path - PUT https://auth.auperator.co/shipping/api/esb/v1/wightDiscrepency Authorization - <Bearer> token

    1. Request body for dispute raised by seller (always single request)

      { "weightDiscrepancyId": [1], "actionType": "disputed", "additionalDetails": { "packageLength": "https://s3-eu-west-1.amazonaws.com/imagebucketeshopbox/Flipkart1/rcsq01511-v8/(1).jpg", "packageWidth": "https://i.postimg.cc/7ZM3sfCL/1058540-1.jpg", "otherAttachment": ["https://s3-eu-west-1.amazonaws.com/imagebucketeshopbox/Flipkart1/rcsq01511-v8/(1).jpg", "https://i.postimg.cc/7ZM3sfCL/1058540-1.jpg"], } "reason" : "", "remarks" : "", "filters" : "" }

    2. Request body for accept raised by seller (single or bulk)

      { "actionType": "not_disputed", "externalUpdatedAt" : "2024-03-14 18:11:02", "weightDiscrepancyId": [1,2] }

    3. Request body for escalate raised by seller (always single)

      { "weightDiscrepancyId": "1", "actionType": "escalated", "additionalDetails": { "otherAttachment": ["https://s3-eu-west-1.amazonaws.com/imagebucketeshopbox/Flipkart1/rcsq01511-v8/(1).jpg", "https://i.postimg.cc/7ZM3sfCL/1058540-1.jpg"], }, "externalUpdatedAt" : "2024-03-14 18:11:02", "remarks" : "" }

      1. Request body for accept raised by admin (single and bulk (for bulk a new API will be made which will update data in taskqueue))

        { "weightDiscrepancyId": [1], "actionType": "won", "additionalDetails": { "otherAttachment": ["https://s3-eu-west-1.amazonaws.com/imagebucketeshopbox/Flipkart1/rcsq01511-v8/(1).jpg", "https://i.postimg.cc/7ZM3sfCL/1058540-1.jpg"], }, "externalUpdatedAt" : "2024-03-14 18:11:02", "remarks" : "" }

    4. Request body for reject raised by admin (single and bulk (for bulk a new API will be made which will update data in taskqueue))

      { "weightDiscrepancyId": "1", "actionType": "lost", "additionalDetails": { "otherAttachment": ["https://s3-eu-west-1.amazonaws.com/imagebucketeshopbox/Flipkart1/rcsq01511-v8/(1).jpg", "https://i.postimg.cc/7ZM3sfCL/1058540-1.jpg"], }, "externalUpdatedAt" : "2024-03-14 18:11:02", "remarks" : "" }

  2. Prepare a request DTO for the request body

    import java.util.HashMap; import java.util.Map; public class weightDiscrepencyRequestDTO { private String weightDiscrepancyId; private String actionType; private Map<String, String> additionalDetails; private Map<String, String> otherAttachments; private String externalUpdatedAt; private String remarks; private String emailId; private string userId; private string accountId; }

  3. From the Authorization token, get the email id, user id and account id and set then in the request DTO

  4. IsRequestBodyValid(). In this function check if the request body is valid

  5. Call a function updateDataByActionTypes(requestDTO). This function will be developed in service layer. Perform the below tasks in this function.

    1. Prepare a model class weightDiscrepencyModel for weight_descrepency_status_logs table

    2. Define an empty variable List<weightDiscrepencyModel> modelList.

    3. Call a function prepareModelOnTheBasisOfActionType. This function will be developed in helper layer.

      1. If requestDTO.actionType == not_disputed, then Iterate over the List of requestDTO.weightDiscrepancyId and keep setting the details from request in modelList

      2. If requestDTO.actionType == won/disputed/lost/escalate, then set the details from request in modelList

    4. Save in DB - Once the model list is prepared, call a function saveModelInDB(modelList). This function will be prepared in dao layer where I will use hibernate method of saveOrUpdate to save the modelList in DB.

    5. Prepare response by calling Snehal function - The response should be same as that of GET API.

    6. Publish Event in a new topic - weightDiscrepencyStatusEvent

      { "resource" : "weightDescrepency", "eventType" : "POST", "eventSubType" : "new/disputed (currentStatus)", "accountSlug" : "eshop/any other account, "actor" : "system (for eshopbox account), for brand client email, "response_data" : "" }

    7. Return response to frontend

Add label

Related content