Amazon Generate ShipLabel Flow
- Shubham Gupta (Unlicensed)
The Below Table explains the description of each Block present in Sequence Diagram
Component | Infra Description |
FrontEnd(UI) | UI Component |
amzprime-get-invoice-label | App Engine Service Name: amzprime-get-invoice-label |
Amazon Generate ShipLabel SDK library Method | A library Method to generate ShipLabel for a given orderID |
Step 1. The "/v1/orders/generate-ship-label" will \n receive request to generate ShipLabel along with a Request Body containing connectionId, orderId, packageId and pickUpTimeSlot.
{
"connectionId": "5",
"orderId": 123456789,
"packageId": "123456789",
"pickupTimeSlotId": "1234567"
}Step 2. Extract the connectionId and orderId from the above received Request Body. “pickupTimeSlotId” is optional, if it is present in the Request Body then only send it to Amazon Generate ShipLabel Method.
Step 3. 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 4. Make a call internally on Amazon ShipLabel SDK library Method (generateShipLabel) using orderId, Access Token, packageId, pickupTimeSlotId(optional).
GenerateShipLabelRequest shiplabelRequest = new GenerateShipLabelRequest()
.amzAccessToken(amzAccessToken)
.id(orderId).packageId(packageId);
GenerateShipLabelResult shiplabelResult = amazonYojaka.generateShipLabel(shiplabelRequest);Step 5. We will get an ShipLabel Object which we need to decrypt to get ShipLabel details.
{
"fileData": {
"encryptedContent": {
"encryptionInfo": {
"context": "shipLabel",
"type": "AWS_KMS"
},
"value": "^XA\n\n^FX Top section with company logo, name and address.\n^CF0,60\n^FO50,50^GB100,100,100^FS\n^FO75,75^FR^GB100,100,100^FS\n^FO88,88^GB50,50,50^FS\n^FO220,50^FDIntershipping, Inc.^FS\n^CF0,30\n^FO220,115^FD1000 Shipping Lane^FS\n^FO220,155^FDShelbyville TN 38102^FS\n^FO220,195^FDUnited States (USA)^FS\n^FO50,250^GB700,1,3^FS\n\n^FX Second section with recipient address and permit information.\n^CFA,30\n^FO50,300^FDJohn Doe^FS\n^FO50,340^FD100 Main Street^FS\n^FO50,380^FDSpringfield TN 39021^FS\n^FO50,420^FDUnited States (USA)^FS\n^CFA,15\n^FO600,300^GB150,150,3^FS\n^FO638,340^FDPermit^FS\n^FO638,390^FD123456^FS\n^FO50,500^GB700,1,3^FS\n\n^FX Third section with barcode.\n^BY5,2,270\n^FO100,550^BC^FD12345678^FS\n\n^FX Fourth section (the two boxes on the bottom).\n^FO50,900^GB700,250,3^FS\n^FO400,900^GB1,250,3^FS\n^CF0,40\n^FO100,960^FDCtr. X34B-1^FS\n^FO100,1010^FDREF1 F00B47^FS\n^FO100,1060^FDREF2 BL4H8^FS\n^CF0,190\n^FO470,955^FDCA^FS\n\n^XZ"
},
"format": "ZPL"
},
"shipLabel": {
"encryptedContent": {
"encryptionInfo": {
"context": "shipLabel",
"type": "AWS_KMS"
},
"value": "^XA\n\n^FX Top section with company logo, name and address.\n^CF0,60\n^FO50,50^GB100,100,100^FS\n^FO75,75^FR^GB100,100,100^FS\n^FO88,88^GB50,50,50^FS\n^FO220,50^FDIntershipping, Inc.^FS\n^CF0,30\n^FO220,115^FD1000 Shipping Lane^FS\n^FO220,155^FDShelbyville TN 38102^FS\n^FO220,195^FDUnited States (USA)^FS\n^FO50,250^GB700,1,3^FS\n\n^FX Second section with recipient address and permit information.\n^CFA,30\n^FO50,300^FDJohn Doe^FS\n^FO50,340^FD100 Main Street^FS\n^FO50,380^FDSpringfield TN 39021^FS\n^FO50,420^FDUnited States (USA)^FS\n^CFA,15\n^FO600,300^GB150,150,3^FS\n^FO638,340^FDPermit^FS\n^FO638,390^FD123456^FS\n^FO50,500^GB700,1,3^FS\n\n^FX Third section with barcode.\n^BY5,2,270\n^FO100,550^BC^FD12345678^FS\n\n^FX Fourth section (the two boxes on the bottom).\n^FO50,900^GB700,250,3^FS\n^FO400,900^GB1,250,3^FS\n^CF0,40\n^FO100,960^FDCtr. X34B-1^FS\n^FO100,1010^FDREF1 F00B47^FS\n^FO100,1060^FDREF2 BL4H8^FS\n^CF0,190\n^FO470,955^FDCA^FS\n\n^XZ"
},
"format": "ZPL"
},
"shipLabelMetadata": {
"carrierName": "ATS",
"carrierPickupWindow": {
"endTimestamp": 1.620740602452E12,
"startTimestamp": 1.620737002452E12
},
"trackingId": "6770045984"
}
}Step 6. If Error Code = SC_10001 and Error Description = “Requested operation is not permitted in the current order state. Check the order status and follow the order processing workflow.“ Then we need to call Retrieve ShipLabel SDK Method.
Step 7. Make a call internally on Amazon Retrieve ShipLabel SDK library Method (retrieveShipLabel) using orderId and Access Token.
RetrieveShipLabelRequest shiplabelRequest = new RetrieveShipLabelRequest()
.amzAccessToken(amzAccessToken)
.id(orderId).packageId(packageId);
RetrieveShipLabelResult shiplabelResult = amazonYojaka.retrieveShipLabel(shiplabelRequest);Step 8. If request is successful we will get an shipLabel object in response else we will get an error response.
{
"fileData": {
"encryptedContent": {
"encryptionInfo": {
"context": "shipLabel",
"type": "AWS_KMS"
},
"value": "^XA\n\n^FX Top section with company logo, name and address.\n^CF0,60\n^FO50,50^GB100,100,100^FS\n^FO75,75^FR^GB100,100,100^FS\n^FO88,88^GB50,50,50^FS\n^FO220,50^FDIntershipping, Inc.^FS\n^CF0,30\n^FO220,115^FD1000 Shipping Lane^FS\n^FO220,155^FDShelbyville TN 38102^FS\n^FO220,195^FDUnited States (USA)^FS\n^FO50,250^GB700,1,3^FS\n\n^FX Second section with recipient address and permit information.\n^CFA,30\n^FO50,300^FDJohn Doe^FS\n^FO50,340^FD100 Main Street^FS\n^FO50,380^FDSpringfield TN 39021^FS\n^FO50,420^FDUnited States (USA)^FS\n^CFA,15\n^FO600,300^GB150,150,3^FS\n^FO638,340^FDPermit^FS\n^FO638,390^FD123456^FS\n^FO50,500^GB700,1,3^FS\n\n^FX Third section with barcode.\n^BY5,2,270\n^FO100,550^BC^FD12345678^FS\n\n^FX Fourth section (the two boxes on the bottom).\n^FO50,900^GB700,250,3^FS\n^FO400,900^GB1,250,3^FS\n^CF0,40\n^FO100,960^FDCtr. X34B-1^FS\n^FO100,1010^FDREF1 F00B47^FS\n^FO100,1060^FDREF2 BL4H8^FS\n^CF0,190\n^FO470,955^FDCA^FS\n\n^XZ"
},
"format": "ZPL"
},
"shipLabel": {
"encryptedContent": {
"encryptionInfo": {
"context": "shipLabel",
"type": "AWS_KMS"
},
"value": "^XA\n\n^FX Top section with company logo, name and address.\n^CF0,60\n^FO50,50^GB100,100,100^FS\n^FO75,75^FR^GB100,100,100^FS\n^FO88,88^GB50,50,50^FS\n^FO220,50^FDIntershipping, Inc.^FS\n^CF0,30\n^FO220,115^FD1000 Shipping Lane^FS\n^FO220,155^FDShelbyville TN 38102^FS\n^FO220,195^FDUnited States (USA)^FS\n^FO50,250^GB700,1,3^FS\n\n^FX Second section with recipient address and permit information.\n^CFA,30\n^FO50,300^FDJohn Doe^FS\n^FO50,340^FD100 Main Street^FS\n^FO50,380^FDSpringfield TN 39021^FS\n^FO50,420^FDUnited States (USA)^FS\n^CFA,15\n^FO600,300^GB150,150,3^FS\n^FO638,340^FDPermit^FS\n^FO638,390^FD123456^FS\n^FO50,500^GB700,1,3^FS\n\n^FX Third section with barcode.\n^BY5,2,270\n^FO100,550^BC^FD12345678^FS\n\n^FX Fourth section (the two boxes on the bottom).\n^FO50,900^GB700,250,3^FS\n^FO400,900^GB1,250,3^FS\n^CF0,40\n^FO100,960^FDCtr. X34B-1^FS\n^FO100,1010^FDREF1 F00B47^FS\n^FO100,1060^FDREF2 BL4H8^FS\n^CF0,190\n^FO470,955^FDCA^FS\n\n^XZ"
},
"format": "ZPL"
},
"shipLabelMetadata": {
"carrierName": "ATS",
"carrierPickupWindow": {
"endTimestamp": 1.620740602452E12,
"startTimestamp": 1.620737002452E12
},
"trackingId": "6770045984"
}
}