← API reference
CANONICAL TYPE REFERENCE

SubstrateState

A substrate/media definition for printing

Unique substrate identifier

External system identifier for integration

nameString!

Display name of the substrate

codeString

Internal catalog code

Cached substrate designation used by an external system

Supplier's own product code

Reference to the supplier record

Paper mill or manufacturer name

brandString

Commercial brand or product line name

Physical form: roll or sheet stock

JDF media type classification

ISO 12647 paper substrate classification (PS1–PS8)

Sheet or roll width — pick the unit field on Length (mm, inches, …) for the desired representation.

Sheet height or roll length. May be omitted when roll length is unknown.

Paper basis weight; ask for gsm on the returned PaperWeight for the canonical g/m² value or value(unit:) for a US lb figure at a given basis.

Caliper / thickness — supports µm provenance for film and other thin stocks.

Surface coating per side: 1 element (both sides) or 2 elements [front, back]

Paper grain direction

Which sides of the media can be printed

Transparency level of the media

Printing technology compatibility

Paper stock type classification

Surface texture or finish

Base color of the media

Factory-applied coatings already on the media

shrinkIndex[Float!]

Shrink compensation factors [x, y] as percentages

ISO brightness percentage (0–100)

CIE whiteness index

Paper grade classification number

Corrugated board flute type per JDF specification

Percentage of recycled content (0–100)

Whether this substrate is supplied by the buyer

Moisture content percentage (0–100)

Supplier lead time in calendar days

isActiveBoolean!

Whether this substrate is available for use

Minimum stock level before reorder is triggered

Unit of measure for the reorder threshold

Cost per unit in the specified currency

Currency code for unitCost

notesString

Free-text notes

createdAtString!

ISO 8601 creation timestamp

updatedAtString!

ISO 8601 last-update timestamp

View exact SDL
"""A substrate/media definition for printing"""
type SubstrateState @iac_resource(name: "substrate") @iac_ops(create: "createSubstrate", read: "getSubstrate", update: "updateSubstrate", delete: "deleteSubstrate") {
  """Unique substrate identifier"""
  id: SubstrateID! @iac_identity(assignedBy: SERVER) @iac_computed
  """External system identifier for integration"""
  externalId: String
  """Display name of the substrate"""
  name: String!
  """Internal catalog code"""
  code: String
  """Cached substrate designation used by an external system"""
  externalCode: String
  """Supplier's own product code"""
  supplierCode: String
  """Reference to the supplier record"""
  supplierId: SupplierID @iac_ref(resource: "supplier")
  """Paper mill or manufacturer name"""
  manufacturer: String
  """Commercial brand or product line name"""
  brand: String
  """Physical form: roll or sheet stock"""
  kind: MediaKind
  """JDF media type classification"""
  mediaType: MediaType
  """ISO 12647 paper substrate classification (PS1–PS8)"""
  isoPaperSubstrate: ISOPaperSubstrate
  """
  Sheet or roll width — pick the unit field on `Length` (mm, inches, …) for the desired representation.
  """
  width: Length
  """
  Sheet height or roll length. May be omitted when roll length is unknown.
  """
  height: Length
  """
  Paper basis weight; ask for `gsm` on the returned `PaperWeight` for the canonical g/m² value or `value(unit:)` for a US `lb` figure at a given basis.
  """
  weight: PaperWeight
  """
  Caliper / thickness — supports µm provenance for film and other thin stocks.
  """
  thickness: Length
  """
  Surface coating per side: 1 element (both sides) or 2 elements [front, back]
  """
  coatings: [MediaCoating!]
  """Paper grain direction"""
  grainDirection: MediaGrainDirection
  """Which sides of the media can be printed"""
  imageableSide: MediaImageableSide
  """Transparency level of the media"""
  opacity: MediaOpacity
  """Printing technology compatibility"""
  printingTechnology: MediaPrintingTechnology
  """Paper stock type classification"""
  stockType: MediaStockType
  """Surface texture or finish"""
  texture: MediaTexture
  """Base color of the media"""
  color: MediaColor
  """Factory-applied coatings already on the media"""
  preAppliedCoatings: [MediaCoating!]
  """Shrink compensation factors [x, y] as percentages"""
  shrinkIndex: [Float!]
  """ISO brightness percentage (0–100)"""
  brightness: Float
  """CIE whiteness index"""
  cieWhiteness: Float
  """Paper grade classification number"""
  grade: Int
  """Corrugated board flute type per JDF specification"""
  fluteType: MediaFluteType
  """Percentage of recycled content (0–100)"""
  recycledPercentage: Float
  """Whether this substrate is supplied by the buyer"""
  buyerSupplied: Boolean!
  """Moisture content percentage (0–100)"""
  moisture: Float
  """Supplier lead time in calendar days"""
  supplierLeadTimeDays: Int
  """Whether this substrate is available for use"""
  isActive: Boolean!
  """Minimum stock level before reorder is triggered"""
  reorderThreshold: Float
  """Unit of measure for the reorder threshold"""
  reorderUnit: MeasurementUnit
  """Cost per unit in the specified currency"""
  unitCost: Float
  """Currency code for unitCost"""
  costCurrency: CurrencyISO
  """Free-text notes"""
  notes: String
  """ISO 8601 creation timestamp"""
  createdAt: String! @iac_computed
  """ISO 8601 last-update timestamp"""
  updatedAt: String! @iac_computed
}

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