Documentation Portal

The Merchant calls this API to get data from the Flat Shipping Rates table based on the cart amount and shipping country selected.

If the destination country is provided, this method returns the flat shipping rates for this country. Otherwise, it returns flat shipping rates for all merchant countries.

The output displays up to two objects per destination, one with the cheapest shipping cost for the submitted currency and amount and another with the details related to the free shipping threshold.

The GetShippingDetails API accepts the following parameters:

The JWT and the userName must be sent as part of any API request, in the HTTP request headers.

key=”Authorization” , value= token

Key=”UserName”, value=username

SAMPLE

Body:

{
    "destinationCountry": "",
    "amount": "100",
    "currencyCode": "USD",
    "productCodes": []
}

Response Body:

[
    {
        "destinationCountry": "AE",
        "status": "active",
        "shippingRates": [
            {
                "minOrderSubtotal": 200.0000,
                "maxOrderSubtotal": 99999999999999.0000,
                "shippingCost": 10.0000,
                "shippingCostCurrency": "AED",
                "shippingPriority": "Standard Courier",
                "estimatedDeliveryDays": "4-9",
                "specialOfferExpiryDate": null
            }
        ]
    },
    {
        "destinationCountry": "AL",
        "status": "active",
        "shippingRates": [
            {
                "minOrderSubtotal": 0.0000,
                "maxOrderSubtotal": 15000.0000,
                "shippingCost": 2500.0000,
                "shippingCostCurrency": "ALL",
                "shippingPriority": "Express Courier (Air)",
                "estimatedDeliveryDays": "2-10",
                "specialOfferExpiryDate": null
            },
            {
                "minOrderSubtotal": 15000.0000,
                "maxOrderSubtotal": 1000000000.0000,
                "shippingCost": 0.0000,
                "shippingCostCurrency": "ALL",
                "shippingPriority": "Express Courier (Air)",
                "estimatedDeliveryDays": "2-10",
                "specialOfferExpiryDate": null
            }
        ]
    }
]

URL:

https://{server_name}/ShippingDetails/GetShippingDetails

ACCEPTS

GetShippingDetailsRequest class

RETURNS

ShippingDetailsResponse class