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 Authorization
header, 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
Request 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
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.)
| 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
|
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 The
|
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 |
500 | Issue with JWT authentication, such as wrong credentials or expired token. |
Classes
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 |
---|---|---|---|
| Decimal (Float) | The shipping cost This number can contain up to two digits after the decimal point Example: 50.30 | Yes |
| String | Determines the shipping method description language. Default: en-GB | No |
| String | The country's currency code. Length: 3 letters Example: CAD , USD , ILS , EUR | Yes |
| 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 |
| Array | The unique product reference (SKU, EAN, Barcode, and more.)
| No |
| Integer | Supported Service levels (default) = Revert to all shipping rates available, for instance, if the request passed with amount = 0.
Default output for all service levels (express / standard ) | No |
Parameters
Parameter | Type | Description |
---|---|---|
| Decimal | Double representation of range minimum value Maximum order/product price for a price range (includes 4 decimals) Example: 150.0000 |
| Decimal | Double representation of range minimum value Minimum order/product price for a price range (includes 4 decimals) Example: 100.0000 |
| String | The merchant's default currency for the destination (3 letters ISO code) Example: EUR, USD, ILS |
| Decimal | The shipping costs for the order/product price range (includes 4 decimals) Example: 5.0000 |
| String | The name of the shipping method type name |
| String | The type of shipping service Shipping types: standard, express, tracked, and more. Example: Standard, Express Courier (Air) |
| 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 The
|
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 } ] },