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

# Get shipping details

> Retrieves the cheapest estimated shipping cost and the free-shipping threshold range per destination, for a cart, mini cart, or product page.

<Note>
  Part of the [Shipping Options Details](/shipping-options-api) integration guide — see it for when and how to use this endpoint.
</Note>


## OpenAPI

````yaml api-reference/specs/getshippingdetails.yaml POST /ShippingDetails/GetShippingDetails
openapi: 3.0.3
info:
  title: GetShippingDetails
  version: 1.0.0
  description: >-
    Retrieves shipping details per cart or mini cart and product page. Returns
    up to two shipping-rate objects per destination — the cheapest estimated
    shipping cost for the submitted currency and amount, and the Free Shipping
    threshold range where applicable.
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: GetShippingDetails
    x-page-title: GetShippingDetails
  - name: 'Direction: Merchant → Global-e'
  - name: 'Domain: Shipping'
paths:
  /ShippingDetails/GetShippingDetails:
    post:
      tags:
        - GetShippingDetails
      summary: >-
        Get the cheapest shipping rate and free-shipping threshold for a
        destination
      description: Retrieves shipping details per cart or mini cart and product page.
      operationId: getShippingDetails
      parameters:
        - name: Authorization
          in: header
          required: false
          schema:
            type: string
          description: >-
            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.
        - name: UserName
          in: header
          required: false
          schema:
            type: string
          description: The API UserName, provided to you by Global‑e.
        - name: merchantGUID
          in: query
          required: false
          schema:
            type: string
          description: >-
            Unique Merchant Identifier and API token. The Merchant Identifier is
            different for test and live environments. Instead implement JWT
            authentication. (Not required if the JWT implementation is used,
            since it is provided in the Authorization and UserName headers.)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetShippingDetailsRequest'
            example:
              destinationCountry: USA
              amount: 50
              currencyCode: USD
              productCodes: []
      responses:
        '200':
          description: >-
            An array of per-destination objects. Each contains the destination,
            the shipping-methods availability status, and up to two
            shipping-rate objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetShippingDetailsResponseItem'
              example:
                - destinationCountry: USA
                  status: active
                  shippingRates:
                    - minOrderSubtotal: 0
                      maxOrderSubtotal: 100
                      shippingCost: 15
                      shippingCostCurrency: USD
                      shippingPriority: Express Courier (Air)
                      estimatedDeliveryDays: 1-3
                      specialOfferExpiryDate: null
                    - minOrderSubtotal: 100
                      maxOrderSubtotal: 9999999
                      shippingCost: 5
                      shippingCostCurrency: USD
                      shippingPriority: Express Courier (Air)
                      estimatedDeliveryDays: 1-3
                      specialOfferExpiryDate: null
        '400':
          description: >-
            Error. Problem with the data passed in the request payload.
            Documented examples include invalid country code, invalid currency
            code, a non-numeric Amount, and empty/null required parameters (Code
            "EmptyString"). See review §2 for the full set of documented
            examples.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
              example:
                Code: '400'
                Error: Invalid country code
                Description: Country with code UT not found
        '401':
          description: >-
            Error. The authorization has failed for this merchant GUID. Note:
            the merchantGUID is different for test and live environments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
              example:
                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
        '500':
          description: >-
            Issue with JWT authentication, such as wrong credentials or an
            expired token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
              example:
                Code: '500'
                Error: Error occurred, Please contact Global‑e
                Description: >-
                  Please send valid authentication token/userName in HTTP
                  headers (Authorization/UserName)
components:
  schemas:
    GetShippingDetailsRequest:
      type: object
      title: GetShippingDetailsRequest
      required:
        - amount
        - currencyCode
      properties:
        destinationCountry:
          type: string
          description: >-
            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.
        currencyCode:
          type: string
          description: >-
            The country's currency code. Length: 3 letters. Example: CAD, USD,
            ILS, EUR.
        amount:
          type: number
          format: float
          description: >-
            The shipping cost. This number can contain up to two digits after
            the decimal point. Example: 50.30.
        productCodes:
          type: array
          items:
            type: string
          description: >-
            The unique product reference (SKU, EAN, Barcode, and more). Example:
            ["product123","productABC"].
    GetShippingDetailsResponseItem:
      type: object
      title: GetShippingDetailsResponseItem
      properties:
        destinationCountry:
          type: string
          description: >-
            The destination country's ISO code. Length: 2/3-letter ISO country
            code based on the request value. Example: ISR, IL, USA, US.
        status:
          type: string
          enum:
            - active
            - noShippingMethodsAvailable
          description: >-
            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:
          type: array
          description: >-
            Contains up to two shipping-service objects, per the Shipping
            Details API logic. If the cheapest shipping service is the first to
            be subject to free shipping, only one shippingRates object is
            returned.
          items:
            $ref: '#/components/schemas/ShippingRates'
    ErrorInfo:
      type: object
      title: ErrorInfo
      description: Error response (Code / Error / Description form).
      properties:
        Code:
          type: string
          description: The error code.
        Error:
          type: string
          description: The error message.
        Description:
          type: string
          description: The error description.
    ShippingRates:
      type: object
      title: ShippingRates
      properties:
        estimatedDeliveryDays:
          type: string
          description: >-
            The estimated number of days required for the selected shipping
            service to deliver to the selected destination country. This
            parameter displays the widest range for the aggregated shipping
            methods available for the submitted values on the pre-checkout page.
            Example: 1-3 days. (If two shipping methods are available for the
            submitted values, one ranging between 1-3 delivery days and the
            other 4-5 delivery days, the estimated output range is 1-3 days.)
            Note: this parameter does NOT include the additional days configured
            in the Global‑e system for fulfilment.
        maxOrderSubtotal:
          type: number
          format: double
          description: >-
            Maximum order/product price for a price range (includes 4 decimals).
            Example: 15.000.
        minOrderSubtotal:
          type: number
          format: double
          description: >-
            Minimum order/product price for a price range (includes 4 decimals).
            Example: 100.0000.
        shippingCostCurrency:
          type: string
          description: >-
            The merchant's default currency for the destination (3-letter ISO
            code). Example: EUR, USD, ILS.
        shippingCost:
          type: number
          format: double
          description: >-
            The shipping costs for the order/product price range (includes 4
            decimals). Example: 5.0000.
        shippingPriority:
          type: string
          description: >-
            The type of shipping service. Shipping types: standard, express,
            tracked, and more. Example: Standard, Express Courier (Air).
        specialOfferExpiryDate:
          type: string
          format: date-time
          nullable: true
          description: >-
            The expiration date and time for the special offer. Displayed
            (format yyyy-mm-ddThh:mm:ss, e.g. 2022-11-30T00:00:00) when the
            returned shipping object is linked to an active marketing campaign
            configured in the Global‑e system. NULL for campaigns/rates without
            expiration dates and times.

````