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

# Get free shipping banner data, anonymous (Merchant to Global-e)

> Retrieves the same free shipping banner data with no authentication. The merchant is supplied as `merchantId` in the URL path. Intended for integrations that cannot hold a merchant GUID securely (for example Shopify themes and other storefront integrations). The endpoint returns only the banner text and threshold already displayed publicly on the storefront; no confidential data is exposed.

> [!NOTE]
>
> Part of the [Free Shipping Banner Data](https://docs.global-e.com/free-shipping-banner-data-api.md) integration guide — see it for when and how to use this endpoint.


## OpenAPI

````yaml api-reference/specs/freeshippingbannerdata.yaml GET /banners/data/{merchantId}/free-shipping
openapi: 3.0.3
info:
  title: FreeShippingBannerData
  version: 1.0.0
  description: >-
    Retrieves the free shipping banner configuration and localized message for a
    specific country, culture, and currency combination.
servers:
  - url: https://{globale_api_domain}
    variables:
      globale_api_domain:
        default: globale_api_domain
        description: Global-e API host, supplied to the merchant by Global-e.
security: []
tags:
  - name: FreeShippingBannerData
    x-page-title: FreeShippingBannerData
  - name: 'Direction: Merchant → Global-e'
  - name: 'Domain: Shipping'
paths:
  /banners/data/{merchantId}/free-shipping:
    get:
      tags:
        - FreeShippingBannerData
      summary: Get free shipping banner data (anonymous)
      description: >-
        Retrieves the same free shipping banner data with no authentication. The
        merchant is supplied as `merchantId` in the URL path. Intended for
        integrations that cannot hold a merchant GUID securely (for example
        Shopify themes and other storefront integrations). The endpoint returns
        only the banner text and threshold already displayed publicly on the
        storefront; no confidential data is exposed.
      operationId: getFreeShippingBannerDataByMerchantId
      parameters:
        - name: merchantId
          in: path
          required: true
          schema:
            type: integer
            format: int64
          description: >-
            Global-e merchant ID, supplied as a path segment (for example
            `1803`). Do not send a merchant GUID.
        - $ref: '#/components/parameters/countryCode'
        - $ref: '#/components/parameters/cultureCode'
        - $ref: '#/components/parameters/currencyCode'
      responses:
        '200':
          $ref: '#/components/responses/BannerData'
        '400':
          description: >-
            Bad request. Returned when the merchant is unknown or inactive, when
            a

            request parameter is invalid, or when the banner data could not be
            built,

            including when a query parameter is sent with an empty value (the
            body is

            then the banner data with a `CorrelationId`).


            | Code | Error | Cause |

            |---|---|---|

            | `MerchantNotFound` | Parameter `<merchantId>` was not found or
            inactive | The `merchantId` in the path does not exist, or the
            merchant is inactive |

            | `400` | Invalid country code | `countryCode` is not 2 or 3
            characters, or does not match a country |

            | `400` | Invalid currency code | `currencyCode` is invalid or
            unsupported |

            | `400` | Invalid culture code | `cultureCode` does not match any
            supported culture |
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorInfo'
                  - $ref: '#/components/schemas/FreeShippingBannerData'
              examples:
                MerchantNotFound:
                  summary: Unknown or inactive merchant
                  value:
                    Code: MerchantNotFound
                    Error: Parameter 1803 was not found or inactive
                    Description: Please provide a valid value for the MerchantId parameter
                    Success: false
                InvalidCultureCode:
                  $ref: '#/components/examples/InvalidCultureCode'
                InvalidCurrencyCode:
                  $ref: '#/components/examples/InvalidCurrencyCode'
                InvalidCountryCode:
                  $ref: '#/components/examples/InvalidCountryCode'
                ServiceError:
                  $ref: '#/components/examples/ServiceError'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    countryCode:
      name: countryCode
      in: query
      required: true
      schema:
        type: string
        minLength: 2
        maxLength: 3
      description: ISO 3166-1 alpha-2 or alpha-3 country code (for example `GB`).
    cultureCode:
      name: cultureCode
      in: query
      required: true
      schema:
        type: string
        maxLength: 10
      description: Culture code (for example `en-GB`).
    currencyCode:
      name: currencyCode
      in: query
      required: true
      schema:
        type: string
        maxLength: 3
      description: ISO 4217 currency code (for example `GBP`).
  responses:
    BannerData:
      description: Free shipping banner data. Identical for both endpoints.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FreeShippingBannerData'
          examples:
            NoFreeShipping:
              summary: No free shipping for the country
              value:
                IsEnabled: true
                CurrencyCode: GBP
                CultureCode: en-GB
                CountryCode: GB
                Text: Enjoy our great international shipping rates
                FreeShippingThreshold: -1
            OverThreshold:
              summary: Free shipping above a threshold
              value:
                IsEnabled: true
                CurrencyCode: USD
                CultureCode: en-US
                CountryCode: US
                Text: Free shipping to United States on all orders above $50.00.
                FreeShippingThreshold: 50
    NotFound:
      description: >-
        Not found. Returned when `countryCode`, `cultureCode`, or `currencyCode`
        is omitted from the query string, or when `merchantId` is not a number.
        All three query parameters must be present for the request to match the
        endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFoundMessage'
          example:
            Message: >-
              No HTTP resource was found that matches the request URI
              'https://{globale_api_domain}/banners/data/1803/free-shipping?currencyCode=GBP&cultureCode=en-GB'.
            MessageDetail: >-
              No action was found on the controller 'Banners' that matches the
              request.
    ServerError:
      description: >-
        Internal server error. The body contains only a `CorrelationId` to quote
        to Global-e support.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CorrelationIdEnvelope'
          example:
            CorrelationId: abc12345-6789-4abc-9def-1234567890ab
  schemas:
    ErrorInfo:
      type: object
      title: ErrorInfo
      properties:
        Code:
          type: string
          description: Error code.
        Error:
          type: string
          description: Error message.
        Description:
          type: string
          nullable: true
          description: Error description.
        Success:
          type: boolean
          description: Always `false` on an error response.
    FreeShippingBannerData:
      type: object
      title: FreeShippingBannerData
      properties:
        IsEnabled:
          type: boolean
          description: Indicates whether the free shipping banner is enabled.
        CurrencyCode:
          type: string
          nullable: true
          description: Currency used for evaluating free shipping.
        CultureCode:
          type: string
          nullable: true
          description: Culture used for localization.
        CountryCode:
          type: string
          nullable: true
          description: Country evaluated for shipping policy.
        Text:
          type: string
          nullable: true
          description: Localized free shipping banner message.
        FreeShippingThreshold:
          type: number
          format: double
          description: >-
            `-1` = no free shipping; `0` = free for all orders; `>0` = free
            shipping above the given amount.
        CorrelationId:
          type: string
          nullable: true
          description: >-
            Returned only when the banner data could not be built (HTTP 400).
            Quote it to Global-e support.
    NotFoundMessage:
      type: object
      title: NotFoundMessage
      properties:
        Message:
          type: string
          description: Error message.
        MessageDetail:
          type: string
          description: Error details.
    CorrelationIdEnvelope:
      type: object
      title: CorrelationIdEnvelope
      properties:
        CorrelationId:
          type: string
          description: Identifier of the failed request. Quote it to Global-e support.
  examples:
    InvalidCultureCode:
      summary: Invalid culture code
      value:
        Code: '400'
        Error: Invalid culture code
        Description: Culture with code en-G not found
        Success: false
    InvalidCurrencyCode:
      summary: Invalid currency code
      value:
        Code: '400'
        Error: Invalid currency code
        Description: Currency with code GB not found
        Success: false
    InvalidCountryCode:
      summary: Invalid country code
      value:
        Code: '400'
        Error: Invalid country code
        Description: Please provide a valid b country code
        Success: false
    ServiceError:
      summary: Banner data could not be built
      value:
        IsEnabled: false
        CurrencyCode: null
        CultureCode: null
        CountryCode: null
        Text: null
        FreeShippingThreshold: 0
        CorrelationId: 00000000-0000-0000-0000-000000000000

````

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