← API reference
CANONICAL TYPE REFERENCE

TemplateComponentSpec

Component specification within a product template

localIdString!

Stable local identifier referenced by operations

Component kind

nameString!

Default component name

Default quantity when instantiated

Minimum allowed quantity (storefront hint)

Maximum allowed quantity (storefront hint)

Quantity step increment (storefront hint)

Expected page count for this component

Acceptable media families; instantiation picks one by localId

Print sides

Spread type

Finished (trimmed) dimensions

Default colour specification

Default piece geometry

Default finishing specification

View exact SDL
"""Component specification within a product template"""
type TemplateComponentSpec {
  """Stable local identifier referenced by operations"""
  localId: String!
  """Component kind"""
  kind: ComponentKind!
  """Default component name"""
  name: String!
  """Default quantity when instantiated"""
  defaultQuantity: Int!
  """Minimum allowed quantity (storefront hint)"""
  minQuantity: Int
  """Maximum allowed quantity (storefront hint)"""
  maxQuantity: Int
  """Quantity step increment (storefront hint)"""
  quantityStep: Int
  """Expected page count for this component"""
  totalPages: Int
  """Acceptable media families; instantiation picks one by localId"""
  mediaSelectors: [MediaSelector!]
  """Print sides"""
  sides: PrintSides
  """Spread type"""
  spreadType: SpreadType
  """Finished (trimmed) dimensions"""
  finishedDimensions: LayoutDimension
  """Default colour specification"""
  colors: ComponentColorInfo
  """Default piece geometry"""
  layout: ComponentLayout
  """Default finishing specification"""
  finishing: FinishingSpec
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.