Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.colossal.sh/llms.txt

Use this file to discover all available pages before exploring further.

Queries

storeDetailsByUid

Fetch store details by UID.
query StoreByUid($uid: UUID!) {
  storeDetailsByUid(uid: $uid) {
    uid
    name
    slug
    domain
    currency
    customDomain
    theme
    themeConfig
    displayMode
    createdAt
    updatedAt
  }
}

storeDetailsByDomain

Fetch store details by custom domain. Use this when resolving a store from a custom domain at runtime.
query StoreByDomain($domain: String!) {
  storeDetailsByDomain(domain: $domain) {
    uid
    name
    slug
    currency
    theme
    themeConfig
  }
}

currentStore

Fetch the store from the current request context.
query CurrentStore {
  currentStore {
    uid
    name
    slug
    currency
  }
}

Types

Store

FieldTypeDescription
uidUUIDStore ID
nameStringStore name
slugStringURL slug
domainStringDefault domain ({slug}.colossal.store)
currencyStringDefault currency code
customDomainString?Custom domain if configured
themeJSON?Theme data
themeConfigJSON?Theme configuration
displayModeString?Display mode
createdAtDateTime
updatedAtDateTime