Get Store Information

Returns metadata about the global settings for a store. Some of these values are independently configurable on a per-storefront or per-channel basis. For channel overrides, see Store Settings.

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Information & Settings | modify | `store_v2_information` | | Information & Settings | read-only | `store_v2_information_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Headers

AcceptstringOptionalDefaults to application/json
The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

Response

idstring
The store hash, a unique store identifier.
account_uuidstringformat: "uuid"
The UUID of the account to which the store belongs.
domainstring
Primary domain name.
secure_urlstring

Store’s current HTTPS URL.

control_panel_base_urlstring
The secure hostname of the control panel.
statusstring
The status of the store.
namestring

Store’s name.

first_namestring

Primary contact’s first name (as defined during the store sign-up process).

last_namestring

Primary contact’s last name (as defined during the store sign-up process).

addressstring
Display address.
countrystring

Country where the store is located (as defined during the store sign-up process).

country_codestring

Two-letter ISO 3166-1 country code

infrastructure_regionstring
The infrastructure region where the store is located. Use this to determine where to place supporting infrastructure for minimum latency to the store. Compare against GCP regions on https://cloud.google.com/compute/docs/regions-zones
phonestring
Display phone number.
admin_emailstring

Email address of the store administrator/owner.

order_emailstring
Email address for orders and fulfillment.
favicon_urlstring

The URL of the favicon image associated with the website. This should be a valid URL pointing to an .ico or other supported icon format file.

timezoneobject
languagestring
Default language code.
currencystring
Default currency code.
currency_symbolstring
Default symbol for values in the currency.
decimal_separatorstring
Default decimal separator for values in the currency.
thousands_separatorstring
Default thousands separator for values in the currency.
decimal_placesinteger
Default decimal places for values in the currency.
currency_symbol_locationstring

Default position of the currency symbol (left or right).

weight_unitsstring

Default weight units (metric or imperial).

dimension_unitsstring

Default dimension units (metric or imperial).

dimension_decimal_placesinteger
The number of decimal places.
dimension_decimal_tokenstring
The symbol that separates the whole numbers from the decimal points.
dimension_thousands_tokenstring
The symbol used to denote thousands.
plan_namestring
Name of the BigCommerce plan to which this store is subscribed.
plan_levelstring
Level of the BigCommerce plan to which this store is subscribed.
plan_is_trialboolean
Whether the payment plan associated with the store is still in the trial phase.
industrystring

Industry, or vertical category, in which the business operates. (As selected from drop-down list during the store sign-up process.)

is_price_entered_with_taxboolean
A Boolean value that indicates whether or not prices are entered with tax.
store_idinteger
The numeric ID of the store. This is a different unique ID than the store hash.
default_channel_idintegerDefaults to 1

The ID of the default channel. The ID of the first hosted storefront created on the store is 1.

default_site_idinteger
The BigCommerce ID of the website associated with the default storefront.
active_comparison_moduleslist of any
featuresobject

Describes some aspects of the storeʼs tech stack and configuration settings that affect the features available for the store to use.