Saltar al contenido
Consultas

settings

La tienda, sus ajustes de contenido, sus páginas y sus menús en una consulta.

settings devuelve en una consulta la tienda, sus ajustes de contenido, sus páginas publicadas y sus menús activos. Trae lo mismo que GET /v1/settings.

settings: StoreSettingsSnapshotDto!

No recibe argumentos. Pídela una vez por página y reutilízala.

StoreSettingsSnapshotDto

CampoTipoDescripción
schemaVersionInt!Versión del formato de la respuesta.
generatedAtDateTime!Cuándo se armó la respuesta.
storeStorefrontStoreDto!La tienda.
cmsCmsSnapshotDto!Ajustes de contenido, páginas y menús.

StorefrontStoreDto

CampoTipoCampoTipo
idString!tenantIdString!
sellerIdStringtypeString!
isActiveBoolean!nameString!
descriptionString!logoString
iconStringslugString
domainStringdomains[String!]!
timeZoneString!countryCodeString!
currencyString!languageString!
visibilityString!businessSettingsStoreBusinessSettings!
checkoutSettingsStoreCheckoutSettings!
  • type y visibility llegan como texto en camelCase, por ejemplo marketplace y public.
  • businessSettings y checkoutSettings tienen los mismos campos que en GET /v1/settings.

CmsSnapshotDto

CampoTipoDescripción
settingsCmsSiteSettingsDto!Marca, SEO, contacto, analítica y scripts.
pages[CmsPageDetailsDto!]!Páginas publicadas.
menus[CmsMenuDto!]!Menús activos, ordenados por key.

CmsSiteSettingsDto

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

El logo de la tienda está en store.logo. En REST, productBadges solo llega con include=productBadges.

CmsMenuDto

CampoTipoDescripción
keyString!Clave del menú, como main o footer-1.
nameString!Nombre del menú.
itemsAny!Enlaces del menú, como JSON.

items llega completo: no se seleccionan sus campos. Cada enlace trae label, url, reference, order, target, visible y children.

  • Los enlaces a productos y categorías publicados llegan con su URL vigente.
  • Los enlaces a páginas sin publicar no llegan.
  • La API no filtra por visible ni ordena: omite los que tienen visible: false y ordena por order. Ver Menús y contenido.

CmsPageDetailsDto

Cada página trae lo mismo que GET /v1/pages/{slug}: id, name, slug, channel, layout, version, settings, sections, status, hasPublishedVersion, publishedOn, publishedBy, createdOn, updatedOn, createdBy, updatedBy y lastModifiedBy.

  • Cada sección trae id, type, order, settings y blocks. Cada bloque trae id, type, order y settings.
  • settings de la página, de cada sección y de cada bloque es Any.
  • channel y status llegan como texto en camelCase.

Ejemplo

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: mi-tienda" \
  --data-binary '{
    "query": "query Settings { settings { store { name currency language } cms { settings { seo { siteName robotsIndex } } menus { key name items } } } }"
  }'
Respuesta
{
  "data": {
    "settings": {
      "store": { "name": "Mi tienda", "currency": "PEN", "language": "es" },
      "cms": {
        "settings": { "seo": { "siteName": "Mi tienda", "robotsIndex": true } },
        "menus": [
          {
            "key": "main",
            "name": "Menú principal",
            "items": [
              {
                "label": "Polos",
                "url": "/categories/polos",
                "reference": { "type": "category", "id": "7204558912004327982" },
                "order": 1,
                "visible": true,
                "children": []
              }
            ]
          }
        ]
      }
    }
  }
}

Errores

CódigoCausa
STORE_CONTEXT_REQUIREDx-Store-Domain falta o no corresponde a una tienda.
NOT_FOUNDLa tienda no existe o está inactiva.

Equivalente REST

GET /v1/settings devuelve los mismos datos. Para los datos básicos de la tienda, usa store.

Última actualización:

En esta página