API for Amazon Stuck Orders

Objective: This API will work only if the Generate Ship Label API of Amazon does not provide the Ship Label and instead throws an Error Response like below: If the response does not contain Ship label then the error code will 400, with the help of which we can call this Amazon Stuck Order Resolve API.

{
    "error": {
        "errors": [
            {
                "domain": "global",
                "reason": "badRequest",
                "message": "{
                            "retryable": false,
                            "errorDescription": "Internal failure occurred, contact Amazon support",
                            "errorCode": "SC_00000"
                            }"
        }
        ],
        "code": 400,
        "message": "{
                      "retryable": false,
                      "errorDescription": "Internal failure occurred, contact Amazon support",
                      "errorCode": "SC_00000"
                    }"
    }
}

When to use this API?

If the Generate Ship Label API throws an Error then internally proceed with the flow as given below:

Step 1. Check the status of the order using the below API:

GET API:

https://amzprime-get-label-invoice-dot-amzprime-integration-staging.appspot.com/_ah/api/esb/v1/orders

Request Body:

{
    "connectionId": 2163,
    "orderId": "2480c8dd-03d5-492a-8544-4239f08d7bea",
    "externalShipmentID": "UXQZcFrp4",
    "packageId": "1",
    "shippingOptionId": ""
}

Response:

{
    "id": "2480c8dd-03d5-492a-8544-4239f08d7bea",
    "locationId": "d8c359ad-58f3-4faa-968b-2564679ab63e",
    "marketplaceChannelDetails": {
        "marketplaceChannel": {
            "marketplaceName": "AMAZON_IN",
            "channelName": "MFN"
        },
        "locationId": "DEFAULT",
        "shipmentId": "nAef3BVPZY",
        "merchantId": "AAFR4ZPY4GS0",
        "customerOrderId": "CWcbe9x2Vr",
        "customAttributes": [
            {
                "attributeName": "isPrime",
                "attributeValue": {
                    "valueType": "Boolean",
                    "valuePayload": "true"
                }
            }
        ]
    },
    "metadata": {
        "orderType": "NEW",
        "numberOfUnits": 1,
        "priority": false,
        "charge": {
            "totalAmount": {
                "value": 200.0,
                "currency": "INR"
            },
            "totalTax": {
                "value": 32.0,
                "currency": "INR"
            }
        },
        "invoiceInformation": {
            "id": "RMIvZKoKS7",
            "creationTimestamp": 1646308443820
        },
        "adapterApp": {
            "id": "YojakaFbaAdapterService",
            "name": "YojakaFbaAdapterService"
        }
    },
    "orderCharges": [
        {
            "orderChargeType": "shipping",
            "name": "Shipping Principal",
            "amount": {
                "value": 100.0,
                "currency": "INR"
            },
            "tax": {
                "breakup": [
                    {
                        "name": "SGST",
                        "rate": 0.08,
                        "amount": {
                            "value": 8.0,
                            "currency": "INR"
                        }
                    },
                    {
                        "name": "CGST",
                        "rate": 0.08,
                        "amount": {
                            "value": 8.0,
                            "currency": "INR"
                        }
                    }
                ],
                "name": "Shipping Tax",
                "rate": 0.16,
                "amount": {
                    "value": 16.0,
                    "currency": "INR"
                }
            }
        },
        {
            "orderChargeType": "shippingPromotion",
            "name": "Shipping Discount",
            "amount": {
                "value": -50.0,
                "currency": "INR"
            },
            "tax": {
                "breakup": [
                    {
                        "name": "SGST",
                        "rate": 0.08,
                        "amount": {
                            "value": -4.0,
                            "currency": "INR"
                        }
                    },
                    {
                        "name": "CGST",
                        "rate": 0.08,
                        "amount": {
                            "value": -4.0,
                            "currency": "INR"
                        }
                    }
                ],
                "name": "Shipping TaxSaving",
                "rate": 0.16,
                "amount": {
                    "value": -8.0,
                    "currency": "INR"
                }
            }
        }
        }
    ],
    "status": "CREATED",
    "creationTimestamp": 1646308445320,
    "lastUpdatedTimestamp": 1646308445320,
    "shippingInfo": {
        "shipToAddress": {
            "value": "AYADeGPPyB8z6fOu4YuxiZ26zjsAiAADABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREEwWHVUcWNUd1JvQWJxQmRIZG9pMWZCeFNFQmt4T0w0WThFNzZvZldUbW5sOFBibTNTTGNHMDJMcTNIb0loTGl3UT09AAZjbGllbnQABnlvamFrYQAIZGF0YVR5cGUADXNoaXBUb0FkZHJlc3MAAQAHYXdzLWttcwBLYXJuOmF3czprbXM6ZXUtd2VzdC0xOjg1OTAwMTAwMzU5MjprZXkvNWU4MGMxZTAtZTZkMS00YjE5LTliNGQtZTcyNTA2NTAxZTE1ALgBAgEAeJRPZRi5hd7lvaXuQmvhxBNqueyu6MnkyqhvSLNyy/9QAUOEmQuQsuoqdSn5JYds398AAAB+MHwGCSqGSIb3DQEHBqBvMG0CAQAwaAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAy3UOKS+DAtpbSUvo4CARCAOyn3g2muv8NE3iSY86VANs5zVO6Y07rV0aojlH/CcRgmN6wXKNy9Ug+ndxx/5ndOmgxs9h/aofHeuVpkAgAAAAAMAAAQAAAAAAAAAAAAAAAAACZBb9ZEMMlih5fW3Nh9fu//////AAAAAQAAAAAAAAAAAAAAAQAAABckqqusZDe7SjTDLKRj2Wlec3hHJPg0XCtNwTNAizu4aYzqZCUr3AUAZzBlAjEA5Tf6858SSOyK1kd3APHsWpXja2Am4p9srto3jICo/Nnqv8xzuBqYsg4cjFFpqyK/AjAhUaQj9dIwCD7kfiWIRiwQrBFtXBHm/G4ShucWSWlZ13TLrCyRuYO8dGBJfFOXOr4=",
            "encryptionInfo": {
                "type": "AWS_KMS",
                "context": "shipToAddress"
            }
        },
        "expectedShippingTimestamp": 1646740443820,
        "expectedShippingTimestampV2": 1646740443820,
        "recommendedShipMethod": "",
        "shippingType": "MARKETPLACE",
        "recommendedPackages": [
            {
                "dimensions": {
                    "length": {
                        "value": 6.842244733731173,
                        "dimensionUnit": "CM"
                    },
                    "width": {
                        "value": 1.6185512041770345,
                        "dimensionUnit": "CM"
                    },
                    "height": {
                        "value": 1.731001260699197,
                        "dimensionUnit": "CM"
                    }
                },
                "weight": {
                    "value": 6255.435084415931,
                    "weightUnit": "grams"
                }
            }
        ]
    },
    "lineItems": [
        {
            "id": "0",
            "merchantSku": "D1BA21NV1",
            "numberOfUnits": 1,
            "cancellations": [],
            "serialNumberRequired": false,
            "serialNumbers": [],
            "hazmatLabelRequired": false,
            "hazmatLabels": [],
            "giftAttributes": {
                "giftMessagePresent": false,
                "giftWrapRequired": false
            }        
            ],
            "marketplaceChannelAttributes": {
                "sku": "D1BA21NV1"
            }
        }
    ],
    "packages": []
}

Note: Now check the order status if the status matches with the cases as given below then proceed with the flow as explained:

Case #1: Order Status = ACCEPTED then API1, API2, API3, API4, and API5 will be called.

Case #2: Order Status = CONFIRMED then API2, API3, API4 and API5 will be called only.

Case #3: Order Status = PACKAGE_CREATED then API3, API4 and API5 will be called only.

Case #4: Order Status = RETRIEVE_PICK_UP_SLOTthen API4 and API5 will be called only.

Case #5: Order Status = INVOICE_GENERATED then API5 will be called only. Even after this API, if the label is not returned then we need to check manually what’s wrong and why not label is getting generated.

Case #6: Order Status = SHIPLABEL_GENERATED then we need to check and find the root cause as to why the order is not getting RTS. One of the possible reasons is that sometimes INVOICE_PDF is not saved in the database due to a 5XX error, so calling API4(Invoice Generate API) will automatically save the invoice in the database then we can retry RTS.

Depending upon which case is seen, we need to call the following APIs

API 1: Confirm Order - 204 Status Code

https://amzprime-get-label-invoice-dot-amzprime-integration-prod.appspot.com/_ah/api/esb/v1/orders/confirm-order

Request Body: Same request as provided during Ship Label Generation as we only need orderId and connectionId

API 2: Create Package - 204 Status Code

https://amzprime-get-label-invoice-dot-amzprime-integration-staging.el.r.appspot.com/_ah/api/esb/v1/orders/create-packages

Request Body:

{
    "orderId": "2480c8dd-03d5-492a-8544-4239f08d7bea",
    "connectionId": "2163",
    "packages": [
        {
            "height": {
                "dimensionUnit": "CM",
                "value": 5
            },
            "id": "1",
            "length": {
                "dimensionUnit": "CM",
                "value": 10
            },
            "packagedLineItems": [
                {
                    "lineItem": {
                        "id": "0"
                    },
                    "quantity": 1
                }
            ],
            "weight": {
                "value": 250,
                "weightUnit": "grams"
            },
            "width": {
                "dimensionUnit": "CM",
                "value": 10
            }
        }
    ]
}

API 3: Retrieve Shipping Options API: 200 Status Code

https://amzprime-get-label-invoice-dot-amzprime-integration-staging.el.r.appspot.com/_ah/api/esb/v1/orders/retrieveshippingoptions

Request:

{
    "connectionId": "2163",
    "orderId": "2480c8dd-03d5-492a-8544-4239f08d7bea"
}

Response:

{
    "packageShippingOptions": [
        {
            "packageId": "1",
            "shippingOptions": [
                {
                    "pickupStartTimestamp": 1646309111075,
                    "pickupEndTimestamp": 1646316311075,
                    "id": "MmpKQDA2u8sC0ESVSaXO3CLeGRF6gsKIRdOgr0Zlw5EmZsGS50EOTlVS7dlva3YxlScDku4xjk74l",
                    "shipBy": ""
                },
                {
                    "pickupStartTimestamp": 1646395511075,
                    "pickupEndTimestamp": 1646402711075,
                    "id": "xDpTRDJF8bfRrwNq3flsCZsZ5AkH9NoCvXCp22F3pra9siUAH5VMbK1igxp7LQ7Vm3ZXIxrUjoPh9",
                    "shipBy": ""
                },
                {
                    "pickupStartTimestamp": 1646481911075,
                    "pickupEndTimestamp": 1646489111075,
                    "id": "8crHQHCWf4H6uUFhyPryfuC7re60BH4r0CrhqwEgVlMyjW6ufdZUnosryaL7xDeRWnN7DwXoUycRg",
                    "shipBy": ""
                },
                {
                    "pickupStartTimestamp": 1646568311075,
                    "pickupEndTimestamp": 1646575511075,
                    "id": "4mo50PCbYhEVMFNsTlJZozM1VRGzDOwqhgumJXH5dIelPJpEKugJy1YvsQKTv7zAlLWTTGifzhzhu",
                    "shipBy": ""
                },
                {
                    "pickupStartTimestamp": 1646654711075,
                    "pickupEndTimestamp": 1646661911075,
                    "id": "DHk9QbO6mclXJrIoPDsP9a6F14q3IzzVVEzxoDrWuSaDG6OUqFV7ZoHOZB8yCaKIweM1iZnQp3Amw",
                    "shipBy": ""
                }
            ],
            "recommendedShippingOption": {
                "pickupStartTimestamp": 1646309111075,
                "pickupEndTimestamp": 1646316311075,
                "id": "MmpKQDA2u8sC0ESVSaXO3CLeGRF6gsKIRdOgr0Zlw5EmZsGS50EOTlVS7dlva3YxlScDku4xjk74l",
                "shipBy": ""
            }
        }
    ]
}

API 4: Generate Invoice - 200 Status Code

https://api.sandbox.dub.yojaka.xp.sellers.a2z.com/v1/orders/fbe32aba-eb09-4e2b-8188-3b0d5e4f06c8/invoice

Response:

{
    "filePathUrl": "https://storage.googleapis.com/amzprime-files-staging/invoice/UXQZcFrp4-2163.pdf",
    "orderId": "2480c8dd-03d5-492a-8544-4239f08d7bea",
    "externalShipmentID": "UXQZcFrp4",
    "connectionId": "2163",
    "message": "AMZPRIME_GENERATE_PDF",
    "statusCode": "200"
}

API 5: Generate Ship Label:

https://amzprime-get-label-invoice-dot-amzprime-integration-staging.appspot.com/_ah/api/esb/v1/orders/generate-ship-label

Request:

{
    "connectionId": 2163,
    "orderId": "2480c8dd-03d5-492a-8544-4239f08d7bea",
    "externalShipmentID": "UXQZcFrp4",
    "packageId": "1" 
}

Response:

{
    "fileData": {
        "encryptedContent": {
            "encryptionInfo": {
                "context": "shipLabel",
                "type": "AWS_KMS"
            },
            "value": "https://storage.googleapis.com/amzprime-files-staging/label/shipment-UXQZcFrp4-1646309371374.pdf"
        },
        "format": "PDF"
    },
    "shipLabel": {
        "encryptedContent": {
            "encryptionInfo": {
                "context": "shipLabel",
                "type": "AWS_KMS"
            },
            "value": "https://storage.googleapis.com/amzprime-files-staging/label/shipment-UXQZcFrp4-1646309371374.pdf"
        },
        "format": "PDF"
    },
    "shipLabelMetadata": {
        "carrierName": "ATS",
        "carrierPickupWindow": {
            "endTimestamp": 1.646399364299E12,
            "startTimestamp": 1.646395764299E12
        },
        "trackingId": "4286589382"
    }
}

Apps and Automations

API for Amazon Stuck Orders

When to use this API?

If the Generate Ship Label API throws an Error then internally proceed with the flow as given below:

Note: Now check the order status if the status matches with the cases as given below then proceed with the flow as explained:

Related content