Skip to main content

Documentation Portal

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