{"type":"doc","content":[{"type":"heading","attrs":{"level":2,"localId":null},"content":[{"text":"Figma: ","type":"text"},{"text":"Order Count Figma","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.figma.com/proto/LURem3BZz7dFNbUTvN6hDj/WIP-%7C-Nov-2023?page-id=3928%3A50561&type=design&node-id=3928-54873&viewport=251%2C-13449%2C0.73&t=VgQ7euNmqAxX8x0W-1&scaling=scale-down-width","__confluenceMetadata":null}}]}]},{"type":"heading","attrs":{"level":4,"localId":null},"content":[{"text":"Introduction - ","type":"text","marks":[{"type":"strong"}]},{"text":"This article contains all the logical steps involved to create the order count API in order to implement segments and smart segments.","type":"text"}]},{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"Backend Module Implementation","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"The shipping team can implement a lightweight method within the order service in the existing repository for order count.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"This method should ensure minimal latency.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2,"localId":null},"content":[{"text":"API","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"Service: ","type":"text","marks":[{"type":"strong"}]},{"text":"Esb Client Order Return","type":"text","marks":[{"type":"link","attrs":{"href":"https://gitlab.com/eshopbox-team/esb-client-order-return","__confluenceMetadata":null}},{"type":"strong"}]}]},{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"API Method: POST","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"URL : ","type":"text"},{"text":"http://localhost:8080/_ah/api/esb/v1/orders/count","type":"text","marks":[{"type":"link","attrs":{"href":"http://localhost:8080/_ah/api/esb/v1/orders/count","__confluenceMetadata":null}},{"type":"textColor","attrs":{"color":"#ffffff"}}]}]},{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"Request","type":"text"}]},{"type":"codeBlock","attrs":{"language":null,"uniqueId":null},"content":[{"text":"{\n \"filterQuery\": {\n {\n \"61d2d83019e2b31cf7d350a1\": \"(orderReceivedOn%3E=1708194600000)AND(orderReceivedOn%3C=1710786599999)AND(%27currentOrderStatus%27:%27Delivered%27)\", \n \"61d2d83019e2b31cf7d350a2\": \"(orderReceivedOn%3E=1708194600000)AND(orderReceivedOn%3C=1710786599999)AND(%27currentOrderStatus%27:%27Delivered%27)\"\n }\n}","type":"text"}]},{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"Response:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":null,"uniqueId":null},"content":[{"text":"{\n \"61d2d83019e2b31cf7d350a1\":20,\n \"61d2d83019e2b31cf7d350a2\":40,\n \"updated_at\":'2024-03-01 00:00:00'\n}","type":"text"}]},{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"How to achieve this:","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"We will get a map containing the list of segments and their corresponding filters.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"We will iterate through this map and fetch the details from algolia for that particular filter.","type":"text"}]},{"type":"codeBlock","attrs":{"language":null,"uniqueId":null},"content":[{"text":"Query query = new Query().setFilters(filter);\nquery.setFacets(Arrays.asList(\"currentOrderStatus\"));\nRequestOptions requestOptions = new RequestOptions().addExtraHeader(\"X-Algolia-UserToken\", \"order_search_v2\")\n\t\t\t\t.setTimeout(15000);","type":"text"}]},{"type":"paragraph","attrs":{"localId":null}}]},{"type":"listItem","content":[{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"Here we will extract 2 fields that we need i.e. total which includes the total number of records and ","type":"text"},{"text":"currentOrderStatus","type":"text","marks":[{"type":"strong"}]},{"text":" which keep data of multiple status for that particular filter. (TBD, for now we are only returning the number)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"The number we get from algolia will be put in a map corresponding to its segementId along with the current timestamp as ","type":"text"},{"text":"updated_at","type":"text","marks":[{"type":"code"}]},{"text":" and then we will return the map in the required format.","type":"text"}]}]}]},{"type":"paragraph","attrs":{"localId":null}},{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"Curl for Staging : ","type":"text"}]},{"type":"codeBlock","attrs":{"language":null,"uniqueId":null},"content":[{"text":"curl --location 'https://order-return-dot-eshopbox-portal-dev.el.r.appspot.com/_ah/api/esb/v1/orders/count' \\\n--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJVVXdSREZCUVRSRFFqQkdORFUxTVVZeE16ZEdPRFJHTnpORk5EaEJSVEU0TVVORk5qVTJOdyJ9.eyJodHRwczovL2FwcERhdGEiOnt9LCJodHRwczovL3VzZXJEZXRhaWxzIjp7ImlkIjoyOTc2LCJ1c2VyVHlwZSI6ImRlZmF1bHQiLCJlbWFpbCI6InRlZy5zaW5naEBlc2hvcGJveC5jb20ifSwiaHR0cHM6Ly9hY2NvdW50cyI6WyJkZmNkZWwxMDEiLCJkZmNtdW0xMDEiLCJkZmNna3AxMDEiLCJkZmN1dDEwMSIsImRmY2oxMDEiLCJkZmNrMTAxIiwiZGZja2FyMTAxIiwiZGZjZGVsaGkiLCJkZmNuZGwwMDEiLCJkZmNuZXdwaW5jb2RlY2hlY2siLCJkZmNlZGl0cGluY29kZTEzMTIzIiwiZGZjcmVkciIsImRmY2RlcnQiLCJkZmNuZXdsb2NhdGlvbmhpbnVzIiwiZGZjdGVzdGRmYzEzMTIiLCJkZmNjdnl0IiwiZGZjdGVzdGNhc2UyIiwiZGZjdGVzdGNhc2UzIiwiZGZjdGVzdCIsImRmY3Rlc3RicmFuZGV3aGZpdyIsImRmY3ZjZGUiLCJkZmN0ZXN0bmFneWEiLCJkZmN0cnRyIiwiZGZjdGVzdHJha3VsMTIzMiIsImRmY2Vld3EiLCJkZmNvb2xpIiwiZGZjdGVzdGRlbHJ5IiwiZGZjd2hhdHNhcHBkZmMiLCJkZmN0ZWcxIiwiZGZjZ2FuZXNoZmMiLCJkZmN0ZXN0ZGZjcmF3IiwiZGZjdW5pdGxldmVsbG9jYXRpb25zIiwiZGZjbXVtMDEiLCJkZmNiYWcwMiIsImRmY211bTAyIiwiZGZjbmV3dGVzdDEwMSIsImRmY211bWJhaTEwMSIsImRmY2RlbGgxMTAyIiwiZGZjbXAwNCIsImRmY2RmY2QxMDEiLCJkZmNtYXVkZmNzIiwiZGZjIl0sImh0dHBzOi8vd2FyZWhvdXNlV29ya3NwYWNlcyI6WyJkZmNkZWwxMDEiLCJkZmNtdW0xMDEiLCJkZmNna3AxMDEiLCJkZmN1dDEwMSIsImRmY2oxMDEiLCJkZmNrMTAxIiwiZGZja2FyMTAxIiwiZGZjZGVsaGkiLCJkZmNuZGwwMDEiLCJkZmNuZXdwaW5jb2RlY2hlY2siLCJkZmNlZGl0cGluY29kZTEzMTIzIiwiZGZjcmVkciIsImRmY2RlcnQiLCJkZmNuZXdsb2NhdGlvbmhpbnVzIiwiZGZjdGVzdGRmYzEzMTIiLCJkZmNjdnl0IiwiZGZjdGVzdGNhc2UyIiwiZGZjdGVzdGNhc2UzIiwiZGZjdGVzdCIsImRmY3Rlc3RicmFuZGV3aGZpdyIsImRmY3ZjZGUiLCJkZmN0ZXN0bmFneWEiLCJkZmN0cnRyIiwiZGZjdGVzdHJha3VsMTIzMiIsImRmY2Vld3EiLCJkZmNvb2xpIiwiZGZjdGVzdGRlbHJ5IiwiZGZjd2hhdHNhcHBkZmMiLCJkZmN0ZWcxIiwiZGZjZ2FuZXNoZmMiLCJkZmN0ZXN0ZGZjcmF3IiwiZGZjdW5pdGxldmVsbG9jYXRpb25zIiwiZGZjbXVtMDEiLCJkZmNiYWcwMiIsImRmY211bTAyIiwiZGZjbmV3dGVzdDEwMSIsImRmY211bWJhaTEwMSIsImRmY2RlbGgxMTAyIiwiZGZjbXAwNCIsImRmY2RmY2QxMDEiLCJkZmNtYXVkZmNzIl0sImh0dHBzOi8vd2FyZWhvdXNlcyI6W10sImh0dHBzOi8vcGFydG5lcnMiOltdLCJpc3MiOiJodHRwczovL2VzaG9wYm94LXBheW1lbnQtcmVjby5hdXRoMC5jb20vIiwic3ViIjoiZW1haWx8NjQ1ZTIwMGFjNmNlYmEwNDI3ZTYyZjdiIiwiYXVkIjpbImh0dHBzOi8vZXNob3Bib3gtcG9ydGFsLWRldi5hcHBzcG90LmNvbSIsImh0dHBzOi8vZXNob3Bib3gtcGF5bWVudC1yZWNvLmF1dGgwLmNvbS91c2VyaW5mbyJdLCJpYXQiOjE3MTU2ODczODQsImV4cCI6MTcxNTc3Mzc4Miwic2NvcGUiOiJvcGVuaWQgcHJvZmlsZSBlbWFpbCIsImF6cCI6IlRTSDJUWHg3V3ZmeDZocHBJRmZ6bDVjYjFNR3F2OVZwIn0.SSN9Fcf8be87eLWrMEvMyyYkRYsxNP16mEqyCnkaUM9CvR5WYdBHxw8UsA6ckFh5dsHMiv6KTpYhaDKu0bYfNc7tSo6DdgkYMArriKnrZFq43PiNJGvyABoxv8x9O4DpW4e5Oiay6wfhuW2cpBPU1e4jtvOwRyaQPFLoT8OtXtspc7QnSce4HgxNUrj9XjNPm0pFkVKdGemJTcpsBrwxc_8qFRy5aaAuk6CQ8WLWizLwdeInEO3bnBrNAMpP8-B7vSige6MkOBWl0WRsRRBE49Vqcr6DyJeSz4cEcvtAYM9qQ1iBIvjGj1hiUkiM60OQg5uij7-lOp4diOMdgpBMjg' \\\n--header 'Content-Type: application/json' \\\n--header 'Cookie: JSESSIONID=PzX7jHdyk_9Ojjio2cSxeA' \\\n--data '{\n \"filterQuery\": {\n \"61d2d83019e2b31cf7d350a2\": \"(orderReceivedOn>=1711823400000) AND (orderReceivedOn<=1714415399999) OR (returns.returnDetails.createdOnTimestamp>=1711823400000) AND (returns.returnDetails.createdOnTimestamp<=1714415399999) \",\n \"61d2d83019e2b31cf7d350a1\": \"(orderReceivedOn>=1697999400000)AND(orderReceivedOn<=1713551399999)AND( '\\''shipmentDetails.failedToRts'\\'':'\\''Yes'\\'' )AND( '\\''currentOrderStatus'\\'':'\\''Processing'\\'' )\",\n \"61d2d83019e2b31cf7d350a3\" : \"(returns.returnDetails.createdOnTimestamp>=1711823400000)AND(returns.returnDetails.createdOnTimestamp<=1714415399999)\",\n \"61d2d83019e2b31cf7d350a4\" : \"(orderReceivedOn>=1710873000000)AND(orderReceivedOn<=1713464999999)AND( '\\''currentOrderStatus'\\'':'\\''Processing'\\'' )AND( '\\''shipmentDetails.failedToHandover'\\'':'\\''Yes'\\'' )\",\n \"61d2d83019e2b31cf7d350a5\" : \"(orderReadyToShipTimestamp>=1710873000000)AND(orderReadyToShipTimestamp<=1713464999999)AND( '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Express'\\'' OR '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Priority'\\'' OR '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Standard'\\'' )AND( '\\''currentOrderStatus'\\'':'\\''Handover done'\\'' ) OR ('\\''currentOrderStatus'\\'':'\\''On the way'\\'' ) OR ('\\''currentOrderStatus'\\'':'\\''Out for delivery'\\'' )\",\n \"61d2d83019e2b31cf7d350a6\" : \"(orderReadyToShipTimestamp>=1710873000000)AND(orderReadyToShipTimestamp<=1713464999999)AND( '\\''currentOrderStatus'\\'':'\\''Handover done'\\'' )AND( '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Express'\\'' OR '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Priority'\\'' OR '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Standard'\\'' )\",\n \"61d2d83019e2b31cf7d350a7\" : \"(orderReadyToShipTimestamp>=1710873000000)AND(orderReadyToShipTimestamp<=1713464999999)AND( '\\''currentOrderStatus'\\'':'\\''Cancelled'\\'' )\",\n \"61d2d83019e2b31cf7d350a8\" : \"(returns.returnDetails.createdOnTimestamp>=1710959400000)AND(returns.returnDetails.createdOnTimestamp<=1713551399999)AND( '\\''currentOrderStatus'\\'':'\\''Awaiting pickup'\\'' )\",\n \"61d2d83019e2b31cf7d350a9\" : \"(returns.returnDetails.createdOnTimestamp>=1710959400000)AND(returns.returnDetails.createdOnTimestamp<=1713551399999)AND( '\\''currentOrderStatus'\\'':'\\''Return on the way'\\'' )\",\n \"61d2d83019e2b31cf7d350a10\" : \"(returns.returnDetails.createdOnTimestamp>=1710959400000)AND(returns.returnDetails.createdOnTimestamp<=1713551399999)AND( '\\''currentOrderStatus'\\'':'\\''Return on the way'\\'' )AND( '\\''shipmentDetails.stuckIntransit'\\'':'\\''Yes'\\'' )\",\n \"61d2d83019e2b31cf7d350a11\" : \"(returns.returnDetails.createdOnTimestamp>=1710959400000)AND(returns.returnDetails.createdOnTimestamp<=1713551399999)AND( '\\''currentOrderStatus'\\'':'\\''Return lost in transit'\\'' )\",\n \"61d2d83019e2b31cf7d350a12\" : \"(returns.returnDetails.createdOnTimestamp>=1710959400000)AND(returns.returnDetails.createdOnTimestamp<=1713551399999)AND( '\\''currentOrderStatus'\\'':'\\''Return on the way'\\'' ) OR ('\\''currentOrderStatus'\\'':'\\''Return in processing'\\'' ) OR ('\\''currentOrderStatus'\\'':'\\''Return lost in transit'\\'' )\",\n \"61d2d83019e2b31cf7d350a13\" : \"(orderReceivedOn>=1711391400000)AND(orderReceivedOn<=1713983399999)AND( '\\''currentOrderStatus'\\'':'\\''Return in processing'\\'' )\",\n \"61d2d83019e2b31cf7d350a14\" : \"(returns.returnDetails.receivedOnTimestamp>=1710959400000)AND(returns.returnDetails.receivedOnTimestamp<=1713551399999)\",\n \"61d2d83019e2b31cf7d350a15\" : \"(orderReceivedOn>=1710959400000)AND(orderReceivedOn<=1713551399999)AND( '\\''currentOrderStatus'\\'':'\\''Restocked'\\'' )\",\n \"61d2d83019e2b31cf7d350a16\" : \"(orderReceivedOn>=1710959400000)AND(orderReceivedOn<=1713551399999)AND( '\\''currentOrderStatus'\\'':'\\''Damaged'\\'' )\",\n \"61d2d83019e2b31cf7d350a17\" : \"(orderReceivedOn>=1710959400000)AND(orderReceivedOn<=1713551399999)AND( '\\''currentOrderStatus'\\'':'\\''Restocked'\\'' ) OR ('\\''currentOrderStatus'\\'':'\\''Quarantined'\\'' ) OR ('\\''currentOrderStatus'\\'':'\\''Damaged'\\'' ) OR ('\\''currentOrderStatus'\\'':'\\''Lost in processing'\\'' )\",\n \"61d2d83019e2b31cf7d350a18\" : \"(orderReceivedOn>=1710959400000)AND(orderReceivedOn<=1713551399999)AND(returns.returnDetails.createdOnTimestamp>=1710959400000)AND(returns.returnDetails.createdOnTimestamp<=1713551399999)\",\n \"61d2d83019e2b31cf7d350a19\" : \"(orderReceivedOn>=1697999400000)AND(orderReceivedOn<=1713551399999)AND( '\\''currentOrderStatus'\\'':'\\''Handover done'\\'' )AND( '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Express'\\'' OR '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Priority'\\'' OR '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Standard'\\'' )\",\n \"61d2d83019e2b31cf7d350a20\" : \"(orderReadyToShipTimestamp>=1710873000000)AND(orderReadyToShipTimestamp<=1713464999999)AND( '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Express'\\'' OR '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Priority'\\'' OR '\\''shipmentDetails.forwardShippingMode'\\'':'\\''Standard'\\'' )AND( '\\''currentOrderStatus'\\'':'\\''Handover done'\\'' ) OR ('\\''currentOrderStatus'\\'':'\\''On the way'\\'' ) OR ('\\''currentOrderStatus'\\'':'\\''Out for delivery'\\'' )\"\n\n\n }\n}'","type":"text"}]},{"type":"paragraph","attrs":{"localId":null}},{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"Response Time for 20 filterQuery as tested on local ~ 2.5s","type":"text"}]},{"type":"paragraph","attrs":{"localId":null}},{"type":"paragraph","attrs":{"localId":null},"content":[{"text":"Add RTS urgency, Handover urgency, Delivery urgency to Algolia as well as exports.","type":"text"}]},{"type":"paragraph","attrs":{"localId":null}}],"version":1}

Browser not supported