UpsertSubstrateInput
Input for creating or updating a substrate
Fields
Substrate ID — omit to create, provide to update
External system identifier for integration
HTTP(S) link to this record in the external system. Requires an external identity. Omit to preserve the existing link, or pass null to clear it. Removing the external identity also removes its link.
Display name of the substrate
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
Commercial brand or product line name
Physical form: roll or sheet stock
Possible values (2)
ROLLRoll stock
SHEETSheet stock
JDF media type classification
Possible values (21)
BLANKETThe rubber blanket that transfers ink from plate to substrate on an offset press. Press consumable rather than printed stock.
CORRUGATED_BOARDFluted board — one or more corrugated layers between liners — used for shipping cases and heavy-duty packaging.
DISCAn optical disc surface printed directly, such as a CD or DVD face.
END_BOARDThe stiff board forming the front and back covers of a hard-bound book.
EMBOSSING_FOILFoil applied under heat and pressure to raise and decorate an area in one pass.
FILMPhotographic or imagesetter film, used to carry an image for plate exposure.
FOILMetallic or pigmented foil stamped onto the substrate for decoration.
GRAVURE_CYLINDERThe engraved cylinder that carries the image on a gravure press.
IMAGING_CYLINDERA cylinder imaged directly on press, as used by direct-imaging and some digital presses.
LAMINATING_FOILA film laminated over the printed sheet to protect it or change its finish.
MOUNTING_TAPEDouble-sided tape that mounts a flexographic plate to its cylinder or sleeve. Its thickness and hardness affect the print.
PAPERConventional paper or paperboard — the default substrate for most commercial print.
PLATEA printing plate carrying the image for one separation on an offset, flexo, or letterpress press.
SCREENThe mesh screen through which ink is forced in screen printing.
SELF_ADHESIVEFace stock pre-coated with adhesive and carried on a release liner — the substrate for pressure-sensitive labels.
SHRINK_FOILFilm that shrinks to the contour of a container when heated, used for sleeve labels.
SLEEVEA seamless cylindrical sleeve carrying a flexographic image, mounted over the print cylinder.
SYNTHETICA plastic-based sheet such as polypropylene or polyester, chosen where paper would tear or absorb moisture.
TEXTILEFabric printed directly, as in garment or soft-signage production.
TRANSPARENCYA clear sheet intended to be viewed or projected through rather than reflectively.
OTHERA substrate that does not fall into any of the JDF categories above. Use the substrate's own name and properties to identify it.
ISO 12647 paper substrate classification (PS1–PS8)
Possible values (8)
PS1Gloss coated wood-free
PS2Matte coated wood-free
PS3Gloss coated wood-containing
PS4Uncoated white
PS5Uncoated yellowish
PS6Uncoated bulk / lightweight coated
PS7Coated with fluorescent whitener
PS8Cast coated
Sheet or roll width in mm
Sheet height or roll length; supply a Length value with its unit, or omit when unknown.
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.
Caliper thickness in mm
Surface coating per side: 1 element (both sides) or 2 elements [front, back]
Possible values (7)
COATEDCoated
HIGH_GLOSSHigh gloss
GLOSSYGlossy
MATTEMatte
NONENo coating
SATINSatin
SEMIGLOSSSemi-gloss
Paper grain direction
Possible values (3)
ANYAny grain direction
LONGLong grain
SHORTShort grain
Which sides of the media can be printed
Possible values (4)
FRONTFront only
BACKBack only
BOTHBoth sides
NEITHERNeither side
Transparency level of the media
Possible values (3)
OPAQUEOpaque
TRANSLUCENTTranslucent
TRANSPARENTTransparent
Printing technology compatibility
Possible values (10)
DYE_SUBLIMATIONDye sublimation
ELECTROSTATICElectrostatic
FLEXOFlexographic
GRAVUREGravure
INKJETInkjet
LASERLaser
LETTERPRESSLetterpress
OFFSETOffset
SCREENScreen printing
THERMALThermal
Paper stock type classification
Possible values (13)
BIBLEBible paper
BONDBond paper
BOOKBook paper
BRISTOLBristol board
COATEDCoated stock
COVERCover stock
INDEXIndex stock
LEDGERLedger paper
MANIFOLDManifold paper
NEWSPRINTNewsprint
OFFSETOffset stock
TAGTag stock
TEXTText stock
Surface texture or finish
Possible values (6)
ANTIQUEAntique finish
GLOSSYGlossy finish
LINENLinen finish
MATTEMatte finish
SMOOTHSmooth finish
VELLUMVellum finish
Base color of the media
Possible values (15)
WHITEWhite
BUFFBuff
PINKPink
YELLOWYellow
BLUEBlue
GREENGreen
GOLDENRODGoldenrod
IVORYIvory
ORANGEOrange
REDRed
CREAMCream
GRAYGray
TANTan
TRANSPARENTTransparent
OTHEROther color
Factory-applied coatings already on the media
Possible values (7)
COATEDCoated
HIGH_GLOSSHigh gloss
GLOSSYGlossy
MATTEMatte
NONENo coating
SATINSatin
SEMIGLOSSSemi-gloss
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
Possible values (9)
AA flute (~4.8mm)
BB flute (~3.2mm)
CC flute (~4.0mm)
EE flute (~1.6mm)
FF flute (~0.8mm)
NN flute (~1.8mm)
BCBC double-wall flute
EBEB double-wall flute
MICROMicro flute
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
Whether this substrate is available for use
Minimum stock level before reorder is triggered
Unit of measure for the reorder threshold
Possible values (15)
CLICKA billing counter rather than a physical measure: one metered page charged under a cost-per-click press or copier contract.
CMCentimetres — metric length, a hundredth of a metre.
FTFeet — imperial length, twelve inches.
GGrams — metric mass, for light items stocked by weight.
IMPRESSIONA 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.
INInches — imperial length, the unit paper sizes are quoted in outside metric markets.
KGKilograms — metric mass, the usual unit for reel and other bulk substrate stock.
LBPounds — imperial mass, roughly 0.45 kg.
MMetres — metric length, the usual unit for material bought by the running metre such as a reel or a roll of laminate.
MMMillimetres — metric length, a thousandth of a metre, and the granularity trim sizes and other sheet dimensions are normally given in.
OZOunces — imperial mass, a sixteenth of a pound.
PCPieces: a plain count of discrete items, carrying no dimension at all. The unit stock and transfer quantities fall back to when none is given.
PTPoints — the typographic length unit of one seventy-second of an inch, used for type sizes and rule weights rather than for stock quantities.
REPEATOne 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.
SHEETA 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).
Cost per unit in the specified currency
Currency code for unitCost
Free-text notes
Referenced by (1)
Exact type SDL
"""Input for creating or updating a substrate"""
input UpsertSubstrateInput {
"""Substrate ID — omit to create, provide to update"""
id: SubstrateID
"""External system identifier for integration"""
externalId: String
"""
HTTP(S) link to this record in the external system. Requires an external identity. Omit to preserve the existing link, or pass null to clear it. Removing the external identity also removes its link.
"""
externalUrl: 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
"""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 in mm"""
width: LengthInput
"""
Sheet height or roll length; supply a Length value with its unit, or omit when unknown.
"""
height: LengthInput
"""
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.
"""
weight: PaperWeightInput
"""Caliper thickness in mm"""
thickness: LengthInput
"""
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
}