Store information

Store Information

Get Store Information endpoint, manage store profile settings.

Get Store Information

GET /store

Request

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

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    The MIME type of the response body.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v2/store' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json
  • id
    string

    The store hash, a unique store identifier.
    Example: store_hash
  • domain
    string

    Primary domain name.
    Example: your-store-url.com
  • secure_url
    string

    Store’s current HTTPS URL.
    Example: https://your-store-url.com
  • control_panel_base_url
    string

    The secure hostname of the control panel.
    Example: https://store-abc123.mybigcommerce.com
  • status
    string

    The status of the store.
    Example: live
  • name
    string

    Store’s name.
    Example: BigCommerce
  • first_name
    string

    Primary contact’s first name (as defined during the store sign-up process).
    Example: Jane
  • last_name
    string

    Primary contact’s last name (as defined during the store sign-up process).
    Example: Doe
  • address
    string

    Display address.
    Example: BigCommerce
  • country
    string

    Country where the store is located (as defined during the store sign-up process).
    Example: United States
  • country_code
    string

    Two-letter ISO 3166-1 country code
    Example: AU
  • infrastructure_region
    string

    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
    Example: us-central1
  • phone
    string

    Display phone number.
  • admin_email
    string

    Email address of the store administrator/owner.
    Example: janedoes@example.com
  • order_email
    string

    Email address for orders and fulfillment.
    Example: orders@example.com
  • favicon_url
    string

    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.
  • timezone
    object

  • language
    string

    Default language code.
    Example: en
  • currency
    string

    Default currency code.
    Example: USD
  • currency_symbol
    string

    Default symbol for values in the currency.
    Example: $
  • decimal_separator
    string

    Default decimal separator for values in the currency.
    Example: .
  • thousands_separator
    string

    Default thousands separator for values in the currency.
    Example: ,
  • decimal_places
    integer

    Default decimal places for values in the currency.
    Example: 2
  • currency_symbol_location
    string

    Default position of the currency symbol (left or right).
    Example: left
  • weight_units
    string

    Default weight units (metric or imperial).
    Example: Ounces
  • dimension_units
    string

    Default dimension units (metric or imperial).
    Example: Inches
  • dimension_decimal_places
    integer

    The number of decimal places.
    Example: 2
  • dimension_decimal_token
    string

    The symbol that separates the whole numbers from the decimal points.
    Example: .
  • dimension_thousands_token
    string

    The symbol used to denote thousands.
  • plan_name
    string

    Name of the BigCommerce plan to which this store is subscribed.
    Example: Standard
  • plan_level
    string

    Level of the BigCommerce plan to which this store is subscribed.
    Example: Standard
  • plan_is_trial
    boolean

    Whether the payment plan associated with the store is still in the trial phase.
  • industry
    string

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

    A Boolean value that indicates whether or not prices are entered with tax.
  • store_id
    integer

    The numeric ID of the store. This is a different unique ID than the store hash.
  • default_channel_id
    integer

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

    Default: 1

  • default_site_id
    integer

    The BigCommerce ID of the website associated with the default storefront.
    Example: 1000
  • active_comparison_modules
    array[]

  • features
    object

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

response

{
"id": "abc123",
"account_uuid": "8d4d492f-17a1-4d95-b396-e1c5720815a5",
"domain": "my-awesome.store",
"secure_url": "https://my-awesome.store",
"control_panel_base_url": "https://store-{store_hash}.mybigcommerce.com",
"status": "live",
"name": "BigCommerce",
"first_name": "Jane",
"last_name": "Doe",
"address": "BigCommerce",
"country": "United States",
"country_code": "US",
"phone": "",
"admin_email": "jane.does@example.com",
"order_email": "info@janedoes.mybigcommerce.com",
"favicon_url": "https://cdn8.bigcommerce.com/r-8816ba2f48b0bcf4bec0c1a954c00e0fc36b/img/bc_favicon.ico",
"timezone": {
"name": "America/Chicago",
"raw_offset": -21600,
"dst_offset": -18000,

Get System Timestamp

GET /time

Request

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

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    The MIME type of the response body.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v2/time' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json
Store Time in Unix format.
  • time
    integer

    Min: 0

response

{
"time": 1529512970
}

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?