← All resources

Resource

product_template

A reusable product template that can be instantiated into jobs

GraphQL reference →

Configuration

nameString!Required

Template display name

descriptionStringOptional

Template description

skuStringOptional

SKU or catalogue code

isActiveBoolean!Optional

Whether available for instantiation (defaults to true)

tags[String!]Optional

Free-form tags for catalogue filtering

categoryStringOptional

Category for catalogue organisation

printFormatStringOptional

Optional inkjet flatwork format: standard or wide_format

feedTypeStringOptional

Optional inkjet flatwork feed: sheet or roll

curingMethodStringOptional

Optional inkjet flatwork curing: aqueous or uv_led

preferredPrintProcessStringOptional

Preferred print process for inference: offset, digital, or inkjet

components[TemplateComponentSpec!]!Optional

Ordered component specifications

View TemplateComponentSpecInput fields →

operations[TemplateOperationSpec!]!Optional

Top-level operation specifications

View TemplateOperationSpecInput fields →

configSchemaJSONOptional

JSONSchema for customer-facing configuration options

Input types

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

TemplateComponentSpecInput

Input for a component specification within a template

localIdString!Required

Stable local identifier

kindComponentKind!Required

Component kind

Allowed values

CONTENT — General content pages

COVER — Cover component

INSERT — Bound-in insert

MAIN — Main component of a single-component job

TEXT — Text block pages

DUST_JACKET — Dust jacket wrapper for case-bound books

ENDPAPER — Endpapers/pastedowns

OUTSERT — Outsert/wrap-around component

OTHER — Uncategorized component

nameString!Required

Default component name

defaultQuantityIntOptional

Default quantity (defaults to 1)

minQuantityIntOptional

Minimum allowed quantity

maxQuantityIntOptional

Maximum allowed quantity

quantityStepIntOptional

Quantity step increment

totalPagesIntOptional

Expected page count

mediaSelectors[MediaSelectorInput!]Optional

Acceptable media families; null = operator chooses

View MediaSelectorInput fields →

sidesPrintSidesOptional

Print sides

Allowed values

ONE_SIDED — Single-sided printing

TWO_SIDED_HEAD_TO_HEAD — Duplex, same orientation both sides

TWO_SIDED_HEAD_TO_FOOT — Duplex, tumbled (rotated 180°) on back

spreadTypeSpreadTypeOptional

Spread type

Allowed values

SINGLE_PAGE — Each page is a separate PDF page

READER_SPREAD — Pages arranged as reader spreads

PRINTER_SPREAD — Pages arranged as printer spreads (imposed)

finishedDimensionsLayoutDimensionInputOptional

Finished dimensions

View LayoutDimensionInput fields →

colorsComponentColorInfoInputOptional

Default colour specification

View ComponentColorInfoInput fields →

layoutComponentLayoutInputOptional

Default piece geometry

View ComponentLayoutInput fields →

finishingFinishingSpecInputOptional

Default finishing specification

View FinishingSpecInput fields →

TemplateOperationSpecInput

Input for an operation step within a product template

localIdString!Required

Stable local identifier

componentLocalIdStringOptional

Component this operation belongs to

kindOperationKind!Required

Operation kind

Allowed values

BINDING — Holding the finished components together as one product. The generic kind, for when the specific binding method is not yet decided.

BOOK_BLOCK_MAKING — Assembling the folded signatures into the book block that will later be cased in.

COLLATING — Gathering printed sheets or signatures into the correct page order before binding.

COMB_BINDING — Binding with a plastic comb through punched rectangular holes, so the book opens flat and can be reopened to add pages.

CONTOUR_CUTTING — Cutting along an arbitrary outline that follows the artwork, rather than to a rectangular trim.

CREASING — Pressing a channel into the substrate so it folds along a controlled line without cracking the fibres or the printed surface.

CUTTING — Trimming the sheet to its finished size on a guillotine or three-knife trimmer.

DEBOSSING — Pressing a design below the surface of the substrate, the inverse of embossing.

DIE_CUTTING — Cutting shapes with a steel die, for outlines a straight guillotine cut cannot make.

DIGITAL_PRINTING — Printing directly from digital data with no plate, so each impression can differ and short runs carry no plate cost.

DRILLING — Making round holes through the stack, typically for ring or mechanical binding.

EMBOSSING — Raising a design above the surface of the substrate under heat and pressure.

FOIL_STAMPING — Applying metallic or pigmented foil to the substrate with a heated die.

FOLDING — Folding the printed sheet into signatures or into the finished product's fold pattern.

GLUING — Applying adhesive to join parts of the product, as in a carton seam or a bound spine.

HEAD_BANDING — Attaching the decorative fabric band at the head and tail of a hard-bound book's spine.

INKJET_PRINTING — Printing by jetting ink droplets onto the substrate, without contact between head and stock.

FLOOD_COATING — Applying a coating over the entire printed area, for protection or overall finish.

LAMINATING — Bonding a film over the printed sheet to protect it and change its surface finish.

OFFSET_PRINTING — Lithographic printing in which ink passes from plate to blanket to substrate. The high-volume commercial process, with a per-job plate cost.

PACKING — Packing the finished product for storage or despatch.

PERFECT_BINDING — Binding by milling the spine flat and gluing the pages into a wrapped cover, as used for paperbacks.

PERFORATING — Cutting a line of small slits so a part can be torn away cleanly by hand.

PRECUTTING — Cutting the stock down before printing, to bring it to press size or to split it into working sections.

PRINTING — Marking the substrate with the artwork, when the specific press process is not yet decided.

PUNCHING — Making shaped holes with a punch tool, for binding elements or for the product's own features.

RING_BINDING — Binding with wire loops through punched holes, so the book opens flat and lies open.

SADDLE_STITCHING — Stapling folded signatures through the spine fold. Cheap and fast, but limited to low page counts.

SCORING — Impressing a line to weaken the substrate along a fold, without cutting it.

SEWING — Sewing the signatures together with thread, the most durable binding for a book block.

REWINDING — Rewinding printed web into delivery rolls with authored count, length and winding requirements.

SLITTING — Cutting the web or sheet lengthwise into narrower strips.

SPIRAL_BINDING — Binding with a continuous coil threaded through punched holes.

STITCHING — Fastening with wire staples, when the stitching pattern is not specified further.

STRIP_BINDING — Binding with a plastic strip clamped through the punched edge of the stack.

CASE_MAKING — Making the hard case — boards plus covering material — that a book block is later cased into.

CASING_IN — Fixing the finished book block into its case to complete a hard-bound book.

CUSTOM — An operation the print catalog does not name. Its meaning comes from the operation's own parameters rather than from this kind.

DRYING — Allowing or forcing ink or coating to cure before the next operation can run. Occupies time and space without changing the product.

ENDPAPER_TIPPING — Gluing the endpapers to the first and last signatures of a book block.

EYELETS — Setting metal eyelets into punched holes, to reinforce them for hanging or lacing.

HEMMING — Folding and securing the edge of a flexible substrate so it will not fray.

PLATEMAKING — Imaging the printing plates from the prepared artwork, before the press can run.

ROUNDING_BACKING — Shaping a book block's spine into a curve and flaring its shoulders so the case fits and the book opens properly.

SPINE_MILLING — Milling the folded spine off the book block to expose the individual leaves for adhesive binding.

SPOT_VARNISH — Applying varnish to selected areas only, to contrast finish against the uncoated areas around them.

KISS_CUTTING — Cutting through the face stock of a self-adhesive material but not its liner, so the label lifts off intact.

REVERSE_CUTTING — Cutting from the reverse of the sheet, for products viewed through the substrate.

PARTIAL_CUTTING — Cutting part-way through the substrate's thickness rather than all the way through.

WHITE_UNDERPRINT — Laying white ink beneath the artwork so colours stay opaque on a clear, metallic, or dark substrate.

nameString!Required

Display name

defaultParametersStringOptional

Default parameters as JSON string

dependsOn[String!]!Required

Local IDs of predecessor operations

MediaSelectorInput

Portable media-family selector for a template component

localIdString!Required

Stable identifier referenced by selectorChoices at instantiation

nameStringOptional

Descriptive label (not used for matching)

weightNumericConstraintInputOptional

GSM constraint

View NumericConstraintInput fields →

thicknessLengthConstraintInputOptional

Thickness constraint (unit-aware Length)

View LengthConstraintInput fields →

coatings[MediaCoating!]Optional

Allowed surface coatings (any-of)

Allowed values

COATED — Coated

HIGH_GLOSS — High gloss

GLOSSY — Glossy

MATTE — Matte

NONE — No coating

SATIN — Satin

SEMIGLOSS — Semi-gloss

grainDirection[MediaGrainDirection!]Optional

Allowed grain directions (any-of)

Allowed values

ANY — Any grain direction

LONG — Long grain

SHORT — Short grain

opacity[MediaOpacity!]Optional

Allowed opacity levels (any-of)

Allowed values

OPAQUE — Opaque

TRANSLUCENT — Translucent

TRANSPARENT — Transparent

stockType[MediaStockType!]Optional

Allowed stock types (any-of)

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

texture[MediaTexture!]Optional

Allowed textures (any-of)

Allowed values

ANTIQUE — Antique finish

GLOSSY — Glossy finish

LINEN — Linen finish

MATTE — Matte finish

SMOOTH — Smooth finish

VELLUM — Vellum finish

printingTechnology[MediaPrintingTechnology!]Optional

Allowed printing technologies (any-of)

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

imageableSide[MediaImageableSide!]Optional

Allowed imageable sides (any-of)

Allowed values

FRONT — Front only

BACK — Back only

BOTH — Both sides

NEITHER — Neither side

LayoutDimensionInput

Input for a width/height dimension pair

widthLengthInput!Required

Width

View LengthInput fields →

heightLengthInput!Required

Height

View LengthInput fields →

ComponentColorInfoInput

Input for component color specification

frontColorSideInputOptional

Front (recto) side colors

View ColorSideInput fields →

backColorSideInputOptional

Back (verso) side colors

View ColorSideInput fields →

ComponentLayoutInput

Input for component layout specification

substrateLayoutDimensionInputOptional

Substrate dimensions

View LayoutDimensionInput fields →

trimBoxLayoutBoxInputOptional

Trim box

View LayoutBoxInput fields →

bleedBleedSpecInputOptional

Bleed specification

View BleedSpecInput fields →

bleedBoxLayoutBoxInputOptional

Explicit bleed box

View LayoutBoxInput fields →

safeBoxLayoutBoxInputOptional

Safe area box

View LayoutBoxInput fields →

layers[LayoutLayerInput!]Optional

Ordered finishing/content layers (die lines, varnish, foil, etc.)

View LayoutLayerInput fields →

allowanceLayoutAllowanceInputOptional

Per-side allowance offsets

View LayoutAllowanceInput fields →

FinishingSpecInput

Input for finishing specification

varnishTypeStringOptional

Varnish type

dieTypeStringOptional

Die type

foilColorPrintColorInputOptional

Foil color specification

View PrintColorInput fields →

embossTypeStringOptional

Emboss type

depthLengthInputOptional

Emboss/deboss depth

View LengthInput fields →

NumericConstraintInput

Numeric constraint — supply exactly one of exact, range, or tolerance

Set exactly one field to a non-null value.

exactFloatOptional

Match this exact value

rangeNumericRangeInputOptional

Match within these bounds

View NumericRangeInput fields →

toleranceNumericToleranceInputOptional

Match within target ± tolerance

View NumericToleranceInput fields →

LengthConstraintInput

Length constraint — supply exactly one of exact, range, or tolerance

Set exactly one field to a non-null value.

exactLengthInputOptional

Match this exact length

View LengthInput fields →

rangeLengthRangeInputOptional

Match within these bounds

View LengthRangeInput fields →

toleranceLengthToleranceInputOptional

Match within target ± tolerance

View LengthToleranceInput fields →

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.

ColorSideInput

Input for one printed side's color specification

colors[PrintColorInput!]!Required

Ordered colorants for this side

View PrintColorInput fields →

LayoutBoxInput

Input for an axis-aligned box

xLengthInput!Required

Bottom-left X coordinate

View LengthInput fields →

yLengthInput!Required

Bottom-left Y coordinate

View LengthInput fields →

widthLengthInput!Required

Box width

View LengthInput fields →

heightLengthInput!Required

Box height

View LengthInput fields →

BleedSpecInput

Input for per-side bleed offsets

topLengthInput!Required

Top bleed offset

View LengthInput fields →

rightLengthInput!Required

Right bleed offset

View LengthInput fields →

bottomLengthInput!Required

Bottom bleed offset

View LengthInput fields →

leftLengthInput!Required

Left bleed offset

View LengthInput fields →

LayoutLayerInput

Input for a single layout layer (press marks are engine-generated)

idStringOptional

Stable layer identifier (auto-assigned if omitted)

nameStringOptional

Display name (defaults from kind)

kindLayoutLayerKind!Required

Layer role — structural/printable or a finishing operation

Allowed values

CONTENT — Content layer

MARKS — Marks layer (registration, trim, etc.)

WHITE_UNDERPRINT — White underprint (printed white ink base)

DIE_CUT — Die cut

KISS_CUT — Kiss cut

REVERSE_CUT — Reverse cut

PARTIAL_CUT — Partial cut

CREASE — Crease / score

PERFORATION — Perforation

SPOT_VARNISH — Spot varnish

FLOOD_VARNISH — Flood varnish / coating

LAMINATE — Lamination

FOIL — Foil stamping

EMBOSS — Emboss

DEBOSS — Deboss

FOLD — Fold

DRILL — Drill

PUNCH — Punch

GLUE — Glue

EYELETS — Eyelets / grommets

HEMMING — Hemming

OTHER — Other / unrecognised

boundaryLayerBoundaryInput!Required

Layer boundary shape

View LayerBoundaryInput fields →

finishingLayerFinishingInputOptional

Finishing parameters (coating/colour/depth)

View LayerFinishingInput fields →

printableBooleanOptional

Whether this layer carries printable content

sortOrderIntOptional

Stacking order (defaults to input order)

LayoutAllowanceInput

Input for per-side allowance offsets

topLengthInputOptional

Top allowance offset

View LengthInput fields →

rightLengthInputOptional

Right allowance offset

View LengthInput fields →

bottomLengthInputOptional

Bottom allowance offset

View LengthInput fields →

leftLengthInputOptional

Left allowance offset

View LengthInput fields →

PrintColorInput

Input for a print color specification

nameString!Required

Color name

colorTypeColorTypeOptional

Color type

Allowed values

PROCESS — Process separation (CMYK)

SPOT — Named spot color

DEVICE_N — DeviceN color space

colorSpaceStringOptional

Color space

values[Float!]Optional

Channel values

pantoneCodeStringOptional

Pantone code

opacityIntOptional

Opacity percentage

NumericRangeInput

Range bounds for a numeric constraint

minFloatOptional

Lower bound (inclusive); omit for unbounded

maxFloatOptional

Upper bound (inclusive); omit for unbounded

NumericToleranceInput

Target ± tolerance form of a numeric constraint

targetFloat!Required

Target value

toleranceFloat!Required

Permitted deviation (non-negative)

LengthRangeInput

Range bounds for a length constraint

minLengthInputOptional

Lower bound (inclusive); omit for unbounded

View LengthInput fields →

maxLengthInputOptional

Upper bound (inclusive); omit for unbounded

View LengthInput fields →

LengthToleranceInput

Target ± tolerance form of a length constraint

targetLengthInput!Required

Target length

View LengthInput fields →

toleranceLengthInput!Required

Permitted deviation (non-negative)

View LengthInput fields →

LayerBoundaryInput

Input for a layout layer boundary shape

kindLayerBoundaryKind!Required

Shape type (RECT or PATH)

Allowed values

RECT — Rectangular boundary

PATH — SVG path boundary

rectLayoutBoxInputOptional

Rectangular boundary (when kind is RECT)

View LayoutBoxInput fields →

pathStringOptional

SVG path data (when kind is PATH)

LayerFinishingInput

Input for finishing parameters on a layer

coatingTypeStringOptional

Coating type (e.g. matte, gloss)

colorStringOptional

Colour specification (e.g. foil colour)

depthFloatOptional

Emboss/deboss depth

Read-only values

Show values
idProductTemplateID!Read only

Unique identifier

computed by the platform

tenantIdTenantID!Read only

Tenant ID

computed by the platform

versionInt!Read only

Current version number

computed by the platform

statusTemplateStatus!Read only

Lifecycle status

Allowed values

DRAFT — Unpublished changes — cannot be instantiated

PUBLISHED — Published and ready for instantiation

computed by the platform

publishedVersionIntRead only

Most recently published version

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

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.