Store Information
Get Store Information endpoint, manage store profile settings.
Get Store Information
GET https://api.bigcommerce.com/stores/{store_hash}/v2/storeRequest
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 headerrequired
Parameters
- store_hash in path - string
example
Response
Body
idstring
The store hash, a unique store identifier.
Example: store_hashaccount_uuidstring
The UUID of the account to which the store belongs.
domainstring
Primary domain name.
Example: your-store-url.comsecure_urlstring
Store’s current HTTPS URL.
Example: https://your-store-url.comcontrol_panel_base_urlstring
The secure hostname of the control panel.
Example: https://store-abc123.mybigcommerce.comstatusstring
The status of the store.
Example: livenamestring
Store’s name.
Example: BigCommercefirst_namestring
Primary contact’s first name (as defined during the store sign-up process).
Example: Janelast_namestring
Primary contact’s last name (as defined during the store sign-up process).
Example: Doeaddressstring
Display address.
Example: BigCommercecountrystring
Country where the store is located (as defined during the store sign-up process).
Example: United Statesphonestring
Display phone number.
admin_emailstring
Email address of the store administrator/owner.
Example: janedoes@example.comorder_emailstring
Email address for orders and fulfillment.
Example: orders@example.comtimezoneobject
languagestring
Default language code.
Example: encurrencystring
Default currency code.
Example: USDcurrency_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: 2currency_symbol_locationstring
Default position of the currency symbol (left or right).
Example: leftweight_unitsstring
Default weight units (metric or imperial).
Example: Ouncesdimension_unitsstring
Default dimension units (metric or imperial).
Example: Inchesdimension_decimal_placesinteger
The number of decimal places.
Example: 2dimension_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: Standardplan_levelstring
Level of the BigCommerce plan to which this store is subscribed.
Example: Standardplan_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: Technologylogo
Either an object describing the logo image, or an empty array.
Any of:urlstring
Example: https://cdn8.bigcommerce.com/s-{store_hash}/product_images/screen_shot_2018-05-15_at_12.22.26_pm__05547_1529512135.png
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_idinteger
The ID of the default channel. The ID of the first hosted storefront created on the store is
1.Example: 1Default: 1
default_site_idinteger
The BigCommerce ID of the website associated with the default storefront.
Example: 1000active_comparison_modulesarray[]
featuresobject
Describes some aspects of the storeʼs tech stack and configuration settings that affect the features available for the store to use.
response
Get System Timestamp
GET https://api.bigcommerce.com/stores/{store_hash}/v2/timeRequest
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 headerrequired
Parameters
- store_hash in path - string
example
Response
Body
Store Time in Unix format.
timeinteger