Docs
Management API
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
    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
  • id
    string

    The store hash, a unique store identifier.

    Example: store_hash

  • account_uuid
    string

    The UUID of the account to which the store belongs.

  • 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

  • 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

  • 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

  • logo

    Either an object describing the logo image, or an empty array.

    Any of:
    • url
      string

      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_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

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
    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

Store Time in Unix format.

  • time
    integer

response

Did you find what you were looking for?