> ## Documentation Index
> Fetch the complete documentation index at: https://docs.global-e.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API to Retrieve Free Shipping Banner Data

## Overview

Retrieve the free shipping banner configuration and localized message for a specific country, culture, and currency combination. The data is available through two endpoints that return an identical response and differ only in how the merchant is identified:

* **Authenticated** – merchant resolved from the authentication context (merchant GUID).
* **Anonymous** – merchant supplied as `merchantId` in the URL path, no authentication required. Intended for integrations that cannot hold a merchant GUID securely (for example Shopify themes and other storefront integrations).

## Prerequisites

Merchant must have the free shipping banner configuration feature enabled.

## Security Requirements

**Authenticated endpoint**

* Authenticated request required.
* Merchant GUID is resolved from the authentication context.

**Anonymous endpoint**

* No authentication required – do not send a merchant GUID.
* The merchant is identified by the numeric `merchantId` in the URL path.
* The endpoint returns only the banner text and threshold already displayed publicly on the storefront; no confidential data is exposed.

> [!NOTE]
>
> The `merchantId` is part of the **path**, not a query-string parameter. Adding `&merchantId=` to the authenticated URL will not work – that request is still authenticated and returns `401`.

## Reference

> [card] [Get free shipping banner data — reference & playground](https://docs.global-e.com/api-reference/get-free-shipping-banner-data.md)
>
> Request (`countryCode`, `cultureCode`, `currencyCode`), the banner data response, error shapes, and examples for the authenticated `GET /banners/data/free-shipping`.

> [card] [Get free shipping banner data (anonymous) — reference & playground](https://docs.global-e.com/api-reference/get-free-shipping-banner-data-anonymous.md)
>
> Request (`merchantId` in the path, `countryCode`, `cultureCode`, `currencyCode`), the same banner data response, error shapes, and examples for `GET /banners/data/{merchantId}/free-shipping`.

## Use Cases

### 1. Retrieve the banner data (authenticated)

```
{API_BASE_URL}/banners/data/free-shipping?countryCode=GB&currencyCode=GBP&cultureCode=en-GB
```

### 2. Retrieve the banner data (anonymous)

```
{API_BASE_URL}/banners/data/1803/free-shipping?countryCode=GB&currencyCode=GBP&cultureCode=en-GB
```

Both calls return the same response:

```json Response theme={null}
{
    "IsEnabled": true,
    "CurrencyCode": "GBP",
    "CultureCode": "en-GB",
    "CountryCode": "GB",
    "Text": "Enjoy our great international shipping rates",
    "FreeShippingThreshold": -1.0
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.