{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/StoreInformation",
"title": "Store Information",
"type": "object",
"x-tags": [
"Models"
],
"properties": {
"id": {
"description": "The store hash, a unique store identifier.",
"example": "store_hash",
"type": "string"
},
"account_uuid": {
"description": "The UUID of the account to which the store belongs.",
"type": "string",
"format": "uuid"
},
"domain": {
"description": "Primary domain name.",
"example": "your-store-url.com",
"type": "string"
},
"secure_url": {
"description": "Store\u2019s current HTTPS URL.",
"example": "https://your-store-url.com",
"type": "string"
},
"control_panel_base_url": {
"type": "string",
"example": "https://store-abc123.mybigcommerce.com",
"description": "The secure hostname of the control panel."
},
"status": {
"description": "The status of the store.",
"type": "string",
"example": "live"
},
"name": {
"description": "Store\u2019s name.",
"example": "BigCommerce",
"type": "string"
},
"first_name": {
"description": "Primary contact\u2019s first name (as defined during the store sign-up process).",
"example": "Jane",
"type": "string"
},
"last_name": {
"description": "Primary contact\u2019s last name (as defined during the store sign-up process).",
"example": "Doe",
"type": "string"
},
"address": {
"description": "Display address.",
"example": "BigCommerce",
"type": "string"
},
"country": {
"description": "Country where the store is located (as defined during the store sign-up process).",
"example": "United States",
"type": "string"
},
"phone": {
"description": "Display phone number.",
"type": "string"
},
"admin_email": {
"description": "Email address of the store administrator/owner.",
"example": "[email protected]",
"type": "string"
},
"order_email": {
"description": "Email address for orders and fulfillment.",
"example": "[email protected]",
"type": "string"
},
"timezone": {
"$ref": "#/components/schemas/Timezone"
},
"language": {
"description": "Default language code.",
"example": "en",
"type": "string"
},
"currency": {
"description": "Default currency code.",
"example": "USD",
"type": "string"
},
"currency_symbol": {
"description": "Default symbol for values in the currency.",
"example": "$",
"type": "string"
},
"decimal_separator": {
"description": "Default decimal separator for values in the currency.",
"example": ".",
"type": "string"
},
"thousands_separator": {
"description": "Default thousands separator for values in the currency.",
"example": ",",
"type": "string"
},
"decimal_places": {
"description": "Default decimal places for values in the currency.",
"example": 2,
"type": "integer"
},
"currency_symbol_location": {
"description": "Default position of the currency symbol (left or right).",
"example": "left",
"type": "string"
},
"weight_units": {
"description": "Default weight units (metric or imperial).",
"example": "Ounces",
"type": "string"
},
"dimension_units": {
"description": "Default dimension units (metric or imperial).",
"example": "Inches",
"type": "string"
},
"dimension_decimal_places": {
"description": "The number of decimal places.",
"example": 2,
"type": "integer"
},
"dimension_decimal_token": {
"description": "The symbol that separates the whole numbers from the decimal points.",
"example": ".",
"type": "string"
},
"dimension_thousands_token": {
"description": "The symbol used to denote thousands.",
"type": "string"
},
"plan_name": {
"description": "Name of the BigCommerce plan to which this store is subscribed.",
"example": "Standard",
"type": "string"
},
"plan_level": {
"description": "Level of the BigCommerce plan to which this store is subscribed.",
"example": "Standard",
"type": "string"
},
"plan_is_trial": {
"description": "Whether the payment plan associated with the store is still in the trial phase.",
"type": "boolean",
"example": false
},
"industry": {
"description": "Industry, or vertical category, in which the business operates. (As selected from drop-down list during the store sign-up process.)",
"example": "Technology",
"type": "string"
},
"logo": {
"description": "Either an object describing the logo image, or an empty array.",
"anyOf": [
{
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "https://cdn8.bigcommerce.com/s-{store_hash}/product_images/screen_shot_2018-05-15_at_12.22.26_pm__05547_1529512135.png"
}
}
},
{
"type": "array",
"items": {}
}
]
},
"is_price_entered_with_tax": {
"description": "A Boolean value that indicates whether or not prices are entered with tax.",
"example": false,
"type": "boolean"
},
"store_id": {
"description": "The numeric ID of the store. This is a different unique ID than the store hash.",
"type": "integer"
},
"default_channel_id": {
"description": "The ID of the default channel. The ID of the first hosted storefront created on the store is `1`.",
"default": 1,
"example": 1,
"type": "integer"
},
"default_site_id": {
"description": "The BigCommerce ID of the website associated with the default storefront.",
"type": "integer",
"example": 1000
},
"active_comparison_modules": {
"description": "",
"type": "array",
"items": {}
},
"features": {
"description": "Describes some aspects of the store\u02bcs tech stack and configuration settings that affect the features available for the store to use.",
"type": "object",
"properties": {
"stencil_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "Indicates whether a store is using a Stencil theme."
},
"sitewidehttps_enabled": {
"type": "boolean",
"example": false,
"description": "Indicates whether there is site-wide https."
},
"facebook_catalog_id": {
"type": "string",
"description": "The ID of the Facebook by Meta catalog. If there is none, this endpoint returns an empty string."
},
"checkout_type": {
"type": "string",
"example": "optimized",
"description": "What type of checkout is enabled on the store. Possible values returned are optimized, single (one page), single_customizable (one page for developers), klarna.",
"enum": [
"optimized",
"single",
"single_customizable",
"klarna"
]
},
"wishlists_enabled": {
"type": "boolean",
"example": false
},
"graphql_storefront_api_enabled": {
"type": "boolean",
"default": true,
"example": true,
"description": "Describes whether you can use the [GraphQL Storefront API](/graphql-storefront/reference) on this store."
},
"shopper_consent_tracking_enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the store is tracking the values of the cookie and privacy consent settings that the shopper consented to and configured."
},
"multi_storefront_enabled": {
"type": "boolean",
"example": true,
"default": false,
"description": "Indicates whether the store\u02bcs plan provides the possibility of using more than one storefront or sales channel. Internally, this value indicates whether the store has the MSF feature flag enabled. "
},
"storefront_limits": {
"type": "object",
"properties": {
"active": {
"type": "integer",
"minimum": 1,
"default": 1,
"example": 3,
"description": "Describes the number of storefronts active on the store. If `multi_storefront_enabled` is `false`, this value is `1`."
},
"total_including_inactive": {
"type": "integer",
"minimum": 1,
"default": 1,
"example": 15,
"description": "Describes the total number of storefronts associated with the store, including both active and inactive storefronts. The default varies based on store plan."
}
}
}
}
}
}
}