LocationByIp

Returns the user’s geo-location by IP address. The merchant’s default location is returned if an IP address cannot be found (for example if a private network IP address has been specified).

The merchant-side caching policy defined by this method should be applied to the whole IP range returned for the IP address specified.

Method/URL

https://{server_name}/Browsing/LocationByIP

Parameter

Request

Parameter Name	Type	Description	Mandatory
`IP`	string	The shopper's IP address

Response

Parameter Name	Type	Description
`City`	Object `City`	The shopper's city.
`Country`	Object `Country`	The shopper's country.
`IPRange`	Object `IPRange`	The shopper's IP range.
`Region`	Object `Region`	The shopper's region.

Parameter Name	Type	Description	Mandatory
`Code`	String	City code (unique in the respective Region)
`Name`	String	City name

Country

Parameter Name	Type	Description	Mandatory
`Code`	String	2-char ISO country code
`DefaultCurrencyCode`	String	3-char ISO currency code
`DefaultVATRateType`	Object `VATRateType`	Default (most widely used) VAT rate type or class for this country.	No
`IsOperatedByGlobalE`	Boolean	Flag to be used as a Mode indicator. Countries that are not operated by Global‑e can still be available for selection as a shipping destination on the Merchant site. However Global‑e functionality is disabled for such countries. TRUE - Country is operated by Global-e. FALSE - Country is not operated by Global-e.
`IsStateMandatory`	Boolean	Indicates if State or province (region) is mandatory for addresses in this country. TRUE - State is mandatory for address. FALSE - State is not mandatory for address.
`Name`	String	Country name
`SiteURL`	String	URL of a country-specific site owned by the Merchant. Used to allow redirection to the Merchant’s country-specific domain for a selected country.
`SupportsFixedPrices`	Boolean	Indicates if fixed product prices are allowed for this country. Product prices may be fixed only in the Default Currency for this Country. TRUE - Prices can be fixed. FALSE - Prices cannot be fixed.	No
`UseCountryVAT`	Boolean	TRUE if VAT rate specific to this shipping country must be applied to the product prices. Otherwise, VAT rates defined for the products on the Merchant’s site must be used. This setting is used to support trade agreements between the countries such as EEA, when the end customer must pay VAT for the shipping country in certain cases.	No

VATRateType

Parameter Name	Type	Description	Mandatory
`Name`	String	VAT rate type name	No
`Rate`	Decimal	VAT rate decimal value
`VATRateTypeCode`	String	VAT rate type (or class) code on the Merchant’s site (to be mapped on the Global-e side)

IPRange

A sample code to convert dot-decimal to decimal IPV4 address is available here: http://stackoverflow.com/questions/11548273/convert-an-ip-address-to-its-decimal-equivalent-in-java

Parameter Name	Type	Description
`From`	Decimal	A decimal value of a range start
`To`	Decimal	A decimal value of a range end
`Type`	String	Either IPV4 or IPV6

Region

Parameter Name	Type	Description
`Code`	String	Region code for this state or province (unique in the respective Country)
`CountryCode`	String	2-char ISO country code to which this region belongs
`Name`	String	Region name

Documentation Portal