Skip to main content

An enumerated type for the values that represent geographic regions. This type is used to indicate the shipping region level/type for a shipping region, and is also used to indicate level/type of a tax jurisdiction.

Types that use RegionTypeEnum

RegionShipToRegion

Calls that use RegionTypeEnum

Enumerations

Value
Description
COUNTRY_REGION
This enumeration value indicates the region is a domestic region or special location within a country. A seller will generally specify these regions as places they are not willing to ship to within a country.

For examples of COUNTRY_REGION IDs and values, refer to the regionId and/or regionName field descriptions.

This value is not applicable for a tax jurisdiction.
STATE_OR_PROVINCE
This enumeration value indicates the region is a state or province within a country, such as California or New York in the US, or Ontario or Alberta in Canada.

For examples of STATE_OR_PROVINCE IDs and values, refer to the regionId and/or regionName field descriptions.
COUNTRY
This enumeration value indicates the region is a country. The two-letter code for the country, as defined by the ISO 3166 standard, will be returned in the regionId field, and in the regionName field, the name of the country will be a localized text string.
WORLD_REGION
This enumeration value indicates the region is a continent or a large geographical region.

For examples of WORLD_REGION IDs and values, refer to the regionId and/or regionName field descriptions.

This value is not applicable for a tax jurisdiction.
WORLDWIDE
Indicates the region is the entire world.

This value is only applicable to included shipping regions and not apply to excluded shipping regions. If a seller ships to many global locations, but does have a few regions and/or countries that are exceptions, that seller may specify WORLDWIDE as the included region, and will also specify the exceptions through the excluded regions list.

In the regionName field, "Worldwide" will be localized, and in the regionId field, the value will be WORLDWIDE

This value is not applicable for a tax jurisdiction.

Got thoughts? Click the feedback button – your insights help us improve!