Skip to main content

Documentation Portal

GetShippingDetailsExtended

This API extends the GetShippingDetails API to provide all flat shipping rate thresholds for all shipping services related to a product.

The GetShippingDetailsExtended API lets you:

  • Get all shipping rates available for a given country

  • Get the rates for all specific shipping service levels

  • Revert to all shipping rates available, for instance, if the request passed with amount = 0.

Method/URL

http://{base_URL_GE}/ShippingDetails/GetShippingDetailsExtended
Parameters

Request

Parameter

Type

Description

Mandatory

Amount

Decimal (Float)

The shipping cost

This number can contain up to two digits after the decimal point

Example: 50.30

Yes

CultureCode

String

Determines the shipping method description language.

Default: en-GB

No

CurrencyCode

String

The currency of the value passed in the Amount parameter.

Length: 3 letters

Example: CAD , USD , ILS , EUR

Yes

DestinationCountry

String

The destination country

Length: 2-3 letters (both ISO-2 and ISO-3 are supported)

If empty, the API returns a list of shipping rates for all countries configured in the Global‑e System.

Example: US or USA for the United States

No

ProductCodes

Array

The unique product reference (SKU, EAN, Barcode, and more.)

["product123","productABC"]

No

ServiceLevel

Integer

Supported Service levels (default) = Revert to all shipping rates available, for instance, if the request passed with amount = 0.

Standard = 1,

Express = 2,

PriorityPost = 3,

Airmail = 4,

VirtualGoods = 5,

ExpressCourierWithoutSameDay = 6,

UntrackedPost = 7,

StoreCollection = 8,

StandardPost = 9,

StandardCourier = 10,

ExpressShipping = 11,

StandardShipping = 12,

CollectionPoint = 13,

MerchantOwnCarriage = 14,

TrackedStandard = 15,

ExpressPlus = 16,

StandardExpress = 17,

PremiumStandard = 18,

TrackedPostToPickupLocation = 19

Default output for all service levels (express / standard )

No

Response

Parameter

Type

Description

rangeMaxValue

Decimal

Double representation of range minimum value

Maximum order/product price for a price range (includes 4 decimals)

Example: 150.0000

rangeMinValue

Decimal

Double representation of range minimum value

Minimum order/product price for a price range (includes 4 decimals)

Example: 100.0000

shippingCostCurrency

String

The merchant's default currency for the destination (3 letters ISO code)

Example: EUR, USD, ILS

shippingCost

Decimal

The shipping costs for the order/product price range (includes 4 decimals)

Example: 5.0000

shippingMethodLocalizedName

String

The name of the shipping method type name

shippingMethodName

String

The type of shipping service

Shipping types: standard, express, tracked, and more.

Example: Standard, Express Courier (Air)

shippingRates

Array

This array contains up to two shipping service objects.

These two shipping rate objects that can be returned are as per the Shipping Details API logic. For more information, see Shipping Details.

If the cheapest shipping service is the first to be subject to free shipping, only one shippingRates object is returned.

The shippingRatesobject contains the following attributes:

  • minOrderSubtotal:

  • maxOrderSubtotal

  • shippingCost

  • shippingCostCurrency

  • shippingPriority

  • estimatedDeliveryDays

  • specialOfferExpiryDate

Objects for GetShippingDetailsExtended API
Examples

Request

Example of a request to return all services to all countries with a localized name in Spanish:

{
    "Amount": "100",
    "CurrencyCode": "USD",
    "ProductCodes": null,
    "CultureCode": "es"
}

Response

This response contains all the available rates (by flat rates shipping campaign).

{
    "destinationCountry": "FO",
    "status": "active",
    "shippingRates": [{
            "shippingMethodLocalizedName": "Envío express",
            "shippingMethodName": "Express Courier (Air)",
            "rangeMinValue": 0.0000,
            "rangeMaxValue": 10000000000.0000,
            "shippingCost": 35.0000,
            "shippingCostCurrency": "USD",
            "estimatedDeliveryDays ": "3-10",
            "specialOfferExpiryDate ": null
        }
    ]
}, {
    "destinationCountry": "FR",
    "status": "active",
    "shippingRates": [{
            "shippingMethodLocalizedName": "Envío estándar",
            "shippingMethodName": "Standard Courier",
            "rangeMinValue": 40.0000,
            "rangeMaxValue": 440.0000,
            "shippingCost": 0.0000,
            "shippingCostCurrency": "EUR",
            "estimatedDeliveryDays ": "2-10",
            "specialOfferExpiryDate ": null
        }, {
            "shippingMethodLocalizedName": "Envío express",
            "shippingMethodName": "Express Courier (Air)",
            "rangeMinValue": 40.0000,
            "rangeMaxValue": 440.0000,
            "shippingCost": 15.0000,
            "shippingCostCurrency": "EUR",
            "estimatedDeliveryDays ": "1-2",
            "specialOfferExpiryDate ": null
        }, {
            "shippingMethodLocalizedName": "Envío express",
            "shippingMethodName": "Express Courier (Air)",
            "rangeMinValue": 440.0000,
            "rangeMaxValue": 999999999.0000,
            "shippingCost": 0.0000,
            "shippingCostCurrency": "EUR",
            "estimatedDeliveryDays ": "1-2",
            "specialOfferExpiryDate ": null
        }, {
            "shippingMethodLocalizedName": "Envío estándar",
            "shippingMethodName": "Standard Courier",
            "rangeMinValue": 440.0000,
            "rangeMaxValue": 999999999.0000,
            "shippingCost": 0.0000,
            "shippingCostCurrency": "EUR",
            "estimatedDeliveryDays ": "2-10",
            "specialOfferExpiryDate ": null
        }
    ]
}, {
    "destinationCountry": "GB",
    "status": "active",
    "shippingRates": [{
            "shippingMethodLocalizedName": "Envío express",
            "shippingMethodName": "Express Courier (Air)",
            "rangeMinValue": 0.0000,
            "rangeMaxValue": 10000000000.0000,
            "shippingCost": 10.0000,
            "shippingCostCurrency": "USD",
            "estimatedDeliveryDays ": "1-1",
            "specialOfferExpiryDate ": null
        }, {
            "shippingMethodLocalizedName": "Envío estándar",
            "shippingMethodName": "Standard Courier",
            "rangeMinValue": 0.0000,
            "rangeMaxValue": 10000000000.0000,
            "shippingCost": 10.0000,
            "shippingCostCurrency": "USD",
            "estimatedDeliveryDays ": "2-2",
            "specialOfferExpiryDate ": null
        }
    ]
},