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

Code so that your app gracefully handles any future changes to this list.

Type that uses RegionTypeEnum

Region

Calls that use RegionTypeEnum

POST
/checkout_session/{checkoutSessionId}/apply_coupon
GET
/checkout_session/{checkoutSessionId}
POST
/checkout_session/initiate
POST
/checkout_session/{checkoutSessionId}/remove_coupon
POST
/checkout_session/{checkoutSessionId}/update_add_on_services_status
POST
/checkout_session/{checkoutSessionId}/update_payment_info
POST
/checkout_session/{checkoutSessionId}/update_quantity
POST
/checkout_session/{checkoutSessionId}/update_shipping_address
POST
/checkout_session/{checkoutSessionId}/update_shipping_option
GET
/purchase_order/{purchaseOrderId}

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.

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.
COUNTRY
This enumeration value indicates the region is a country. The two-letter code for the country, as defined in 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.

This value is not applicable for a tax jurisdiction.
WORLDWIDE
Indicates the region is the entire world. This value is only applicable for included shiping regions, and not 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 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.