Sign in

v1

latestOpenAPI 3.0.02026-07-262832203.2 KB
GET

Retrieve locale data from Reach.

get/localize

Query parameters

MerchantIdstring uuid required

The 36 character GUID which identifies the supplier to the Reach system.

The 36 character GUID which identifies the supplier to the Reach system.

Callbackstring

JSONP Javascript function name.

The JSONP Javascript function name.

Countrystring

An upper-case ISO 3166 alpha-2 country code.

If the supplier already knows the consumer's country, the ISO3166-1-alpha-2 can be passed in to fetch the localization data for that country. If this is specified, the GEO-IP lookup will be bypassed.

Currencystring

An upper-case 3 character ISO 4217 currency code.

The upper-case 3 character ISO 4217 currency code to get the symbol and units for, if available.

IncludeRateboolean

If true, the latest rate offer will be returned. If not included, or false, a rate offer will not be returned.

string ipv4
OR
string ipv6

This parameter must be specified when the request is being made on behalf of the consumer, not directly via the consumer's browser. If a Country is specified, this is ignored.

Pricenumber double required

The price to convert.

Tagstring

A tag associated with the price. This may be a SKU, ID, group,etc.

If the supplier is configured to use Reach's Vanity Pricing, a set of tags and associated prices.

Response

Locale information was able to be retrieved.

Countrystring

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.

Currencystring

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.

Symbolstring

The symbol for the currency, if applicable (e.g. $, £, Kč).

Unitsinteger

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.

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

ConsumerPricesnumber[]

An array of prices in the requested currency, in the same order as the MerchantPrices specified in the request.