HLD- Unicommerce Returns Integration

HLD mainly comprises of following two broad sections:

1. System Design Diagram (aka Component Diagram)

2. Sequence Diagram

1. System Design Diagram

Open

Here is the breakdown of flow:

1. For the directly integrated channels, returns are synced with Unicommerce and in order to create those returns in Eshopbox, a GET unicommerce returns API will be created to fetch the returns created for a particular channel.

2. The cron job will be scheduled with frequency to call the GET Unicommrce returns API. This API will use the below API to get return details.

   1. Search sale order API of Unicommerce: https://documentation.unicommerce.com/docs/saleorder-search.html

      1. Call this API with the ‘date-time’ and ‘updated since’ filter with the return statuses.

   2. Get sale order API of Unicommerce: https://documentation.unicommerce.com/docs/saleorder-get.html

      1. Call this API for each sale order code received in the above API to get the details of the return.

      2. This API also gives us the type of return.

3. Call the create return API of Eshopbox to create a return on Eshopbox and the client portal service will fetch the return details from the DB and update it to Algolia and hence the client workspace.

4. When we receive and process the return in the Auperator, the below cases can occur:

   1. Customer return was created beforehand and received at the warehouse.

      1. Automation will be triggered and mark the return as identified in Auperator and update the receiving and processing details in Eshopbox. And simultaneously trigger the return completed event. The Eshopbox service will listen to this event and will check If the reverse pickup was created for the order then:

         1. Fetch the reverse pickup code from UC and call the mark sale order return with inventory type API to mark the return complete on Unicommerce.

         2. If reverse pickup was not already created, call create reverse pickup API to create the reverse pickup and then call the mark sale order return with inventory type API to mark the return complete on Unicommerce.

   2. Courier return was created beforehand and received at the warehouse.

      1. Automation will be triggered and mark the return as identified in Auperator and update the receiving and processing details in Eshopbox. And simultaneously trigger the return completed event. The Eshopbox service will listen to this event and call the mark sale order return with inventory type API to mark the return complete on Unicommerce.

5. The client portal service will fetch the return details from the DB and update it to Algolia and hence the client workspace.

6. Inventory will be adjusted accordingly on Unicommerce.

2. Sequence Diagram

Open

Open

2. Return was not created but received at Auperator.

Open

3. Return was created but some of the items were missing.

Open