Shipping Options Details

Prerequisites

API Access

Global‑e must enable and configure each API on the Global‑e side. Make sure that Global‑e has enabled this API.

Permissions and Credentials

Make sure you have the API UserName header and the Authorization header, including the token retrieved via the GetAuthenticationToken API using merchant-specific credentials (provided to you by Global‑e). Your merchantGUID. The merchantGUID is provided to you by Global-e during the initial setup. Note that the merchantGUID is different for test and live environments. The API UserName header and the Authorizationheader, including the token retrieved via the GetAuthenticationToken API using merchant-specific credentials (provided to you by Global‑e). See the Authentication section under Global-e Environments.

GetShippingDetails API Structure

Retrieves shipping details per cart or mini cart and product page. Method/URL POST https://{globale_api_domain}/ShippingDetails/GetShippingDetails Parameters Request URL Parameters

Name	Type	Description	Mandatory
merchantGUID	String	Unique Merchant Identifier and API token.The Merchant Identifier is different for test and live environments.Instead implement JWT authentication.	No, if used for the JWT implementation (since it has been used in the Authorization and UserName headers)

Request Body Parameters

Name	Type	Description	Mandatory
destinationCountry	String	The destination countryLength: 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
currencyCode	String	The country’s currency code.Length: 3 lettersExample: CAD , USD , ILS , EUR	Yes
amount	Decimal (Float)	The shipping costThis number can contain up to two digits after the decimal pointExample: 50.30	Yes
productCodes	Array	The unique product reference (SKU, EAN, Barcode, and more.)`["product123","productABC"]`	No

Response The API response can include up to two objects per destination:

Object with the cheapest estimated shipping cost for the submitted currency and amount value
Object with the Free Shipping threshold range (where applicable).

The returned data is determined by the submitted amount, that is, the response only returns a shipping service for which the amount passed in the request is greater than or equal to the minimum flat shipping rate range, and lower than the maximum flat shipping rate range. Minimum flat shipping rate range ≤ product/cart amount < maximum flat shipping rate range. Response Parameters

NameName	Type	Description
destinationCountry	String	The destination country’s ISO codeLength: 2/3-letters ISO country code based on the request valueExample: ISR, IL, USA, US
status	String	Shipping methods availability`Active`: Shipping methods were found for this destination`noShippingMethodsAvailable`: No active shipping methods were found. Shipments to the selected destination are currently not supported.
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 `shippingRates`object contains the following attributes: minOrderSubtotal: maxOrderSubtotal shippingCost shippingCostCurrency shippingPriority estimatedDeliveryDays specialOfferExpiryDate

Response Example

[
    {
        "destinationCountry": "USA",
        "status": "active",
        "shippingRates":
        [
            {
                "minOrderSubtotal": 0.0000,
                "maxOrderSubtotal": 100.0000,
                "shippingCost": 15.0000,
                "shippingCostCurrency": "USD",
                "shippingPriority": "Express Courier (Air)",
                "estimatedDeliveryDays": "1-3",
                "specialOfferExpiryDate": null
            },
            {
                "minOrderSubtotal": 100.0000,
                "maxOrderSubtotal": 9999999.0000,
                "shippingCost": 5.0000,
                "shippingCostCurrency": "USD",
                "shippingPriority": "Express Courier (Air)",
                "estimatedDeliveryDays": "1-3",
                "specialOfferExpiryDate": null
            }
        ]
    }
]

Examples

Request Example

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

Response Example

[
    {
        "destinationCountry": "USA",
        "status": "active",
        "shippingRates": [
            {
                "minOrderSubtotal": 0.0000,
                "maxOrderSubtotal": 100.0000,
                "shippingCost": 15.0000,
                "shippingCostCurrency": "USD",
                "shippingPriority": "Express Courier (Air)",
                "estimatedDeliveryDays": "1-3",
                "specialOfferExpiryDate": null
            },
            {
                "minOrderSubtotal": 100.0000,
                "maxOrderSubtotal": 9999999.0000,
                "shippingCost": 0.0000,
                "shippingCostCurrency": "USD",
                "shippingPriority": "Express Courier (Air)",
                "estimatedDeliveryDays": "1-3",
                "specialOfferExpiryDate": null
            }
        ]
    }
]

Failures Error Code 500

{
  "Code": "500",      
  "Error": "Error occurred, Please contact Global‑e",    
  "Description": "Please send valid authentication token/userName in HTTP headers (Authorization/UserName)"    
}

Error Code 401

{
    "Code": "401",
    "Error": "Parameter merchantGUID is not a valid GUID. Provided value C064DA15-65E6-42B7-B705-3554FC631.
    MerchantId=",
    "Description": "Please provide the valid merchantGUID as supplied to you during initial setup"
}

Error Code 400

{
    "Code": "400",
    "Error": "Invalid country code",
    "Description": "Country with code UT not found"
}

{
    "Code": "400",
    "Error": "Parameter Amount was not a number", 
    "Description": "Please provide a valid value for the Amount parameter"
}

{
    "Code": "400",
    "Error": "Invalid currency code",
    "Description": "Currency with code D not found"
}

Missing Parameter Error

{
    "Code": "EmptyString",
    "Error": "Parameter Currency was empty or null",    
    "Description": "Please provide a valid value for the Currency parameter"
}

Error Codes

Code	Description
400	Error. Problem with the data passed in the request payload.
401	Error. The authorization has failed for this merchant GUID. Note: The `merchantGUID` is different for test and live environments.
500	Issue with JWT authentication, such as wrong credentials or expired token.

Classes

ShippingRates

Name	Type	Description
`estimatedDeliveryDays`	String	The estimated number of days required for the selected shipping service to deliver to the selected destination country.This parameter displays the widest range for the aggregated shipping methods available for the submitted values on the pre-checkout page.Example: 1-3 days.Two shipping methods are available for the submitted values, one ranging between 1-3 delivery days and the other 4-5 delivery days. Thus, the estimated output range is 1-3 days.Note: This parameter does NOT include the additional days configured in the Global‑e system for fulfilment.
`maxOrderSubtotal`	Decimal	Maximum order/product price for a price range (includes 4 decimals)Example: 15.000
`minOrderSubtotal`	Decimal	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
`shippingPriority`	String	The type of shipping serviceShipping types: standard, express, tracked, and more.Example: Standard, Express Courier (Air)
`specialOfferExpiryDate`	String	The expiration date and time for the special offer`DATE/TIME`Displayed when the returned shipping object is linked to an active marketing campaign configured in the Global‑e system.Date/time format: `yyyy-mm-ddThh:mm:ss`Example: 2022-11-30T00:00:00``NULLDisplayed for campaigns/ rates without expiration dates and times.

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 costThis number can contain up to two digits after the decimal pointExample: 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 lettersExample: CAD , USD , ILS , EUR	Yes
`DestinationCountry`	String	The destination countryLength: 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 = 19Default output for all service levels (express / standard )	No

Response

Parameter	Type	Description
`rangeMaxValue`	Decimal	Double representation of range minimum valueMaximum order/product price for a price range (includes 4 decimals)Example: 150.0000
`rangeMinValue`	Decimal	Double representation of range minimum valueMinimum 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 serviceShipping 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 `shippingRates`object contains the following attributes: minOrderSubtotal: maxOrderSubtotal shippingCost shippingCostCurrency shippingPriority estimatedDeliveryDays specialOfferExpiryDate

Objects for GetShippingDetailsExtended API

ShippingRates

Name	Type	Description
`estimatedDeliveryDays`	String	The estimated number of days required for the selected shipping service to deliver to the selected destination country.This parameter displays the widest range for the aggregated shipping methods available for the submitted values on the pre-checkout page.Example: 1-3 days.Two shipping methods are available for the submitted values, one ranging between 1-3 delivery days and the other 4-5 delivery days. Thus, the estimated output range is 1-3 days.Note: This parameter does NOT include the additional days configured in the Global‑e system for fulfilment.
`maxOrderSubtotal`	Decimal	Maximum order/product price for a price range (includes 4 decimals)Example: 15.000
`minOrderSubtotal`	Decimal	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
`shippingPriority`	String	The type of shipping serviceShipping types: standard, express, tracked, and more.Example: Standard, Express Courier (Air)
`specialOfferExpiryDate`	String	The expiration date and time for the special offer`DATE/TIME`Displayed when the returned shipping object is linked to an active marketing campaign configured in the Global‑e system.Date/time format: `yyyy-mm-ddThh:mm:ss`Example: 2022-11-30T00:00:00``NULLDisplayed for campaigns/ rates without expiration dates and times.

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
        }
    ]
},