/
Cancellation IN TRANSIT

Cancellation IN TRANSIT

Owned by Lakshay Aggarwal (Unlicensed)
Last updated: Jan 16, 2024
4 min read

Goal:

Currently, customer/clients do not have any option to cancel the item after it is packed, introducing this new feature customers will be able to cancel the item after “packed”

How are we going to achieve this?

Following are steps which we are going to achieve in this flow:

  1. POE Settings customer portal giving an option to clients where than select and update whether they want to allow customer option to cancel an order when in “in transit”

  2. If yes accordingly when the status on the workspace is “on the way” which includes multiple statuses mapped with the same if that is the case and settings are enabled then the customer would get an option to cancel the order while it is “in transit” and no “out of delivery”.

  3. Based on the above we will call click post “

https://docs.clickpost.ai/docs/cancellation ” cancellation API which will give either of the responses - success or failure based on the API response we need to act and update the same status on the workspace as follows:

a. if successful then update the status and create a return for the same as it will be treated as customer/courier return and update activities as well, exports handling as well

b. if failure then the same reason to be reflected on the customer portal for the frontend

Steps to achieve:

  1. POE Settings - customer portal add new reason field in Returns tab “cancellation in transit”

    1. Frontend need to update the same by taking action from the user and updating using the same POST /poe-settings API with an updated response

    2. It will automatically update poe_channel_settings.cancellationReasons column with updated value

  2. On the basis of cancellation reasons we need to create a new POE BACKEND POST API /cancel-order/in-transit

Request Body for cancellation API: { "actor": "lakshay.aggarwal@eshopbox.com", "externalChannelID": "CH5977", "customerOrderNumber": "TORDS0125", "reason": "Flagged as Fraudulent order", "source": "Customer Portal/Workspace", "remarks": "customer_cancel", "notifyCustomer": true, "items": [ { "orderItemID": "TORDS0125-30329411", "itemID": "SK101", "quantity": 1, "remark": "Random test" } ] }
Response { "orderDetails": { "portalName": "Shopify", "channelId": "5977", "saleChannel": "CH5977", "subChannel": "CH5977", "orderId": "44213183", "integrationType": "7", "isCod": "1", "orderDate": "1704768573000" }, "currentOrderStatus": "Cancelled", "orderCancellationData": { "status": "success" }, "orderItemID": "TORDS0125-30329411", "cancellationDetails": { "type": "Customer", "reason": "Flagged as Fraudulent order", "additionalRemarks": "Random test" }, "orderStatus": "Cancelled", "orderCancelledTimestamp": "1705042651000" }

  1. We will internally call click post GET <https://www.clickpost.in/api/v1/cancel-order/?username=test-account&key=00000000-0000-0000-0000-000000000000&waybill=TESTAWB000001&account_code=test_account> if:

    1. API returns success then we will update shipment_status_logs with rto entry and publish rto event

      rto event body: { "resource": "shipment", "eventType": "PUT", "eventSubType": "rto", "accountSlug": "dfc", "accountId": null, "actor": "SYSTEM", "version": "v1", "request_data": [], "response_data": { "customerOrderNumber": "TestLabel4", "orderSiteID": null, "vendorOrderNumber": "TestLabel4", "externalShipmentID": "TestLabel4-5977-3613", "externalWarehouseID": "Dfc_MUM101", "externalChannelID": "CH5977", "externalWmsChannelName": "AUPERATOR_SHOPIFY_DFC_MUM101_2173", "external_wms_channel_id": 2173, "channelLabel": "Shopify", "integrationType": "7", "barcodeType": "item", "vendorPartyID": null, "partner_as2_id": null, "defaultWarehouseCode": "Dfc_MUM101", "facilityLabel": "MFCS(MUM101)", "facilityType": "auperator", "orderDate": "2023-12-19 09:22:14", "portal_id": 37, "paymentType": "COD", "expectedShipDate": "2023-12-20 12:00:00", "dispatchAfterDate": null, "externalManifestNumber": null, "channelManifestNumber": null, "order_id": 44212810, "channel_id": 5977, "warehouse_id": 906, "channel_account_id": 0, "account_id": 1489, "connectionId": 2695, "locationId": "83448791336", "region": "National", "isMetro": "0", "isSpecialplace": "0", "shippingConnectionId": 0, "picklistCode": null, "invoiceNumber": "INVDFCM45", "boxType": "UNKNOWN", "isPriorityShipment": "0", "isGift": "0", "invoice_url": "https://storage.googleapis.com/invoicefiles-staging/invoice/TestLabel459773613-1702978423656.pdf", "invoiceDate": "2023-12-19 15:03:36", "label_url": "https://storage.googleapis.com/eshopbox_wms_uploads_staging/myntraLabel/20231219150350273525617.pdf", "labels": "", "shippingInfo": [], "boxAdditionalRecommendation": [], "dimension_length": "10", "dimension_width": "10", "dimension_height": "10", "weight": "400", "chargeableWeight": 400, "trackingID": "TestLabel4-5977-3613", "trackingDomain": "", "packageID": "", "barcode": "", "taxAmount": 0, "shipChargeAmount": null, "courierName": "SELF", "cp_id": 0, "created_at": "2023-12-19 14:52:21", "updated_at": "2023-12-19 15:03:51", "status": "rto", "remarks": "manual update - rto", "warehousePincode": "273001", "thirdPartyShipping": false, "customerName": "Mituj", "customerContactNumber": "9711166382", "email": "mituj@eshopbox.com", "channelSlug": "dfc72", "status_updated_at": "2024-01-11 15:55:50", "status_log": { "created": "2023-12-19 14:52:21", "packed": "2023-12-19 15:03:51", "out_for_delivery": "2023-12-21 11:04:17", "failed_delivery": "2023-12-21 11:10:49", "rto": "2024-01-11 15:55:50" }, "status_log_first_occurrence": { "rto": "2024-01-11 15:55:50", "failed_delivery": "2023-12-21 11:10:49", "out_for_delivery": "2023-12-21 11:04:17", "packed": "2023-12-19 15:03:51", "created": "2023-12-19 14:52:21" }, "status_log_count": { "created": 1, "packed": 1, "out_for_delivery": 1, "failed_delivery": 1, "rto": 1 }, "status_log_id": "254642170", "orderExternalCreatedAt": "2023-12-19 14:52:16", "riskScore": "Medium", "riskScoreReasons": [ "Address issue", "Suspicious behaviour" ], "pincodeServiceableRemarks": null, "shippingAddress": { "customerName": "Mituj", "addressLine1": "House 168", "addressLine2": null, "city": "South West Delhi", "state": "Delhi", "postalCode": "110061", "countryCode": "IN", "countryName": "IN", "contactPhone": "9711166382", "email": "mituj@eshopbox.com" }, "warehouseAddress": { "addressLine1": "Gorakhpur", "addressLine2": "Gorakhpur", "city": "gorakhpur", "state": "UTTAR PRADESH", "postalCode": "273001", "gstin": "27AAACC1206D1ZG" }, "billingAddress": { "customerName": "Mituj", "email": "mituj@eshopbox.com", "contactPhone": "9711166382" }, "id": 11204762, "balanceDue": 1000, "orderTotal": 1000, "subTotal": 1000, "isCOD": "1", "track_payload": { "clickPostTrackData": { "location": null, "additional": { "courier_partner_edd": null, "destination_hub_inscan_ts": null, "order_id": "TestLabel4-5977-3613", "latest_status": { "status": "RTO", "clickpost_status_description": "RTO-Marked", "clickpost_status_bucket": 7, "reference_number": "TestLabel4-5977-3613", "clickpost_status_bucket_description": "Returned", "remark": "MANUAL UPDATE - RTO", "timestamp": "2024-01-11T15:55:47Z", "location": null, "clickpost_city": null, "clickpost_status_code": 12 }, "is_rvp": false, "ndr_status_code": null, "ndr_status_description": null, "account_code": "self_delivery_test", "npr_status_code": null, "npr_status_description": null }, "status": "RTO", "clickpost_city": null, "clickpost_status_code": 12, "clickpost_status_description": "RTO-Marked", "cp_id": 35, "remark": "MANUAL UPDATE - RTO", "account_code": "self_delivery_test", "waybill": "TestLabel4-5977-3613", "timestamp": "2024-01-11T15:55:47Z" } }, "account_slug": "dfc", "packed_date": "2023-12-19 15:03:51", "items": [ { "order_item_id": 30328911, "lineItemSequenceNumber": 1, "orderItemID": "TestLabel4-30328911", "itemID": "SK101", "sku": "01FIJ3FOD5U", "asin": "", "productName": "Roasted Makhanas - Roasted In Olive Oil", "quantity": 1, "orderItemCreatedAt": "2023-12-19 14:52:16", "customerPrice": 150, "lineItemTotal": 1000, "invoiceTotal": 1000, "cashOnDeliveryCharges": 0, "discount": -850, "taxRate": 0, "taxAmount": 0, "inventoryItemCode": "", "giftMessage": "", "isGift": "0", "giftLabelContent": "", "lineItemOrderStatus": "", "orderItemIDs": [ "TestLabel4-30328911" ], "productImageUrl": "https://cdn.filestackcontent.com/7LEEmRndSvucV186ifYy", "productAdditionalInfo": { "productDetails": { "unitPrice": 100, "hsnCode": "1090", "dimensionHeight": 10, "dimensionLength": 10, "dimensionUnit": "cm", "weight": 400, "mrp": 150, "dimensionWidth": 10, "type": "BASE", "verticalName": "Apparels", "imageUrl": "https://cdn.filestackcontent.com/7LEEmRndSvucV186ifYy", "accountSlug": "dfc", "sku": "SK101", "esin": "01FIJ3FOD5U", "brand": "DummyBrand", "additionalNames": { "others": [ "SK101" ] }, "groupCode": "SK908", "status": "ACTIVE", "weightUnit": "g" } }, "expectedDeliveryDate": null, "shippingCharges": 0, "productUrl": null, "originalOrderItemId": null, "isVirtualKit": "0", "component": [], "onhold": "0", "cancellationAdditionalReason": "", "cancellationReason": "", "customerOrderItemID": "", "recallBlockedInventoryUsed": "" } ] }, "previous_data": [], "resource_type": "shipment.update", "account_slug": "dfc", "custom": [] }

    2. if API fails we will return the failure reason to frontend

Response failure: { "error" : "failed to cancel the order", "reason": "" }

  1. If action is taken from the workspace:

    1. Same steps to be followed as above from customer portal.

Add label

Related content