Skip to main content

Documentation Portal

Shipping Methods

 

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 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

currencyCode

String

The country's currency code.

Length: 3 letters

Example: CAD , USD , ILS , EUR

Yes

amount

Decimal (Float)

The shipping cost

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

Example: 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 code

Length: 2/3-letters ISO country code based on the request value

Example: 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
            }
        ]
    }
]
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

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 country's currency code.

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

Yes

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

Parameters

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 shippingRates object contains the following attributes:

  • minOrderSubtotal:

  • maxOrderSubtotal

  • shippingCost

  • shippingCostCurrency

  • shippingPriority

  • estimatedDeliveryDays

  • specialOfferExpiryDate

Example

Request Example

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 Example

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
        }
    ]
},
Classes
Void Parcel

Introduction

The Void Parcel API lets you take out a declared parcel if you do not intend to send it or if it needs to be updated due to changed shipment requirements.

Note: At least one order ID should be provided in the request, Global-e OrderId or the merchant's MerchantOrderId.

Integration Overview

Method/URL

POST https://{globale_api_domain}/Parcel/VoidParcel

PARAMETERS:

  • string OrderId (mandatory) - Order unique identifier

  • string ParcelCode (mandatory) - Code used to identify the ParcelCode to void.

  • string MerchantOrderId - The merchant's order unique identifier.

Example

Request:

{
  "OrderId": "#12354", "ParcelCode": "454234", "MerchantOrderId": "#1138"
}

Response:

{
  "IsSuccess":true, "Errors":[]
}
Error Handling

Error Code 

Error Text 

Additional Information 

C100 

The parcel cannot be voided due to the status of the parcel. 

For a Global‑e operated hub, only the following statuses can be voided:

Failed Transfer To Shipping 

Shipped By Merchant 

This is the error in case the hub is operated by Global-e and the parcel has the wrong status. 

C101 

The parcel cannot be voided due to the status of the parcel.  For merchant-operated hubs, only the following statuses can be voided:

Failed Transfer To Shipping

Shipped By Merchant

Received In Hub 

This is the error in case the hub is operated by the Merchant and the parcel has the wrong status. 

C102 (Log) 

The parcel was voided, but the shipper's API to cancel the shipment failed. 

The following information is available from the shipper.

Error code: <shipper error code>

Error text: <error text> 

The API success (IsSuccess=True). 

Add it to the log and to the relevant field in the response  

C103 

Internal unknown failure 

-

C104

The parcel code was not found, or the parcel was already voided

-