← All resources

Resource

substrate

A substrate/media definition for printing

GraphQL reference →

Configuration

externalIdStringOptional

External system identifier for integration

nameString!Required

Display name of the substrate

codeStringOptional

Internal catalog code

externalCodeStringOptional

Cached substrate designation used by an external system

supplierCodeStringOptional

Supplier's own product code

supplierIdSupplierIDOptional

Reference to the supplier record

References supplier

manufacturerStringOptional

Paper mill or manufacturer name

brandStringOptional

Commercial brand or product line name

kindMediaKindOptional

Physical form: roll or sheet stock

Allowed values

ROLL — Roll stock

SHEET — Sheet stock

mediaTypeMediaTypeOptional

JDF media type classification

Allowed values

BLANKET — The rubber blanket that transfers ink from plate to substrate on an offset press. Press consumable rather than printed stock.

CORRUGATED_BOARD — Fluted board — one or more corrugated layers between liners — used for shipping cases and heavy-duty packaging.

DISC — An optical disc surface printed directly, such as a CD or DVD face.

END_BOARD — The stiff board forming the front and back covers of a hard-bound book.

EMBOSSING_FOIL — Foil applied under heat and pressure to raise and decorate an area in one pass.

FILM — Photographic or imagesetter film, used to carry an image for plate exposure.

FOIL — Metallic or pigmented foil stamped onto the substrate for decoration.

GRAVURE_CYLINDER — The engraved cylinder that carries the image on a gravure press.

IMAGING_CYLINDER — A cylinder imaged directly on press, as used by direct-imaging and some digital presses.

LAMINATING_FOIL — A film laminated over the printed sheet to protect it or change its finish.

MOUNTING_TAPE — Double-sided tape that mounts a flexographic plate to its cylinder or sleeve. Its thickness and hardness affect the print.

PAPER — Conventional paper or paperboard — the default substrate for most commercial print.

PLATE — A printing plate carrying the image for one separation on an offset, flexo, or letterpress press.

SCREEN — The mesh screen through which ink is forced in screen printing.

SELF_ADHESIVE — Face stock pre-coated with adhesive and carried on a release liner — the substrate for pressure-sensitive labels.

SHRINK_FOIL — Film that shrinks to the contour of a container when heated, used for sleeve labels.

SLEEVE — A seamless cylindrical sleeve carrying a flexographic image, mounted over the print cylinder.

SYNTHETIC — A plastic-based sheet such as polypropylene or polyester, chosen where paper would tear or absorb moisture.

TEXTILE — Fabric printed directly, as in garment or soft-signage production.

TRANSPARENCY — A clear sheet intended to be viewed or projected through rather than reflectively.

OTHER — A substrate that does not fall into any of the JDF categories above. Use the substrate's own name and properties to identify it.

isoPaperSubstrateISOPaperSubstrateOptional

ISO 12647 paper substrate classification (PS1–PS8)

Allowed values

PS1 — Gloss coated wood-free

PS2 — Matte coated wood-free

PS3 — Gloss coated wood-containing

PS4 — Uncoated white

PS5 — Uncoated yellowish

PS6 — Uncoated bulk / lightweight coated

PS7 — Coated with fluorescent whitener

PS8 — Cast coated

widthLengthOptional

Sheet or roll width in mm

View LengthInput fields →

heightLengthOptional

Sheet height or roll length; supply a Length value with its unit, or omit when unknown.

View LengthInput fields →

weightPaperWeightOptional

Paper weight with its unit: gsm, or pounds at a named basis sheet. It is stored as given, so a weight entered at its own basis keeps it.

View PaperWeightInput fields →

thicknessLengthOptional

Caliper thickness in mm

View LengthInput fields →

coatings[MediaCoating!]Optional

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

Allowed values

COATED — Coated

HIGH_GLOSS — High gloss

GLOSSY — Glossy

MATTE — Matte

NONE — No coating

SATIN — Satin

SEMIGLOSS — Semi-gloss

grainDirectionMediaGrainDirectionOptional

Paper grain direction

Allowed values

ANY — Any grain direction

LONG — Long grain

SHORT — Short grain

imageableSideMediaImageableSideOptional

Which sides of the media can be printed

Allowed values

FRONT — Front only

BACK — Back only

BOTH — Both sides

NEITHER — Neither side

opacityMediaOpacityOptional

Transparency level of the media

Allowed values

OPAQUE — Opaque

TRANSLUCENT — Translucent

TRANSPARENT — Transparent

printingTechnologyMediaPrintingTechnologyOptional

Printing technology compatibility

Allowed values

DYE_SUBLIMATION — Dye sublimation

ELECTROSTATIC — Electrostatic

FLEXO — Flexographic

GRAVURE — Gravure

INKJET — Inkjet

LASER — Laser

LETTERPRESS — Letterpress

OFFSET — Offset

SCREEN — Screen printing

THERMAL — Thermal

stockTypeMediaStockTypeOptional

Paper stock type classification

Allowed values

BIBLE — Bible paper

BOND — Bond paper

BOOK — Book paper

BRISTOL — Bristol board

COATED — Coated stock

COVER — Cover stock

INDEX — Index stock

LEDGER — Ledger paper

MANIFOLD — Manifold paper

NEWSPRINT — Newsprint

OFFSET — Offset stock

TAG — Tag stock

TEXT — Text stock

textureMediaTextureOptional

Surface texture or finish

Allowed values

ANTIQUE — Antique finish

GLOSSY — Glossy finish

LINEN — Linen finish

MATTE — Matte finish

SMOOTH — Smooth finish

VELLUM — Vellum finish

colorMediaColorOptional

Base color of the media

Allowed values

WHITE — White

BUFF — Buff

PINK — Pink

YELLOW — Yellow

BLUE — Blue

GREEN — Green

GOLDENROD — Goldenrod

IVORY — Ivory

ORANGE — Orange

RED — Red

CREAM — Cream

GRAY — Gray

TAN — Tan

TRANSPARENT — Transparent

OTHER — Other color

preAppliedCoatings[MediaCoating!]Optional

Factory-applied coatings already on the media

Allowed values

COATED — Coated

HIGH_GLOSS — High gloss

GLOSSY — Glossy

MATTE — Matte

NONE — No coating

SATIN — Satin

SEMIGLOSS — Semi-gloss

shrinkIndex[Float!]Optional

Shrink compensation factors [x, y] as percentages

brightnessFloatOptional

ISO brightness percentage (0–100)

cieWhitenessFloatOptional

CIE whiteness index

gradeIntOptional

Paper grade classification number

fluteTypeMediaFluteTypeOptional

Corrugated board flute type per JDF specification

Allowed values

A — A flute (~4.8mm)

B — B flute (~3.2mm)

C — C flute (~4.0mm)

E — E flute (~1.6mm)

F — F flute (~0.8mm)

N — N flute (~1.8mm)

BC — BC double-wall flute

EB — EB double-wall flute

MICRO — Micro flute

recycledPercentageFloatOptional

Percentage of recycled content (0–100)

buyerSuppliedBoolean!Optional

Whether this substrate is supplied by the buyer

moistureFloatOptional

Moisture content percentage (0–100)

supplierLeadTimeDaysIntOptional

Supplier lead time in calendar days

isActiveBoolean!Optional

Whether this substrate is available for use

reorderThresholdFloatOptional

Minimum stock level before reorder is triggered

reorderUnitMeasurementUnitOptional

Unit of measure for the reorder threshold

Allowed values

CLICK — A billing counter rather than a physical measure: one metered page charged under a cost-per-click press or copier contract.

CM — Centimetres — metric length, a hundredth of a metre.

FT — Feet — imperial length, twelve inches.

G — Grams — metric mass, for light items stocked by weight.

IMPRESSION — A production counter rather than a physical measure: one pass of one sheet through a press. Distinct from SHEET, since a sheet printed on both sides can cost two impressions.

IN — Inches — imperial length, the unit paper sizes are quoted in outside metric markets.

KG — Kilograms — metric mass, the usual unit for reel and other bulk substrate stock.

LB — Pounds — imperial mass, roughly 0.45 kg.

M — Metres — metric length, the usual unit for material bought by the running metre such as a reel or a roll of laminate.

MM — Millimetres — metric length, a thousandth of a metre, and the granularity trim sizes and other sheet dimensions are normally given in.

OZ — Ounces — imperial mass, a sixteenth of a pound.

PC — Pieces: a plain count of discrete items, carrying no dimension at all. The unit stock and transfer quantities fall back to when none is given.

PT — Points — the typographic length unit of one seventy-second of an inch, used for type sizes and rule weights rather than for stock quantities.

REPEAT — One printed repeat of a web: a cut-off in web offset, a repeat in flexo and labels. What a roll press counts when it produces signatures.

SHEET — A count of substrate sheets, the usual unit for sheet-fed stock. Counts the physical sheets held or moved, not the press passes over them (see IMPRESSION).

unitCostFloatOptional

Cost per unit in the specified currency

costCurrencyCurrencyISOOptional

Currency code for unitCost

notesStringOptional

Free-text notes

Input types

Fields for the structured values used in this resource’s configuration.

LengthInput

Input form of Length. Resolver-side, the value is converted to a Length at the boundary.

valueFloat!Required

Numeric value, in unit.

unitLengthUnit!Required

The unit value is supplied in. Stored verbatim; no canonicalisation.

Allowed values

UM — Micrometres (µm). 1 µm = 1/1000 mm.

MM — Millimetres. The internal canonical unit for arithmetic-equivalence.

CM — Centimetres. 1 cm = 10 mm.

IN — International inches. 1 in = 25.4 mm exactly.

PT — PostScript / DTP points. 72 pt = 1 in.

PaperWeightInput

Input form of PaperWeight. Resolver-side, convert with asPaperWeight() — throws if the embedded unit is missing required fields.

valueFloat!Required

Numeric value, in unit.

unitPaperWeightUnitInput!Required

Nested unit input. See PaperWeightUnitInput.

View PaperWeightUnitInput fields →

PaperWeightUnitInput

Input form of PaperWeightUnit. Encodes the .gsm | .poundsAtBasis(basis) cases as a flat-enum plus an optional sibling basis field.

kindPaperWeightUnitKind!Required

Discriminator for the unit case.

Allowed values

GSM — Grams per square metre — the EU/world convention. Self-contained; no basis required.

POUNDS_AT_BASIS — US pounds-per-ream at a named basis sheet size. Always paired with a `PaperBasis`.

basisPaperBasisOptional

US basis sheet size. Required iff kind == POUNDS_AT_BASIS; ignored otherwise.

Allowed values

TEXT_BOOK — Book / text papers. Basis sheet 25" × 38" (950 in²).

BOND — Writing / ledger / bond. Basis sheet 17" × 22" (374 in²).

COVER — Cover stock. Basis sheet 20" × 26" (520 in²).

INDEX — Index card stock. Basis sheet 25.5" × 30.5" (777.75 in²).

TAG — Tag stock. Basis sheet 24" × 36" (864 in²).

BRISTOL — Bristol. Basis sheet 22.5" × 28.5" (641.25 in²).

NEWSPRINT — Newsprint. Basis sheet 24" × 36" (864 in²).

Read-only values

Show values
idSubstrateID!Read only

Unique substrate identifier

computed by the platform

externalUrlStringRead only

External URL for the calling integration, or the primary identity for unscoped callers.

computed by the platform

externalIdentities[RecordExternalIdentity!]!Read only

All linked external identities, including identities belonging to other integrations.

computed by the platform

createdByIntegrationIdIntegrationInstanceIDRead only

Integration instance that originally created this record, when known.

computed by the platform

createdByStackIdIaCStackIDRead only

IaC stack that originally created this record, when known.

computed by the platform

managedByStackIdIaCStackIDRead only

IaC stack currently managing this record's configuration and deletion.

computed by the platform

createdAtString!Read only

ISO 8601 creation timestamp

computed by the platform

updatedAtString!Read only

ISO 8601 last-update timestamp

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.