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

# GetMerchantPriceDetails

> Obtain the parameters required to calculate international product prices in a destination country's currency.

<Note>
  Part of the [International Prices](/international-prices) integration guide — see it for when and how to use this endpoint.
</Note>


## OpenAPI

````yaml api-reference/specs/getmerchantpricedetails.yaml GET /externalapi/GetMerchantPriceDetails
openapi: 3.0.3
info:
  title: GetMerchantPriceDetails
  version: 1.0.0
  x-scaled-review: true
  description: >-
    This Global-e GetMerchantPriceDetails REST API enables merchants to obtain
    the parameters required to calculate product prices in a destination country
    currency.
servers:
  - url: https://{GEM_API_URL}
    variables:
      GEM_API_URL:
        default: gem-api-host.example.com
        description: >-
          The API host name, based on the environment (such as sandbox, live,
          and more).
security: []
tags:
  - name: GetMerchantPriceDetails
    x-page-title: GetMerchantPriceDetails
  - name: 'Direction: Merchant → Global-e'
  - name: 'Domain: Products'
paths:
  /externalapi/GetMerchantPriceDetails:
    get:
      tags:
        - GetMerchantPriceDetails
      summary: GetMerchantPriceDetails
      description: >-
        This API enables merchants to obtain the parameters required to
        calculate international product prices in a destination country's
        currency.
      operationId: getMerchantPriceDetails
      parameters:
        - name: merchantToken
          in: query
          required: true
          schema:
            type: string
          description: >-
            Secret token (unique merchant ID) to be provided to the merchant by
            Global‑e.
        - name: Country
          in: query
          required: true
          schema:
            type: string
          description: |-
            2-char ISO destination country code.
            Example: IL
        - name: Currency
          in: query
          required: true
          schema:
            type: string
          description: >-
            3-char ISO currency code of the customer's country (destination
            country).

            Example: ILS
      responses:
        '200':
          description: >-
            The set of price calculation parameters and rules for the requested
            destination country and currency.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantPriceDetails'
              example:
                countryCode: IL
                countryCode3: ISR
                countryName: Israel
                currencySymbol: ₪
                currencyCode: ILS
                currencyFormatSymbol:
                  PlaceCurrencySymbolBeforePrice: true
                  UseCurrencySymbolSpace: false
                currencyDecimalNominator: .
                currencyThousandSeparator: ','
                currencyDecimalPlaces: 0
                culture: he
                baseCountryCode: GB
                baseCurrencySymbol: £
                baseCurrencyCode: GBP
                baseCurrencyDecimalPlaces: 2
                isOperatedByGlobale: true
                currencyConversionRate: 284.0018489445
                countryCoefficientRate: 1.05
                productClassCoefficients:
                  extra-charge: 1.8
                isGrossPrices: true
                roundingRules:
                  RoundingRuleId: 108
                  CurrencyCode: ILS
                  CountryCode: null
                  RoundingRanges:
                    - From: 1
                      To: 100
                      Threshold: 0.01
                      LowerTarget: 1
                      UpperTarget: 1
                      RangeBehavior: 3
                      TargetBehaviorHelperValue: 1
                      RoundingExceptions: []
                    - From: 100
                      To: 1000
                      Threshold: 5.01
                      LowerTarget: 15
                      UpperTarget: 10
                      RangeBehavior: 3
                      TargetBehaviorHelperValue: 10
                      RoundingExceptions: []
                    - From: 1000
                      To: 10000
                      Threshold: 50.01
                      LowerTarget: 150
                      UpperTarget: 100
                      RangeBehavior: 3
                      TargetBehaviorHelperValue: 100
                      RoundingExceptions: []
                    - From: 10000
                      To: 100000000000000
                      Threshold: 0.01
                      LowerTarget: 100
                      UpperTarget: 100
                      RangeBehavior: 3
                      TargetBehaviorHelperValue: 100
                      RoundingExceptions: []
                vatSettings:
                  VATTypeId: 0
                  LocalVATRate: 20
                  DistanceSellingVATRate: 20
                  UseDistanceSellingVAT: false
components:
  schemas:
    MerchantPriceDetails:
      type: object
      title: MerchantPriceDetails
      description: >-
        The price calculation parameters and rules returned for a destination
        country and currency. Field names, types, and descriptions are taken
        verbatim from the docs "Parameters" (Response) table;
        `currencyFormatSymbol` and `isGrossPrices` appear only in the worked
        example (no table row) and are flagged in review §2.
      properties:
        countryCode:
          type: string
          description: |-
            2-char ISO destination country code.
            Example: IL
        countryCode3:
          type: string
          description: |-
            3-char ISO destination country code.
            Example: ISR
        countryName:
          type: string
          description: |-
            The name of the destination country.
            Example: Israel
        currencySymbol:
          type: string
          description: |-
            The symbol of the currency in the destination country.
            Example: ₪
        currencyCode:
          type: string
          description: >-
            3-char ISO currency code of the customer's country (destination
            country).

            Example: ILS
        currencyFormatSymbol:
          $ref: '#/components/schemas/CurrencyFormatSymbol'
        currencyDecimalNominator:
          type: string
          description: |-
            Currency decimal separator type.
            ("," or ".")
            Example:
            XX.XX
            XX,XX
        currencyThousandSeparator:
          type: string
          description: |-
            Currency thousands separator indicator.
            ("," or ".")
            Example:
            XXX.XXX
            XXX,XXX
        currencyDecimalPlaces:
          type: integer
          format: int32
          description: |-
            Currency decimal places.
            Example: 0
        culture:
          type: string
          description: |-
            The language or locale of the destination country.
            Example: he
        baseCountryCode:
          type: string
          description: |-
            Merchant's base country code 2-char ISO.
            Example: GB
        baseCurrencySymbol:
          type: string
          description: >-
            The symbol of the currency in the country or origin (merchant's
            country or base country).

            Example: £
        baseCurrencyCode:
          type: string
          description: The currency code in the merchant's base country.
        baseCurrencyDecimalPlaces:
          type: integer
          format: int32
          description: |-
            Currency decimal places in the base currency.
            Example: 2
        isOperatedByGlobale:
          type: boolean
          description: >-
            Whether the selected country is operated by Global-e. This flag is
            be used as a Mode indicator. True: yes. In this case, Global-e
            converts the prices and opens their checkout. False: no. Countries
            that are not operated by Global‑e must still be available for
            selection as a shipping destination on the merchant's site. However
            Global‑e functionality must be disabled for such countries.
        currencyConversionRate:
          type: number
          description: >-
            Conversion rate between the base currency (GBP in this example) and
            the converted currency (ILS in this example). Example:
            284.001848944500
        countryCoefficientRate:
          type: number
          description: |-
            Price uplift as set for this destination country.
            Example: 1.050000
        productClassCoefficients:
          type: object
          additionalProperties:
            type: number
          description: >-
            Product uplift as set per product (if the product uplift is set,
            this parameter overrides the country uplift), TYPE = object of key
            or value pairs (string / decimal). Example: {"extra-charge": 1.05,
            "special": 1.1}
        isGrossPrices:
          type: boolean
          description: >-
            Present only in the worked example (no Parameters-table row); type
            inferred from the example value.
        roundingRules:
          $ref: '#/components/schemas/RoundingRule'
        vatSettings:
          $ref: '#/components/schemas/VatSettings'
    CurrencyFormatSymbol:
      type: object
      title: currencyFormatSymbol
      description: >-
        Currency formatting flags. Inferred entirely from the worked example (no
        property table on the page); types inferred from the example values. See
        review §2.
      properties:
        PlaceCurrencySymbolBeforePrice:
          type: boolean
        UseCurrencySymbolSpace:
          type: boolean
    RoundingRule:
      type: object
      title: RoundingRule
      description: >-
        List of rounding rules that are applied when converting the prices,
        based on the rounding rule ranges and business rules.
      properties:
        RoundingRuleId:
          type: integer
          format: int64
          description: >-
            Rule identifier denoting the respective Rounding Rule on Global‑e
            side. This value must be further specified when calling
            SaveProductsList and SendCart methods.
        CurrencyCode:
          type: string
          description: 3-char ISO currency code
        CountryCode:
          type: string
          nullable: true
          description: 2-char ISO country code
        RoundingRanges:
          type: array
          description: List of decimal ranges and their respective rounding behaviours
          items:
            $ref: '#/components/schemas/RoundingRange'
    VatSettings:
      type: object
      title: vatSettings
      description: >-
        VAT settings and calculation. Only applicable to European countries.
        Properties verbatim from the "VAT Settings" > VAT Options property
        table.
      properties:
        VATTypeId:
          type: integer
          format: int32
          enum:
            - 0
            - 4
            - 6
          description: >-
            ID indicating how the merchant has decided to treat the local VAT
            for customers in the relevant territory. Possible values: 0, 4, 6.
            Example: 0. (0 = Hide VAT (default); 4 = "Pocket" VAT; 6 = Force
            VAT.)
        LocalVATRate:
          type: number
          description: |-
            The VAT Rate in the merchant's country.
            Example: 20.000000 (20%)
        UseDistanceSellingVAT:
          type: boolean
          description: >-
            Whether to apply the distance selling VAT. True: Apply the
            destination country's VAT. False: Do not apply the destination
            country's VAT.
        DistanceSellingVATRate:
          type: number
          description: >-
            The distance selling VAT Rate in the shopper's (destination)
            country.

            Example: 21.000000 (21%)
    RoundingRange:
      type: object
      title: RoundingRange
      description: >-
        A decimal range and its rounding behaviour. Properties verbatim from the
        RoundingRange table.
      properties:
        From:
          type: number
          description: >-
            A decimal value of the range start, exclusive of the From value
            itself. If a range must start from 0 inclusive, the From value must
            be set to a negative number. Example: 100.0000
        To:
          type: number
          description: |-
            A decimal value of the range end, inclusive.
            Example: 1000.0000
        Threshold:
          type: number
          description: >-
            A decimal value used to split the range so that the values less than
            the threshold would be rounded to the Lower target, and values
            greater than or equal to the threshold would be rounded to the Upper
            target. For ranges having "Absolute target" behavior, Threshold
            value is considered as an absolute value. For other behaviors it's
            considered as a Relative value. Example: 5.0100
        LowerTarget:
          type: number
          description: >-
            A decimal value used to calculate the target rounded value, for the
            numbers less than the Threshold, according to the defined Range
            behavior. If LowerTarget value violates MaxDecimalPlaces setting for
            the respective currency, it must be truncated as described in the
            "Important Notices" below. Example: 15.0000
        UpperTarget:
          type: number
          description: >-
            A decimal value used to calculate the target rounded value, for the
            numbers greater than or equal to the Threshold, according to the
            defined Range behavior. If UpperTarget value violates
            MaxDecimalPlaces setting for the respective currency, it must be
            truncated as described in the "Important Notices" below. Example:
            10.0000
        RangeBehavior:
          type: integer
          format: int64
          enum:
            - 1
            - 2
            - 3
            - 4
          description: >-
            One of the possible values of the RangeBehaviors enumeration which
            is designated to control the way rounding range is handled. The
            range behavior is applied to Threshold, LowerTarget, UpperTarget and
            Exceptions in RoundingExceptions list. 1 = Absolute target, 2 =
            Relative Decimal target, 3 = Relative Whole target, 4 = Nearest
            target. Example: 3
        TargetBehaviorHelperValue:
          type: number
          description: >-
            A decimal value required for "nearest target" and "relative whole
            target" behaviors. Example: 10.0000
        RoundingExceptions:
          type: array
          items: {}
          description: >-
            List of decimal values used to calculate the exceptions for
            rounding, i.e. values to which not to apply rounding.

````