Amazon Return Complete Flow

High Level Diagram:

Open

AMAZON RETURN CREATE TO CREATE FLOW

A. Webhook based Implementation(Existing Flow)

AMAZON DEFAULT SERVICE
Step 1: Receive return Event From Amazon via webhook ( Repo : esb-amzprime-webhook-service, Endpoint : esb/v1/eventbridge/event )

or

Or

after receieved the event we push the single data to taskQueue
Step 2 : Event push to endpoint ( listen/orderevent/return/create,
Repo : esb-amzprime-webhook-service) to fetch all the details related to above "returnId".

1. Now we need to extract the following keys from the Return Event:

• MerchantId: To extract all the Active Connections using the below Query:

  SELECT id FROM ie_appinstall_connection WHERE inputFields LIKE '%"merchantId":"AAFR4ZPY4GS0"%' AND refreshToken IS NOT NULL AND accessToken IS NOT NULL

Now pull ChannelData by Using ConnectionId with the following Query:

Along with the ChannelData, we will also need accessToken, refresh token, and isActive flag. So we will use the following Query:

So, now our connection_ChannelData will look like below:

Step 3 : Now fetch Return Event Details using Return ID :

Response: FBA ORDER

Response: MFN ORDER

Step 4 : Once the Detailed Return Response is retrieved, Prepare QueueData which will be sent to Amzprime-Order Service for Transformation. It will look like this as given below ( Step 1 : AMAZON DEFAULT SERVICE )

AMAZON TRANSFORMATION LAYER SERVICE : Repo = esb-amzprime-order-service

Step 5: In the middle layer we receive QueData from Pubsub looks like below map:

Step 6: Fetch fulfillmentOrderId : CustomerOrderNumber, externalChannelID, marchantId : itemId and Check in Eshopbox  if return created or not using externalChannelID, CustomerOrderNumber, itemId:

Step 7:
Case 1: when returnFlag == 0, and empty DB.TrackingId and empty DB.returnId received from DB means return not created before.
Approach : we need to create the return. There are 2 types of return objects, sent by amazon:

1. returnType = “CUSTOMER”

2. returnType = “REJECT”

For both the return type, we call the same API to create a return in WMS mentioned below :
Method: POST

Transformation of the Amazon Customer Return Event into Eshopbox Return Order API is as per the following mapping:

WMS REQUEST BODY AFTER TRANSFORMATION:

Case 2 : when returnFlag == 1, DB.returnId == Event.ReturnId, DB.trackingId != Event.TrackingId, means tracking Id needs to be updated.
Approach : simply call Update tracking API call ( will make a check of Previous.TrcakingId == DB.trackingId) then Event.TrackingId Id associated with Given returnId.
Method PUT

Request Body:

Case 3 : when returnFlag == 1, DB.returnId != Event.ReturnId, means new returnId arrives for a return item.
Step 1:
Case 3.1: If( event.trackingId != DB.trackingIds) then → Upadate the new TrackingId to existing created return
Case 3.2: If (event.trackingId == DB.trackingIds) means tracking Id same-> Simply ignore tha case as our main concern is into trackingId

Case 4 : when returnFlag == 1 and DB.returnId == Event.ReturnId and event.trackingId == DB.trackingIds -> Simply ignore the case, Don't call any return API.

RETURN UPDATE FLOW

AMAZON DEFAULT SERVICE

Step 1: Receive return Event From Amazon via webhook ( Repo : esb-amzprime-webhook-service, Endpoint : esb/v1/eventbridge/event )

Step 2 : Event push to endpoint ( listen/orderevent/return/update, Repo : esb-amzprime-webhook-service) to fetch all the details related to above "returnId".

1. Now we need to extract the following keys from the Return Event:

• MerchantId: To extract all the Active Connections using the below Query:

  SELECT id FROM ie_appinstall_connection WHERE inputFields LIKE '%"merchantId":"AAFR4ZPY4GS0"%' AND refreshToken IS NOT NULL AND accessToken IS NOT NULL

• Now pull ChannelData by Using ConnectionId with the following Query:

  SELECT channels.integrationType AS integrationType, accounts.account_slug AS accountSlug, channels.connectionId AS connectionId, channels.externalChannelId AS externalChannelId, external_wms_channels.locationId AS locationId, warehouses.externalWarehouseId AS externalWareHouseId FROM channels LEFT JOIN external_wms_channels ON channels.id= external_wms_channels.channel_id LEFT JOIN warehouses ON warehouses.id = external_wms_channels.warehouse_id LEFT JOIN accounts ON channels.account_id = accounts.id WHERE channels.connectionId =:connectionId GROUP BY external_wms_channels.locationId ORDER BY external_wms_channels.id ASC

Along with the ChannelData, we will also need accessToken, refresh token, and isActive flag. So we will use the following Query:

So, now our connection_ChannelData will look like below:

Step 3 : Now fetch Return Event Details using Return ID :

Response:

Step 4 : Once the Detailed Return Response is retrieved, Prepare QueueData which will be sent to Amzprime-Order Service for Transformation. It will look like this as given below ( Step 1 : AMAZON TRANSFORMATION LAYER SERVICE : Repo = esb-amzprime-order-service)

AMAZON RETURN UPDATE TRANSFORMATION LAYER SERVICE : Repo = esb-amzprime-order-service
ENDPOINT : _ah/api/esb/v2/return/update

Step 5: In the middle layer we receive QueData from Pubsub looks like below map:

Step 6: Fetch fulfillmentOrderId : CustomerOrderNumber, externalChannelID, marchantId : itemId and Check in Eshopbox  if return created or not using externalChannelID, CustomerOrderNumber, itemId:

Step 7:
Case 1: when returnFlag == 0, and empty DB.TrackingId and empty DB.returnId received from DB means return not created before.
Approach :

1. We need to create the return first(

Amazon Return Complete Flow refer to step 7 case 1)

1. Then Update the return with new status = “in_transit”/”out_for_delivery”

Method PUT

Request Body:

Case 2: Return update request is received with another tracking id and new status
when returnFlag == 1, DB.returnId == Event.ReturnId, DB.trackingId != Event.TrackingId, means tracking Id and status both needs to be updated.
Approach : simply call Update tracking API call ( will make a check of Previous.TrcakingId == DB.trackingId) then Event.TrackingId Id associated with Given returnId.
Method PUT:

Request Body :

Case 3: Return update request is received with new return Id and new status.
Step1: Need to create new return with the new returnId after cancelling older return Id.
refer to (Amazon Return Complete Flow Step 7, case 3)
Step 2: Update the return with new return Id and Status:
Method PUT:

Request Body :

Case 4: when update received for simply updating status to “IN_TRANSIT”/”OUT_FOR_DELIVERY”
and returnFlag == 1 and DB.returnId == Event.ReturnId and event.trackingId == DB.trackingIds
Approach: Simply update the return with new status
Method PUT:

Request Body :

Case 5: when “DELIVERED” status received from Amazon update simply to Amazon :