storeConfig query

The storeConfig query defines information about a store’s configuration. You can query a non-default store by changing the header in your GraphQL request.

Syntax

storeConfig: StoreConfig

Example usage

Query a store’s configuration

The following call returns all details of a store’s configuration.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  storeConfig {
    id
    code
    website_id
    locale
    base_currency_code
    default_display_currency_code
    timezone
    weight_unit
    base_url
    base_link_url
    base_static_url
    base_media_url
    secure_base_url
    secure_base_link_url
    secure_base_static_url
    secure_base_media_url
    store_name
    send_friend {
      enabled_for_customers
      enabled_for_guests
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "data": {
    "storeConfig": {
      "id": 1,
      "code": "default",
      "website_id": 1,
      "locale": "en_US",
      "base_currency_code": "USD",
      "default_display_currency_code": "USD",
      "timezone": "America/Chicago",
      "weight_unit": "lbs",
      "base_url": "http://magento2.vagrant193/",
      "base_link_url": "http://magento2.vagrant193/",
      "base_static_url": "http://magento2.vagrant193/pub/static/version1536249714/",
      "base_media_url": "http://magento2.vagrant193/pub/media/",
      "secure_base_url": "http://magento2.vagrant193/",
      "secure_base_link_url": "http://magento2.vagrant193/",
      "secure_base_static_url": "http://magento2.vagrant193/pub/static/version1536249714/",
      "secure_base_media_url": "http://magento2.vagrant193/pub/media/",
      "store_name": "My Store",
      "send_friend": {
        "enabled_for_customers": true,
        "enabled_for_guests": false
      }
    }
  }
}

Query a store’s theme

The following query returns information about the store’s default title, keywords, and welcome text.

Request:

1
2
3
4
5
6
7
{
  storeConfig {
    default_title
    default_keywords
    welcome
  }
}

Response:

1
2
3
4
5
6
7
8
9
{
  "data": {
    "storeConfig": {
      "default_title": "Magento Enterprise Edition",
      "default_keywords": "Magento, Varien, E-commerce",
      "welcome": "Default welcome msg!"
    }
  }
}

Query a store’s CMS configuration

The following query returns information about the store’s content pages.

Request:

1
2
3
4
5
6
7
8
9
10
{
  storeConfig {
    front
    cms_home_page
    no_route
    cms_no_route
    cms_no_cookies
    show_cms_breadcrumbs
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
{
  "data": {
    "storeConfig": {
      "front": "cms",
      "cms_home_page": "home",
      "no_route": "cms/noroute/index",
      "cms_no_route": "no-route",
      "cms_no_cookies": "enable-cookies",
      "show_cms_breadcrumbs": 1
    }
  }
}

Query a store’s Catalog configuration

The following query returns information about the store’s catalog configuration.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  storeConfig {
    product_url_suffix
    category_url_suffix
    title_separator
    list_mode
    grid_per_page_values
    list_per_page_values
    grid_per_page
    list_per_page
    catalog_default_sort_by
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "data": {
    "storeConfig": {
      "product_url_suffix": ".html",
      "category_url_suffix": ".html",
      "title_separator": "-",
      "list_mode": "grid-list",
      "grid_per_page_values": "9,15,30",
      "list_per_page_values": "5,10,15,20,25",
      "grid_per_page": 9,
      "list_per_page": 10,
      "catalog_default_sort_by": "position"
    }
  }
}

Query a store’s fixed product tax configuration

The following query returns enumeration values that indicate the store’s fixed product tax configuration.

Request:

1
2
3
4
5
6
7
{
  storeConfig {
    category_fixed_product_tax_display_setting
    product_fixed_product_tax_display_setting
    sales_fixed_product_tax_display_setting
  }
}

Response:

1
2
3
4
5
6
7
8
9
{
  "data": {
    "storeConfig": {
      "category_fixed_product_tax_display_setting": "EXCLUDE_FPT_WITHOUT_DETAILS",
      "product_fixed_product_tax_display_setting": "EXCLUDE_FPT_AND_INCLUDE_WITH_DETAILS",
      "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS"
    }
  }
}

Output attributes

Supported storeConfig attributes

Use the storeConfig attributes to retrieve information about the store’s configuration; such as, locale, currency codes, and secure and unsecure URLs.

SendFriendConfiguration attributes

Supported theme attributes

Use the theme attributes to retrieve information about the store’s thematic elements; such as, footer and header information, copyright text, and logo information. These attributes are defined in the ThemeGraphQl module.

Supported CMS attributes

Use the cms attributes to retrieve information about the store’s default pages. These attributes are defined in the CmsGraphQl module.

Supported Catalog attributes

Use the catalog attributes to retrieve information about the store’s catalog. These attributes are defined in the CatalogGraphQl module.

Supported WEEE (fixed product tax) attributes

The Stores > Settings > Configuration > Sales > Tax > Fixed Product Taxes panel contains several fields that determine how to display fixed product tax (FPT) values and descriptions. Use the following attributes to determine the values of the Fixed Product Taxes fields. These attributes are defined in the WeeeGraphQl module.

The FixedProductTaxDisplaySettings data type is an enumeration that describes whether displayed prices include fixed product taxes and whether Magento separately displays detailed information about the FPTs.

Extend configuration data

You can add your own configuration to the storeConfig query within your own module.

To do this, configure the constructor argument extendedConfigData in the argument node in your area-specific etc/graphql/di.xml file.

The following example adds an array-item to the extendedConfigData array within the construct of the StoreConfigDataProvider.

1
2
3
4
5
6
7
8
9
10
<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
  <type name="Magento\StoreGraphQl\Model\Resolver\Store\StoreConfigDataProvider">
    <arguments xsi:type="array">
      <argument name="extendedConfigData">
        <item name="section_group_field" xsi:type="string">section/group/field</item>
      </argument>
    </arguments>
  </type>
</config>

You must also extend the type storeConfig within in the etc/schema.graphqls file, as shown below:

1
2
3
type StoreConfig {
    section_group_field : String  @doc(description: "Extended Config Data - section/group/field")
}