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-Token in header
required
Parameters
store_hash in path - string
Accept in header with default of application/xml - string
required
The MIME type of the response body. The default is application/xml, but application/json is available when specified.
example
Response
Body
object | application/json
idstring
The store hash, a unique store identifier.
Example: store_hash
account_uuidstring
The UUID of the account to which the store belongs.
domainstring
Primary domain name.
Example: your-store-url.com
secure_urlstring
Store’s current HTTPS URL.
Example: https://your-store-url.com
control_panel_base_urlstring
The secure hostname of the control panel.
Example: https://store-abc123.mybigcommerce.com
statusstring
The status of the store.
Example: live
namestring
Store’s name.
Example: BigCommerce
first_namestring
Primary contact’s first name (as defined during the store sign-up process).
Example: Jane
last_namestring
Primary contact’s last name (as defined during the store sign-up process).
Example: Doe
addressstring
Display address.
Example: BigCommerce
countrystring
Country where the store is located (as defined during the store sign-up process).
Example: United States
phonestring
Display phone number.
admin_emailstring
Email address of the store administrator/owner.
Example: janedoes@example.com
order_emailstring
Email address for orders and fulfillment.
Example: orders@example.com
timezoneobject
languagestring
Default language code.
Example: en
currencystring
Default currency code.
Example: USD
currency_symbolstring
Default symbol for values in the currency.
Example: $
decimal_separatorstring
Default decimal separator for values in the currency.
Example: .
thousands_separatorstring
Default thousands separator for values in the currency.
Example: ,
decimal_placesinteger
Default decimal places for values in the currency.
Example: 2
currency_symbol_locationstring
Default position of the currency symbol (left or right).
Example: left
weight_unitsstring
Default weight units (metric or imperial).
Example: Ounces
dimension_unitsstring
Default dimension units (metric or imperial).
Example: Inches
dimension_decimal_placesinteger
The number of decimal places.
Example: 2
dimension_decimal_tokenstring
The symbol that separates the whole numbers from the decimal points.
Example: .
dimension_thousands_tokenstring
The symbol used to denote thousands.
plan_namestring
Name of the BigCommerce plan to which this store is subscribed.
Example: Standard
plan_levelstring
Level of the BigCommerce plan to which this store is subscribed.
Example: Standard
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.)
Example: Technology
logo
Either an object describing the logo image, or an empty array.
Returns the system timestamp at the time of the request. The time resource is useful for validating API authentication details and testing client connections.
Authentication
X-Auth-Token in header
required
Show details
Parameters
store_hash in path - string
Accept in header with default of application/xml - string
required
The MIME type of the response body. The default is application/xml, but application/json is available when specified.