Skip to content
Queries

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 /v1/settings.

settings: StoreSettingsSnapshotDto!

It takes no arguments. Request it once per page and reuse it.

StoreSettingsSnapshotDto

FieldTypeDescription
schemaVersionInt!Version of the response format.
generatedAtDateTime!When the response was built.
storeStorefrontStoreDto!The store.
cmsCmsSnapshotDto!Content settings, pages and menus.

StorefrontStoreDto

FieldTypeFieldType
idString!tenantIdString!
sellerIdStringtypeString!
isActiveBoolean!nameString!
descriptionString!logoString
iconStringslugString
domainStringdomains[String!]!
timeZoneString!countryCodeString!
currencyString!languageString!
visibilityString!businessSettingsStoreBusinessSettings!
checkoutSettingsStoreCheckoutSettings!
  • type and visibility are camelCase strings, for example marketplace and public.
  • businessSettings and checkoutSettings have the same fields as in GET /v1/settings.

CmsSnapshotDto

FieldTypeDescription
settingsCmsSiteSettingsDto!Branding, SEO, contact, analytics and scripts.
pages[CmsPageDetailsDto!]!Published pages.
menus[CmsMenuDto!]!Active menus, sorted by key.

CmsSiteSettingsDto

FieldTypeFields
themeKeyString!—
brandingCmsBrandingSettingsDto!logoDarkUrl, faviconUrl, socialImageUrl
seoCmsSeoSettingsDto!siteName, metaTitle, metaDescription, titleTemplate, robotsIndex
contactCmsContactSettingsDto!whatsapp and socialLinks, with instagram, facebook, tiktok, youtube and x
trackingCmsTrackingSettingsDto!googleAnalyticsMeasurementId, metaPixelId, googleTagManagerContainerId
customScriptsCmsCustomScriptsDto!enabled, head, bodyEnd
updatedOnDateTime—
productBadgesCmsProductBadgesDtoshowRatings, newDays, lowStock

The store logo is in store.logo. In REST, productBadges only comes with include=productBadges.

CmsMenuDto

FieldTypeDescription
keyString!Menu key, such as main or footer-1.
nameString!Menu name.
itemsAny!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 visible or sort: skip the ones with visible: false and sort by order. See Menus and content.

CmsPageDetailsDto

Each page has the same data as GET /v1/pages/{slug}: id, name, slug, channel, layout, version, settings, sections, status, hasPublishedVersion, publishedOn, publishedBy, createdOn, updatedOn, createdBy, updatedBy and lastModifiedBy.

  • Each section has id, type, order, settings and blocks. Each block has id, type, order and settings.
  • The settings of the page, of each section and of each block are Any.
  • channel and status are camelCase strings.

Example

Settings.graphql
query Settings {
  settings {
    store { name currency language }
    cms {
      settings { seo { siteName robotsIndex } }
      menus { key name items }
    }
  }
}
Terminal
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 } } } }"
  }'
Response
{
  "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

CodeCause
STORE_CONTEXT_REQUIREDx-Store-Domain is missing or doesn't match a store.
NOT_FOUNDThe store doesn't exist or is inactive.

REST equivalent

GET /v1/settings returns the same data. For the store basics only, use store.

Last updated:

On this page