---
title: "GET /localize"
method: GET
path: "/localize"
tags: ["GET"]
---

# GET /localize

`GET /localize`

Retrieve locale data from Reach.

## Query parameters

- `MerchantId` string, uuid, required — The 36 character GUID which identifies the supplier to the Reach system.
- `Callback` string — JSONP Javascript function name.
- `Country` string — An upper-case ISO 3166 alpha-2 country code.
- `Currency` string — An upper-case 3 character ISO 4217 currency code.
- `IncludeRate` boolean
- `ConsumerIpAddress` union — A valid IP address, v4 or v6.
  - string, ipv4
  - string, ipv6
- `MerchantPrices` object[]
  - `Price` number, double, required — The price to convert.
  - `Tag` string — A tag associated with the price. This may be a SKU, ID, group,etc.

## Response `200`

Locale information was able to be retrieved.

- object
  - `Country` string — The ISO 3166-1-alpha-2 country code specified in the request, or determined by GEO-IP lookup, or null if it could not be determined.
  - `Currency` string — The upper-case 3 character ISO 4217 currency code for the default currency for the country, unless Currency was specified. The currency, and the associated information below, will only be returned if supported by Reach.
  - `Symbol` string — The symbol for the currency, if applicable (e.g. $, £, Kč).
  - `Units` integer — Returned only if a Currency is returned. The number of minor units to display for the currency. Note that up to two decimal places may be specified to checkout.
  - `RateOffer` object — Returned only if a Currency is returned and IncludeRate is true. The current rate offer available for specified currency.
    - `Id` string, uuid, required — A Reach rate offer ID for the supplier that can be used until the specified Expiry.
    - `Expiry` string, date-time, required — The RFC 3339 timestamp at which this rate offer expires.
    - `Rate` number, double, required — The Reach guaranteed exchange rate.
  - `Rate` number, double — Returned only if a Currency is returned and IncludeRate is true. The current non-guaranteed market rate for the specified currency, if spot rates are enabled and guaranteed rates are not enabled.
  - `ConsumerPrices` number[] — An array of prices in the requested currency, in the same order as the MerchantPrices specified in the request.

## Other responses

- `400` — If present, the localize request structure was invalid and unable to be parsed.
- `404` — If present, a value of the request was unable to be found. For example, if the MerchantId provided could not be found in the given environment
- `503` — There was a system problem and the request should be tried again.

---

[API](https://skmtc.net/withreach/apis/reach-checkout-api.md) · [All operations](https://skmtc.net/withreach/apis/reach-checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/withreach/reach-checkout-api/versions/f95f4b8dd180/schema)