Skip to navigation
RESTAdminManagementGeographyStates

Get Countryʼs State

Returns a State. A state or province, identifiable by an ISO 3166 subdivision code.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Information & Settingsmodifystore_v2_information
Information & Settingsread-onlystore_v2_information_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

country_idintegerRequired
Id of the country
idintegerRequired
Id of the states
store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body that the client accepts. Typically application/json.

Response

The requested state.
idintegerOptional

Numeric ID of the state/province.

statestringOptional

Name of the state/province.

state_abbreviationstringOptional

Abbreviation for the state/province.

country_idintegerOptional

Numeric ID of the state’s/province’s associated country.