Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

GraphQL: StoreConfig attribute updates #8369

Merged
keharper merged 5 commits into from
Dec 22, 2020
Merged

GraphQL: StoreConfig attribute updates #8369

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
977d7ac
GraphQL: StoreConfig attribute updates
keharper Dec 10, 2020
c58dd59
Update store-config.md
keharper Dec 16, 2020
7a1b2f2
Merge branch '2.4.2-develop' into kh_storeconfig-updates
keharper Dec 21, 2020
0d3343d
Merge branch '2.4.2-develop' into kh_storeconfig-updates
keharper Dec 22, 2020
d2f30b8
Merge branch '2.4.2-develop' into kh_storeconfig-updates
keharper Dec 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions src/_includes/graphql/store-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Attribute | Data Type | Description | Default or example value
`cms_home_page` | String | Returns the name of the CMS page that identifies the home page for the store | `home`
`cms_no_cookies` | String | Identifies a specific CMS page that appears when cookies are not enabled for the browser | `enable-cookies`
`cms_no_route` | String | Identifies a specific CMS page that you want to appear when a 404 “Page Not Found” error occurs | `no-route`
`code` | String | A unique identifier for the store | `default`
`code` | String | Deprecated. Use `store_code` instead. A unique identifier for the store | `default`
`copyright` | String | The copyright statement that appears at the bottom of each page | Copyright © 2013-present Magento, Inc. All rights reserved.
`default_description` | String | The description that provides a summary of your site for search engine listings and should not be more than 160 characters in length | null
`default_display_currency_code` | String | The code representing the currency displayed on the store | `USD`
Expand All @@ -39,7 +39,9 @@ Attribute | Data Type | Description | Default or example value
`head_includes` | String | Contains scripts that must be included in the HTML before the closing `<head>` tag | `<link rel=\"stylesheet\" type=\"text/css\" media=\"all\" href=\"{{MEDIA_URL}}styles.css\" />`
`head_shortcut_icon` | String | Uploads the small graphic image that appears in the address bar and tab of the browser | null
`header_logo_src` | String | The path to the logo that appears in the header | null
`id` | Int | The ID number assigned to the store | `1`
`id` | Int | Deprecated. Use `store_code` instead. The ID number assigned to the store | `1`
`is_default_store` | Boolean | Indicates whether the store view has been designated as the default within the store group | true or false
`is_default_store_group` | Boolean | Indicates whether the store group has been designated as the default within the website | true or false
`list_mode` | String | The format of the search results list | `grid-list`
`list_per_page` | Int | The default number of products per page in List View | `10`
`list_per_page_values` | String | A list of numbers that define how many products can be displayed in List View | `5,10,15,20,25`
Expand Down Expand Up @@ -80,12 +82,18 @@ Attribute | Data Type | Description | Default or example value
`secure_base_url` | String | The store's fully-qualified secure base URL | `https://magentohost.example.com/`
`send_friend` | [SendFriendConfiguration](#SendFriendConfiguration) | Email to a Friend configuration | Not applicable
`show_cms_breadcrumbs` | Int | Determines if a breadcrumb trail appears on all CMS pages in the catalog. Options: `0` (No) or `1` (Yes) | 1
`store_name` | String | The store's name | `My Store`
`store_code` | ID | The unique ID of the store view. In the Admin, this is called the Store View Code. When making a GraphQL call, assign this value to the `Store` header to provide the scope | `default`
`store_group_code` | ID | The unique ID assigned to the store group. In the Admin, this is called the Store Name | `main_website_store`
`store_group_name` | String | The label assigned to the store group | Main Website Store
`store_name` | String | The label assigned to the store view | Default Store View
`store_sort_order` | Int | The store view sort order | 10
`timezone` | String | The store's time zone | `America/Chicago`
`title_prefix` | String | A prefix that appears before the title to create a two- or three-part title | null
`title_separator` | String | Identifies the character that separates the category name and subcategory in the browser title bar | `-`
`title_suffix` | String | A suffix that appears after the title to create a two-or three part title | null
`website_id` | Integer | The ID number assigned to the parent website | `1`
`website_code` | ID | The unique ID for the website | `base`
`website_id` | Integer | Deprecated. The field should not be used on the storefront. The ID number assigned to the parent website | `1`
`website_name` | ID | The label assigned to the website | Main Website
Copy link
Contributor

@rogyar rogyar Dec 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @keharper. I just wanted to double-check that the website_name has the ID type. From a technical standpoint, it's supposed to be String.

Thanks.

Copy link
Contributor Author

@keharper keharper Dec 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rogyar Ugh. That's how it's defined in the schema file. I've notified Cris. Hopefully, we can change this before 2.4.2 ships

Copy link
Contributor Author

@keharper keharper Dec 16, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good news. We're fixing it.

`weight_unit` | String | The weight unit for products | `lbs`, `kgs`, or similar
`welcome` | String | Text that appears in the header of the page and includes the name of customers who are logged in | Default welcome msg!

Expand Down
31 changes: 17 additions & 14 deletions src/guides/v2.4/graphql/queries/available-stores.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ The following query returns information about the store's basic catalog configur
```graphql
query {
availableStores(useCurrentGroup: true) {
id
code
website_id
store_code
store_name
is_default_store
store_group_code
is_default_store_group
locale
base_currency_code
default_display_currency_code
Expand All @@ -37,7 +39,6 @@ query {
secure_base_link_url
secure_base_static_url
secure_base_media_url
store_name
}
}
```
Expand All @@ -49,9 +50,11 @@ query {
"data": {
"availableStores": [
{
"id": 1,
"code": "default",
"website_id": 1,
"store_code": "default",
"store_name": "Default Store View",
"is_default_store": true,
"store_group_code": "main_website_store",
"is_default_store_group": true,
"locale": "en_US",
"base_currency_code": "USD",
"default_display_currency_code": "USD",
Expand All @@ -64,13 +67,14 @@ query {
"secure_base_url": "http://example.com/",
"secure_base_link_url": "http://example.com/",
"secure_base_static_url": "http://example.com/pub/static/version1606976517/",
"secure_base_media_url": "http://example.com/pub/media/",
"store_name": "Default Store View"
"secure_base_media_url": "http://example.com/pub/media/"
},
{
"id": 2,
"code": "de",
"website_id": 1,
"store_code": "de",
"store_name": "Europe Store View",
"is_default_store": false,
"store_group_code": "main_website_store",
"is_default_store_group": true,
"locale": "de_DE",
"base_currency_code": "USD",
"default_display_currency_code": "EUR",
Expand All @@ -83,8 +87,7 @@ query {
"secure_base_url": "http://example.com/",
"secure_base_link_url": "http://example.com/",
"secure_base_static_url": "http://example.com/pub/static/version1606976517/",
"secure_base_media_url": "http://example.com/pub/media/",
"store_name": "Europe Store View"
"secure_base_media_url": "http://example.com/pub/media/"
}
]
}
Expand Down
32 changes: 18 additions & 14 deletions src/guides/v2.4/graphql/queries/store-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ The `storeConfig` query can return `base` and `extended` store configuration set
```graphql
{
storeConfig {
id
code
website_id
store_code
store_name
is_default_store
store_group_code
is_default_store_group
locale
base_currency_code
default_display_currency_code
Expand All @@ -46,22 +48,24 @@ The `storeConfig` query can return `base` and `extended` store configuration set
{
"data": {
"storeConfig": {
"id": 1,
"code": "default",
"website_id": 1,
"store_code": "default",
"store_name": "Default Store View",
"is_default_store": true,
"store_group_code": "main_website_store",
"is_default_store_group": true,
"locale": "en_US",
"base_currency_code": "USD",
"default_display_currency_code": "USD",
"timezone": "America/Chicago",
"weight_unit": "lbs",
"base_url": "http://magentohost.example.com/",
"base_link_url": "http://magentohost.example.com/",
"base_static_url": "http://magentohost.example.com/pub/static/version1536249714/",
"base_media_url": "http://magentohost.example.com/pub/media/",
"secure_base_url": "http://magentohost.example.com/",
"secure_base_link_url": "http://magentohost.example.com/",
"secure_base_static_url": "http://magentohost.example.com/pub/static/version1536249714/",
"secure_base_media_url": "http://magentohost.example.com/pub/media/"
"base_url": "http://example.com/",
"base_link_url": "http://example.com/",
"base_static_url": "http://example.com/pub/static/version1606976517/",
"base_media_url": "http://example.com/pub/media/",
"secure_base_url": "http://example.com/",
"secure_base_link_url": "http://example.com/",
"secure_base_static_url": "http://example.com/pub/static/version1606976517/",
"secure_base_media_url": "http://example.com/pub/media/"
}
}
}
Expand Down