Thanks for being patient while we implement your feedback to improve the developer experience.

Store Information

Get Store Information endpoint, manage store profile settings.

Get Store Information

GET /store

Request

Returns metadata about a store.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required
  • Content-Type in header with default of application/json - string - required

example

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

Response

Body

application/json

response

{
  "id": "abc123",
  "domain": "my-awesome.store",
  "secure_url": "https://my-awesome.stor",
  "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,
    "dst_correction": true,
    "date_format": {
      "display": "M jS Y",
      "export": "M jS Y",
      "extended_display": "M jS Y @ g:i A"
    }
  },
  "language": "en",
  "currency": "USD",
  "currency_symbol": "$",
  "decimal_separator": ".",
  "thousands_separator": ",",
  "decimal_places": 2,
  "currency_symbol_location": "left",
  "weight_units": "Ounces",
  "dimension_units": "Inches",
  "dimension_decimal_places": 2,
  "dimension_decimal_token": ".",
  "dimension_thousands_token": ",",
  "plan_name": "Standard",
  "plan_level": "Standard",
  "industry": "",
  "logo": {
    "url": "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": false,
  "active_comparison_modules": [],
  "features": {
    "stencil_enabled": true,
    "sitewidehttps_enabled": false,
    "facebook_catalog_id": "",
    "checkout_type": "optimized"
  }
}

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/json - string - required
  • Content-Type in header with default of application/json - string - required

example

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

Response

Body

object | application/json

Store Time in Unix format.

  • time    integer

response

{
  "time": 1529512970
}