Skip to main content
GET
Get free shipping banner data (anonymous)
Part of the Free Shipping Banner Data integration guide — see it for when and how to use this endpoint.

Path Parameters

merchantId
integer<int64>
required

Global-e merchant ID, supplied as a path segment (for example 1803). Do not send a merchant GUID.

Query Parameters

countryCode
string
required

ISO 3166-1 alpha-2 or alpha-3 country code (for example GB).

Required string length: 2 - 3
cultureCode
string
required

Culture code (for example en-GB).

Maximum string length: 10
currencyCode
string
required

ISO 4217 currency code (for example GBP).

Maximum string length: 3

Response

Free shipping banner data. Identical for both endpoints.

IsEnabled
boolean

Indicates whether the free shipping banner is enabled.

CurrencyCode
string | null

Currency used for evaluating free shipping.

CultureCode
string | null

Culture used for localization.

CountryCode
string | null

Country evaluated for shipping policy.

Text
string | null

Localized free shipping banner message.

FreeShippingThreshold
number<double>

-1 = no free shipping; 0 = free for all orders; >0 = free shipping above the given amount.

CorrelationId
string | null

Returned only when the banner data could not be built (HTTP 400). Quote it to Global-e support.