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

product

Fetch a single published product by UID.
query Product($uid: UUID!) {
  product(uid: $uid) {
    uid
    name
    tagline
    description
    contentBlocks
    variants {
      uid
      name
      inventoryCount
      prices {
        uid
        currency
        isDefault
        recurringInterval
        price {
          ... on LinearProductPriceConfig {
            priceModel
            unitPrice
          }
          ... on VolumeProductPriceConfig {
            priceModel
            tiers {
              firstUnit
              lastUnit
              unitPrice
            }
          }
        }
      }
      media {
        uid
        type
        url
        alt
      }
      deliverables {
        uid
        name
        type
        description
      }
    }
    defaultVariant {
      uid
      name
    }
    createdAt
    updatedAt
  }
}

productsByStoreUid

List all published products in a store.
query StoreProducts($storeUid: UUID!) {
  productsByStoreUid(storeUid: $storeUid) {
    uid
    name
    tagline
    description
    defaultVariant {
      uid
      prices {
        currency
        isDefault
        price {
          ... on LinearProductPriceConfig {
            unitPrice
          }
        }
      }
      media {
        uid
        url
        alt
      }
    }
  }
}

Types

Product

FieldTypeDescription
uidUUIDProduct ID
nameStringProduct name
taglineString?Short description
descriptionString?Full description
contentBlocks[JSON]?Structured content blocks
variants[ProductVariant]Product variants
defaultVariantProductVariantDefault variant
createdAtDateTime
updatedAtDateTime

ProductVariant

FieldTypeDescription
uidUUIDVariant ID
nameString?Variant name
inventoryCountInt?Current stock level
prices[ProductPrice]Variant prices
media[Media]Variant images and videos
deliverables[ProductDeliverable]Digital deliverables

ProductPrice

FieldTypeDescription
uidUUIDPrice ID
currencyStringISO currency code
isDefaultBooleanWhether this is the default price
recurringIntervalMONTH | YEAR | nullBilling interval for subscriptions
trialDurationString?Trial period (ONE_DAY, THREE_DAYS, ONE_WEEK, TWO_WEEKS, ONE_MONTH)
priceLinearProductPriceConfig | VolumeProductPriceConfigPricing model

LinearProductPriceConfig

FieldTypeDescription
priceModelLINEAR
unitPriceFloatPrice per unit in minor currency units (cents)

VolumeProductPriceConfig

FieldTypeDescription
priceModelVOLUME
tiers[VolumeTierPrice]Tiered pricing brackets

Media

FieldTypeDescription
uidUUIDMedia ID
typeIMAGE | VIDEO | EXTERNAL_VIDEOMedia type
urlString?CDN URL
altString?Alt text

ProductDeliverable

FieldTypeDescription
uidUUIDDeliverable ID
nameStringName
typeDOWNLOAD | CONTENT_UNLOCK | EXTERNAL_LINKDeliverable type
descriptionString?Description