Skip to content

SubstrateState ​

Type: Object

A substrate/media definition for printing

Fields ​

NameTypeArgsDescriptionDeprecated
brandStringCommercial brand or product line name
brightnessFloatISO brightness percentage (0–100)
buyerSuppliedBoolean!Whether this substrate is supplied by the buyer
cieWhitenessFloatCIE whiteness index
coatings[MediaCoating!]Surface coating per side: 1 element (both sides) or 2 elements [front, back]
codeStringInternal catalog code
colorMediaColorBase color of the media
costCurrencyCurrencyISOCurrency code for unitCost
createdAtString!ISO 8601 creation timestamp
externalIdStringExternal system identifier for integration
fluteTypeMediaFluteTypeCorrugated board flute type per JDF specification
gradeIntPaper grade classification number
grainDirectionMediaGrainDirectionPaper grain direction
heightLengthSheet height — null for roll stock.
idSubstrateID!Unique substrate identifier
imageableSideMediaImageableSideWhich sides of the media can be printed
isActiveBoolean!Whether this substrate is available for use
isoPaperSubstrateISOPaperSubstrateISO 12647 paper substrate classification (PS1–PS8)
kindMediaKindPhysical form: roll or sheet stock
manufacturerStringPaper mill or manufacturer name
mediaTypeMediaTypeJDF media type classification
moistureFloatMoisture content percentage (0–100)
nameString!Display name of the substrate
notesStringFree-text notes
opacityMediaOpacityTransparency level of the media
preAppliedCoatings[MediaCoating!]Factory-applied coatings already on the media
printingTechnologyMediaPrintingTechnologyPrinting technology compatibility
recycledPercentageFloatPercentage of recycled content (0–100)
reorderThresholdFloatMinimum stock level before reorder is triggered
reorderUnitMeasurementUnitUnit of measure for the reorder threshold
shrinkIndex[Float!]Shrink compensation factors [x, y] as percentages
stockTypeMediaStockTypePaper stock type classification
supplierCodeStringSupplier's own product code
supplierIdSupplierIDReference to the supplier record
supplierLeadTimeDaysIntSupplier lead time in calendar days
textureMediaTextureSurface texture or finish
thicknessLengthCaliper / thickness — supports µm provenance for film and other thin stocks.
unitCostFloatCost per unit in the specified currency
updatedAtString!ISO 8601 last-update timestamp
weightPaperWeightPaper 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.
widthLengthSheet or roll width — pick the unit field on Length (mm, inches, …) for the desired representation.

Relationships ​

Connect machines, automate workflows, and build custom apps for print production.