Amazon Ship Order Flow (WMS to Amazon)
- Shubham Gupta (Unlicensed)
The Below Table explains the description of each Block present in Sequence Diagram
Component | Infra Description |
PubSub | Topic Name: wms_shipment_events |
amzprime-wms Service | App Engine Service Name: amzprime-wms-Service |
TaskQueue | Topic Name: “labelqueue“ Repository Name: esb-amzprime-wms-service |
amazonShipOrderSDKMethod | SDK Method to indicate to Amazon Yojaka that a client has shipped an order. |
Step1. The POST endpoint “shipment/event/listener“ in App Engine Service “amzprime-wmsService“ will receive a shipment dispatched event from PubSub Topic “wms_shipment_events“.
The Event received will be like:
{
"resource": "shipment",
"eventType": "PUT",
"eventSubType": "dispatched",
"accountSlug": "winspiring",
"accountId": null,
"actor": "SYSTEM",
"version": "v1",
"request_data": [],
"response_data": {
"customerOrderNumber": "4408536793282",
"vendorOrderNumber": "3233276723394",
"externalShipmentID": "4408536793282-846-88",
"externalWarehouseID": "ESBMUM_112",
"externalChannelID": "CH0846",
"integrationType": "7",
"vendorPartyID": null,
"partner_as2_id": null,
"defaultWarehouseCode": "ESBMUM_112",
"orderDate": "2021-02-05 14:15:45",
"portal_id": 27,
"paymentType": "Cash on Delivery (COD)",
"expectedShipDate": null,
"dispatchAfterDate": null,
"externalManifestNumber": null,
"channelManifestNumber": null,
"order_id": 5364237,
"channel_id": 846,
"warehouse_id": 72,
"channel_account_id": 158,
"account_id": 149,
"connectionId": 5,
"locationId": "59469168834",
"region": "",
"picklistCode": null,
"invoiceNumber": "",
"boxType": "UNKNOWN",
"isPriorityShipment": "0",
"isGift": "0",
"invoice_url": "",
"invoiceDate": null,
"label_url": "",
"labels": "",
"shippingInfo": [],
"boxAdditionalRecommendation": [],
"dimension_length": "0",
"dimension_width": "0",
"dimension_height": "0",
"weight": "0",
"trackingID": "",
"packageID": "",
"barcode": "",
"taxAmount": 0,
"shipChargeAmount": 30,
"courierName": "",
"created_at": "2021-02-05 14:16:22",
"updated_at": "2021-02-05 14:16:22",
"status": "created",
"remarks": "",
"customerName": "Joe",
"customerContactNumber": "0123466666",
"email": "prateek.kaushik@eshopbox.com",
"channelSlug": "meraki",
"status_updated_at": "2021-02-05 14:16:22",
"status_log": {
"created": "2021-02-05 14:16:22"
},
"orderExternalCreatedAt": "2021-02-05 14:16:19",
"shippingAddress": {
"customerName": "Joe",
"addressLine1": "Pune",
"addressLine2": "Pune",
"city": "Pune",
"state": "Haryana",
"postalCode": "122001",
"countryCode": "IN",
"countryName": "INDIA",
"contactPhone": "0123466666",
"email": "prateek.kaushik@eshopbox.com"
},
"id": 5285104,
"isCOD": "1",
"track_payload": [],
"items": [
{
"lineItemSequenceNumber": 9141401714882,
"orderItemID": "4408536793282-13983598",
"itemID": "40125732585666",
"sku": "",
"asin": "",
"productName": "Y",
"quantity": 1,
"customerPrice": 200,
"lineItemTotal": 236,
"invoiceTotal": 251,
"discount": 0,
"taxRate": 0,
"taxAmount": 0,
"giftMessage": "",
"giftLabelContent": "",
"lineItemOrderStatus": "",
"orderItemIDs": [
"4408536793282-13983598"
],
"productImageUrl": "https:\/\/eshopbox21.myshopify.com\/53130756290\/checkouts\/b715894d69d9d401972859b4274dcfc0?no_cookies_from_redirect=1",
"productAdditionalInfo": {
"size": "32"
},
"expectedDeliveryDate": null,
"shippingCharges": 15,
"productUrl": "https:\/\/eshopbox21.myshopify.com\/53130756290\/checkouts\/b715894d69d9d401972859b4274dcfc0?no_cookies_from_redirect=1",
"originalOrderItemId": null
},
{
"lineItemSequenceNumber": 9141401714882,
"orderItemID": "4408536793282-13983599",
"itemID": "40125732585666",
"sku": "",
"asin": "",
"productName": "Y",
"quantity": 1,
"customerPrice": 200,
"lineItemTotal": 236,
"invoiceTotal": 251,
"discount": 0,
"taxRate": 0,
"taxAmount": 0,
"giftMessage": "",
"giftLabelContent": "",
"lineItemOrderStatus": "",
"orderItemIDs": [
"4408536793282-13983599"
],
"productImageUrl": "https:\/\/eshopbox21.myshopify.com\/53130756290\/checkouts\/b715894d69d9d401972859b4274dcfc0?no_cookies_from_redirect=1",
"productAdditionalInfo": {
"size": "32"
},
"expectedDeliveryDate": null,
"shippingCharges": 15,
"productUrl": "https:\/\/eshopbox21.myshopify.com\/53130756290\/checkouts\/b715894d69d9d401972859b4274dcfc0?no_cookies_from_redirect=1",
"originalOrderItemId": null
}
]
},
"previous_data": [],
"resource_type": "shipment.update",
"account_slug": "winspiring",
"custom": []
}
Step 2. Push the event received from PubSub into TaskQueue.
Step 3. The POST endpoint “listen/shipment/event“ will receive the event from TaskQueue.
Step 4. Fetch order_id and connectionId from the event received.
Step 5. Find whether the Access Token is present in cache or not for the given connectionId.
Method name: getConnectionData
Cache Key: "amazonSmartConnectAccesstoken_"+connectionId
if it is present then move to next step but if not then get Access Token using Amazon SDK library method (getAccessToken) for which we need SellerId and Refresh Token hence find whether SellerId and Refresh Token in present in cache or not.
Method name: awsSmartConnectToken
Cache Key: "amazonConnectionData_"+connectionId
If both are present then get Access Token using library method but if not then extract both the parameters from DB using connectionId and then get the Access Token. Also set all the three parameters Access Token, SellerId and Refresh Token in cache against their respective keys.
Step 6. Make a Call the Amazon Ship Order SDK Method and pass the ShipOrdeRequest
ShipOrderRequest shipOrderRequest = new ShipOrderRequest()
.amzAccessToken(amzAccessToken)
.id(orderId);
ShipOrderResult shipOrderResult = amazonYojaka.shipOrder(shipOrderRequest);Step 7. If Request is successful we will receive a 204 Success Response
{
"Success":204
}