RETURN APPROVAL FLOW

What is the purpose of this article?

This article contains step-wise logic and flow of Return Approval flow by client in workspace.

What are the steps to achieve this task ?

• WORKSPACE :
  step 1 : when a client wants to approve return
  1.1. by interactive method
  1.2. by bulk method (applied filters)
  1.3. by import
  step 2 : client will enter his/her approval reason.
  step 3 : When client clicks on Approve return button, the frontend will send the request

  HTTP Method: POST API PATH: “https://{{workspace}}.{{envBasedDomain}}/api/v1/returns/approval/{{module}}“ REQUEST BODY : { "orderType": "COD", "promiseDeliveryDate": "", "orderId": "46418190", "dropData": "{\"dropContactPhoneNo\":\"7042443113\",\"dropAddress2\":\"Village Babra Bakirpur, Pataudi Road Near Adani Logistic Park, ICD Patli, Gurgaon, Haryana(122503)\",\"dropAddress1\":\"MJ Logistics Private Limited, Seabird Marine Services Pvt Ltd\",\"dropCustomerName\":\"Eshopbox Patli Gurgaon\",\"dropInPinCode\":\"122503\",\"dropState\":\"Haryana\",\"dropCity\":\"Gurgaon\",\"dropCountry\":\"India\"}", "discount": "0.0", "customerOrderNumber": "AGGN00025", "reversePickupReason": "", "productName": "1049297", "mode": "", "isCOD": "1", "billingCustomerName": "Sunisha Paul", "customerReturnNo": "R20651673519442860", "channelSlug": "welspun", "returnShipmentId": "1579771", "refundBankAccountDetails": "", "previousOrderItemId": "28071503", "sku": "97U5D3H176Q", "productImageUrl": "https://i.postimg.cc/9MWF89Pp/1049297.jpg", "shippingCharges": "28.86", "invoiceTotal": "528.86", "itemId": "97U5D3H176Q", "accountId": "725", "taxRate": "0.0", "warehouseId": "650", "isExchange": "1", "taxAmount": "0.0", "pickUpData": "{\"pickUpEmail\":\"sunisha.paul@gmail.com\",\"pickUpCustomerName\":\"Sunisha Paul\",\"pickUpPinCountryName\":\"IN\",\"pickUpContactPhone\":\"9744673837\",\"pickUpAddressLine2\":\"\",\"pickUpAddressLine1\":\"Q 082, DLF New Town Heights, Opp. TV Centre, Seaport Airport Road, Kakkanad, Kochi\",\"pickUpPinCode\":\"682037\",\"pickUpCountryCode\":\"IN\",\"pickUpCity\":\"Cochin\",\"pickUpState\":\"KL\"}", "productAdditionalInfo": "", "promiseShipDate": "2022-09-26 07:15:50.0", "externalChannelId": "CH2065", "newProductAdditionalInfo": "", "lineItemTotal": "500.0", "gstin": "06AAFCB0498R2Z2", "returnReason": "", "accountSlug": "welspun", "channelId": "2065", "email": "sunisha.paul@gmail.com", "quantity": "1", "orderItemId": "AGGN00025-28071503", "refundReason": "Change of Mind", "mobile": "9744673837", "customerPrice": "500.0", "orderTotal": "898.0", "cancellationPolicyCode": "", "reversePickUpCreatedDate": "", "originalOrderItemId": "0", "exchangeSize": "1058792", "lineItemSequenceNumber": "9804897", "asin": "", "productUrl": "" }

  After this pickup API will be called.

• CUSTOMER PORTAL :
  step 1 : when pickup API is called fetch product details from product API to calculate dimensions and weight then call recommendation API.
  step 2 : once courier partner has been picked from recommendation API called clickpost manifest API to create return on clickpost.
  step 3 : on success save accepted status in return shipment status log along with tracking id and other relevant details (eg : cpid..).
  step 4 : publish an event of return accepted for activities.

SEQUENCE DIAGRAM FOR RETURN APPROVAL BY CLIENT ON WORKSPACE :

Open