settings
The store, its content settings, its pages and its menus in one query.
settings returns the store, its content settings, its published pages and its active menus in one query. It holds the same data as GET /.
settings: StoreSettingsSnapshotDto!It takes no arguments. Request it once per page and reuse it.
StoreSettingsSnapshotDto
| Field | Type | Description |
|---|---|---|
schemaVersion | Int! | Version of the response format. |
generatedAt | DateTime! | When the response was built. |
store | StorefrontStoreDto! | The store. |
cms | CmsSnapshotDto! | Content settings, pages and menus. |
StorefrontStoreDto
| Field | Type | Field | Type |
|---|---|---|---|
id | String! | tenantId | String! |
sellerId | String | type | String! |
isActive | Boolean! | name | String! |
description | String! | logo | String |
icon | String | slug | String |
domain | String | domains | [String!]! |
timeZone | String! | countryCode | String! |
currency | String! | language | String! |
visibility | String! | businessSettings | StoreBusinessSettings! |
checkoutSettings | StoreCheckoutSettings! |
typeandvisibilityare camelCase strings, for examplemarketplaceandpublic.businessSettingsandcheckoutSettingshave the same fields as inGET /.v1/ settings
CmsSnapshotDto
| Field | Type | Description |
|---|---|---|
settings | CmsSiteSettingsDto! | Branding, SEO, contact, analytics and scripts. |
pages | [CmsPageDetailsDto!]! | Published pages. |
menus | [CmsMenuDto!]! | Active menus, sorted by key. |
CmsSiteSettingsDto
| Field | Type | Fields |
|---|---|---|
themeKey | String! | — |
branding | CmsBrandingSettingsDto! | logoDarkUrl, faviconUrl, socialImageUrl |
seo | CmsSeoSettingsDto! | siteName, metaTitle, metaDescription, titleTemplate, robotsIndex |
contact | CmsContactSettingsDto! | whatsapp and socialLinks, with instagram, facebook, tiktok, youtube and x |
tracking | CmsTrackingSettingsDto! | googleAnalyticsMeasurementId, metaPixelId, googleTagManagerContainerId |
customScripts | CmsCustomScriptsDto! | enabled, head, bodyEnd |
updatedOn | DateTime | — |
productBadges | CmsProductBadgesDto | showRatings, newDays, lowStock |
The store logo is in store.logo. In REST, productBadges only comes with include=productBadges.
CmsMenuDto
| Field | Type | Description |
|---|---|---|
key | String! | Menu key, such as main or footer-1. |
name | String! | Menu name. |
items | Any! | The menu links, as JSON. |
items comes whole: you don't select its fields. Each link has label, url, reference, order, target, visible and children.
- Links to published products and categories come with their current URL.
- Links to unpublished pages are left out.
- The API doesn't filter by
visibleor sort: skip the ones withvisible: falseand sort byorder. See Menus and content.
CmsPageDetailsDto
Each page has the same data as GET /: id, name, slug, channel, layout, version, settings, sections, status, hasPublishedVersion, publishedOn, publishedBy, createdOn, updatedOn, createdBy, updatedBy and lastModifiedBy.
- Each section has
id,type,order,settingsandblocks. Each block hasid,type,orderandsettings. - The
settingsof the page, of each section and of each block areAny. channelandstatusare camelCase strings.
Example
query Settings {
settings {
store { name currency language }
cms {
settings { seo { siteName robotsIndex } }
menus { key name items }
}
}
}curl --request POST "https://storefront.ecomiq.pe/graphql" \
--header "Content-Type: application/json" \
--header "x-Store-Domain: my-store" \
--data-binary '{
"query": "query Settings { settings { store { name currency language } cms { settings { seo { siteName robotsIndex } } menus { key name items } } } }"
}'{
"data": {
"settings": {
"store": { "name": "My store", "currency": "PEN", "language": "en" },
"cms": {
"settings": { "seo": { "siteName": "My store", "robotsIndex": true } },
"menus": [
{
"key": "main",
"name": "Main menu",
"items": [
{
"label": "T-shirts",
"url": "/categories/t-shirts",
"reference": { "type": "category", "id": "7204558912004327982" },
"order": 1,
"visible": true,
"children": []
}
]
}
]
}
}
}
}Errors
| Code | Cause |
|---|---|
STORE_CONTEXT_REQUIRED | x-Store-Domain is missing or doesn't match a store. |
NOT_FOUND | The store doesn't exist or is inactive. |
REST equivalent
GET / returns the same data. For the store basics only, use store.
Last updated: