# Product Types

This page will give you an overview of all of our supported product types and their specific Article and Variant attributes. There is also full documentation for creating articles (opens new window) and creating variants (opens new window).

At present, we currently support the following product types:

# Shared attributes for all products

# Articles

The following attributes are shared between all types of Article:

name type required description example
base_unit string The base unit in which this article is counted. One of: kg, m, piece, sheet, sqm sheet
description string The marketing copy or description of the article Available in a variety of colours and finishes like Blue Steel or Purple Rain
external_identifier string You can use this attribute to store an identifier to match this article to any of your own records
manufacturer string The name of the manufacturer of this article Smith Papers
name string The name of the article, which is a unique name that identifies this amongst your other articles Magno Matte

# Variants

The following attributes are shared between all types of Variant:

name type required description example
external_identifier string You can use this attribute to store an identifier to match this article to any of your own records
global_trade_item_number string Global Trade Item Numbers (also known as GTINs) are numbers used to uniquely identify a product. Valid GTINs include EANs (International Article Numbers) and Universal Product Codes (UPCs), and these numbers are usually encoded into barcodes on products. Zaikio supports 8, 12, 13 and 14-digit variants of this number, wrapped in a string.

# Adhesive attributes

The following attributes are specific to just adhesive products:

# Article

name type required description example
kind string The kind of adhesive. One of: hotmelt, dispersion, PUR, other Dispersion
usage string For which purpose the adhesive can be used Spine gluing

# Variant

name type required description example
color string The color of the adhesive after drying white
open_time string The permissible time span from the beginning of the application of the adhesive to the joining of the parts. One of: none, very_short, short, medium, long very short
stickiness string The behaviour of the glue thermoplastic
viscosity string The fluid's resistance to flow in mPas 400

# Adhesive dot attributes

The following attributes are specific to just adhesive_dot products:

# Article

name type required description example
double_sided boolean Whether there is adhesive on both sides. true
material string The material of the dot. One of: (null), PP, silicone, PE-foam, other PE-foam
strength string The strength of the adhesive. One of: weak, strong, extra strong, removable, strong/strong, strong/weak, weak/strong, weak/weak, extra strong/extra strong strong

# Variant

name type required description example
diameter string The diameter of the point in dimensions_unit 42.0
dimensions_unit string The unit of the measurements, defaults to mm. One of: mm mm
peel_off_flap boolean Does the adhesive dot have a peel-off flap to easily come off the roll. false
perforation boolean Does the adhesive dot include a pre-cut for easy opening false
thickness string Thickness of the substrate in micrometer (metric) 42.0

# Adhesive tape attributes

The following attributes are specific to just adhesive_tape products:

# Article

name type required description example
color string The colour of the tape
double_sided boolean Is the tape double-sided
material string The underlying material that the tape is made from. One of: (null), paper, PP, PVC, PET, PE-foam, other
strength string The strength of the adhesive. One of: weak, strong, extra strong, removable, strong/strong, strong/weak, weak/strong, weak/weak, extra strong/extra strong

# Variant

name type required description example
core_diameter string
dimensions_unit string The unit for all dimensions of this product and variant. One of: mm
glue string The type of glue. For example Hotmelt, Acrylat
imprint boolean Whether there is printing on the tape
length string The length of the tape
reinforced boolean Whether the tape is reinforced
surface string The texture of the surface. For example: coated, grained
thickness string The thickness of the tape in µm.
width string The width of the tape

# Banding material attributes

The following attributes are specific to just banding_material products:

# Article

name type required description example
kind string The kind of the material. One of: foil, paper
opacity string The opacity of the material. One of: (null), clear, foamed
ultrasound boolean Whether the material supports ultrasonic processing or not

# Variant

name type required description example
color string The color of the material. Can also be 'transparent'
core_diameter string The core diameter of the roll in dimensions_unit
dimensions_unit string The unit for all dimensions of this product and variant. One of: mm
length string The length of the material on the roll in the product's dimension_unit
paper_weight integer The paper weight (i.e. grammage) if the material is made of paper, for other kinds this is null
paper_weight_unit string The unit of the paper weight, if appropriate (usually gsm)
thickness string The thickness of the material
width string The width of the roll in the product's dimension_unit

# Binding cover attributes

The following attributes are specific to just binding_cover products:

# Article

name type required description example
kind string The kind of material of the product PET

# Variant

name type required description example
color string The color of the product. Can also be 'transparent' white
dimensions_unit string The unit for all dimensions of this product and variant. One of: mm mm
heat_resistance boolean Whether the product is heat-resistant or not true
length integer The length of the product in dimensions_unit 66
size string Common description of the product. One of: A2, A3, A4, A5, A6, executive, letter, square, statement_half_letter, other, custom A4
surface string The surface texture of the foil classic
thickness integer The length of the product in µm 42
width integer The width of the product in dimensions_unit 99

# Calendar hanger attributes

The following attributes are specific to just calendar_hanger products:

# Article

name type required description example
kind string Whether the wire has any modifications. Pre-bent means there is already a notch in the wire for hanging. One of: pre_bent, straight

# Variant

name type required description example
color string The color of the product white
dimensions_unit string The unit for all dimensions of this product and variant. One of: mm
form string The form of the product. One of: (null), form_2, extra_large Form 2
length integer The length of the product in dimensions_unit 42
thickness integer The thickness of the product in dimensions_unit 42

# Carbonless copy paper attributes

The following attributes are specific to just carbonless_copy_paper products:

# Article

name type required description example
transfer_layer string The layer which will receive the ink transfer. One of: CB, CFB, CF, SC, SC/CB, collated-sets

# Variant

name type required description example
color string The human-readable color of this item. If marking the colours of multiple layers, you might wish to separate them with a /, e.g. white/blue means the top-layer is white and the second layer is blue.
dimensions_unit string The unit for all dimensions of this product and variant. One of: mm
grain string Grain of the substrate. Please note that we validate width and height dimensions depending on grain: For long grain the width needs to be smaller or equal to the height. For short grain the width needs to be larger or equal to the height. One of: (null), long, short
height string Height of the product, measured in dimensions_unit
substrate_weight integer The substrate weight (i.e. grammage, when using gsm) of the material
substrate_weight_unit string The unit of the substrate weight, usually gsm. One of: gsm
width string Width of the product, measured in dimensions_unit

# Coating attributes

The following attributes are specific to just coating products:

# Article

name type required description example
drying string The kind of drying technology. One of: waterbased, UV
finish string The kind of finish that is applied to the substrate. One of: high_gloss, gloss, neutral, extra_matt, semi_matt, haptic_matt, matt

# Variant

name type required description example
blocking_resistance string Ability to avoid detrimental adhesion between two surfaces, from 0-5. One of: (null), 0/5, 1/5, 2/5, 3/5, 4/5, 5/5
coat_weight_wet_on_wet string Indication on how much coating should be printed on the sheet. One of: (null), 2-4, 3-4, 3-6, 4-6
double_sided boolean Article is suitable for double-sided application?
drying_reactivity string Indication of drying/reactivity ability, from 0-5. One of: (null), 0/5, 1/5, 2/5, 3/5, 4/5, 5/5
finish_level string Gloss/Matt indication level, from 0-5. One of: (null), 0/5, 1/5, 2/5, 3/5, 4/5, 5/5
glueable_embossable string Indication on possibility of glueing or embossing. One of: (null), not_suitable, test_first, suitable
migration_certification boolean Product has a Migration certification?
scuff_resistance string Indication on rub and scratch resistance, from 0-5. One of: (null), 0/5, 1/5, 2/5, 3/5, 4/5, 5/5
slip string Indication of slip ability, from 0-5. One of: (null), 0/5, 1/5, 2/5, 3/5, 4/5, 5/5
supports_UV_coating_overprint string Indication on possibility of UV coating overprinting. One of: (null), not_suitable, test_first, suitable
supports_film_foil_laminating string Indication on possibility of film or foil laminating. One of: (null), not_suitable, test_first, suitable
supports_printing_on_board string Indication on possibility of usage with board. One of: (null), not_suitable, test_first, suitable
supports_printing_on_coated_paper string Indication on possibility of usage with coated paper. One of: (null), not_suitable, test_first, suitable
supports_printing_on_offset_paper string Indication on possibility of usage with offset paper. One of: (null), not_suitable, test_first, suitable
supports_printing_on_plastics_foil_stocks string Indication on possibility of plastics or foil printing stocks. One of: (null), not_suitable, test_first, suitable

# Coating plate attributes

The following attributes are specific to just coating_plate products:

# Article

name type required description example
applications array The possible applications for this coating plate with suitability rating, one or several
color string The color of the coating plate material
compressible_layer string The structure of the compressible layer. One of: (null), closed cells, yes, no
fabric_layers integer The number of layers (e.g. fabric layer, compressible layer and rubber layer = 3)
hardness integer The estimated hardness of the surface in Shore A, see https://en.wikipedia.org/wiki/Shore_durometer
rubber_composition string The kind of rubber that is used. One of: none, nbr, epdm, irr, bu, nitrile, nylon, rubber, tpu, polymer-tpu
surface string The texture of the surface. One of: rubber-nbr, rubber-tpu, polymer-tpu

# Variant

name type required description example
dimensions_unit string The unit for all dimensions of this product and variant, defaults to mm. One of: mm
height string The height of the coating plate in dimensions_unit (mm)
relief_depth string The depth of the relief of the coating plate in dimensions_unit (mm)
thickness string Thickness of the coating plate in dimensions unit (mm)
width string The width of the coating plate in dimensions_unit (mm)

# Envelope attributes

The following attributes are specific to just envelope products:

# Article

name type required description example
flap_shape string The shape of the sealing flap. One of: (null), curved, pointed, rounded, straight, trapeze
sealing string The kind of sealing the envelope uses. One of: (null), none, pressure-sensitive, self-sealing, wet-adhesive
surface string The surface texture of the envelope. One of: rough, smooth

# Variant

name type required description example
color string The colour of the envelope
dimensions_unit string The unit for all dimensions of this product and variant, defaults to mm. One of: mm
height string The (vertical) left edge, perpendicular to the flap and window, in dimensions_unit (mm)
orientation string Whether the width (top edge) is longer (landscape) or shorter (portrait) than the height (left edge). The flap, and window if present, are always aligned with the top edge. If absent, we'll try to calculate the orientation using the ratio of width to height. One of: landscape, portrait
size string Common description of the envelope size, one of the following international standards: ISO216, DIN678, US commercial, as well as the values square and custom (if the envelope size is not recognised by us). If absent, we'll try to calculate the size using the provided width/height. One of: B4, B5, B6, C0, C1, C2, C3, C4, C4+, C5, C5+, C6, C7, C8, C9, C10, DL, C6/C5, E4, E5, E6, , , 7, 8⅝, 9, 10, 11, 12, 14, square, other
substrate_weight integer The substrate weight (i.e. grammage, when using gsm) of the envelope
substrate_weight_unit string The unit of the substrate weight, usually gsm. One of: (null), gsm, basis weight
width string The (horizontal) top edge, parallel to the flap and window, in dimensions_unit (mm)
window boolean Whether this envelope has a window or not. Windows are parallel to the top edge.

# Filter attributes

The following attributes are specific to just filter products:

# Article

name type required description example
compatibility string The machine that this filter is known to work with
kind string The mechanism that this filter is designed to be used with. One of: bag, fleece, insert, air, belt

# Variant

name type required description example
diameter string Diameter of this filter, if applicable, in dimensions_unit 70
dimensions_unit string Unit of measurement for width, height, length and diameter, required if any of those are set. One of: (null), mm mm
height string Height of this filter, if applicable, in dimensions_unit 47
layers integer The number of layers that this filter contains, if applicable 3
length string Length of this filter, if applicable, in dimensions_unit 350
width string Width of this filter, if applicable, in dimensions_unit 450

# Ink attributes

The following attributes are specific to just ink products:

# Article

name type required description example
identifier string The precise identifier of this ink's colour for the colour system selected in system. If the system CMYK is selected, this identifier must be one of: Cyan, Magenta, Yellow, Black (please note the capitalisation). If Pantone/HKS are selected this represents the Pantone/HKS colour name or number. Cyan
printing_technique string The printing technolgies with which this ink can be used. One of: offset, flexographic, gravure
system string The colour system in which this ink is represented. The value in identifier describes the exact name of the ink in the colour system selected here. If the ink is a standard scale colour, the system CMYK must be selected. One of: CMYK, HKS, Pantone

# Variant

name type required description example
custom_flavor string If this variant represents a special colour formula for a specific customer (i.e. Pantone Red for Coca-Cola) this attribute contains the name of this flavour (i.e. Coco-Cola). If the variant represents a generic formula this attribute must be left empty.
supported_substrate string The kind of substrate on which one can print with this ink. In offset settings for example some ink formulas can be used on coated paper while other can be used on uncoated paper. If there is no difference in which substrates can be printed on the value universal must be selected here. One of: universal, coated, uncoated, newspaper

# Laminating foil attributes

The following attributes are specific to just laminating_foil products:

# Article

name type required description example
surface string The surface texture of the foil. One of: gloss, leather, linen, matte, matte/scratch-resistant, metallic, soft-touch

# Variant

name type required description example
diameter string The core diameter of the roll in dimensions unit 77
dimensions_unit string The unit for all dimensions of this product and variant, defaults to mm. One of: mm
length string The length of the roll in dimensions unit 500000
thickness string The thickness of the roll in dimensions unit 0.034
width string The width of the roll in dimensions unit 320

# Offset printing blanket attributes

The following attributes are specific to just offset_printing_blanket products:

# Article

name type required description example
applications array The possible applications for this blanket, one or several
color string The color of the blanket material
compressible_layer string The structure of the compressible layer. One of: (null), closed cells, yes, no
fabric_layers integer The number of layers (e.g. fabric layer, compressible layer and rubber layer = 3)
hardness integer The estimated hardness of the surface in Shore A, see https://en.wikipedia.org/wiki/Shore_durometer
ink_compatibility array Which inks types this blanket is compatible with, if empty it is assumed to be incompatible with all inks
rubber_composition string The kind of rubber that is used. One of: nbr, epdm
surface string The texture of the surface. One of: fine_medium, medium_rough, plain_surface, plain_surface_unpolished, glass_beads_unpolished, rubber_fabric, rubber-nbr, polymer-tpu
surface_roughness string The estimated roughness of the surface Ra in micrometers, see https://en.wikipedia.org/wiki/Surface_roughness

# Variant

name type required description example
dimensions_unit string The unit for all dimensions of this product and variant, defaults to mm. One of: mm
height string The height of the blanket in dimensions_unit (mm)
thickness string The thickness of the blanket in dimensions_unit (mm) 0.034
width string The width of the blanket in dimensions_unit (mm)

# Plate attributes

The following attributes are specific to just plate products:

# Article

name type required description example
burnable boolean Whether this plate can be burned-in to extend the number of copies that can be made or not. Will return null if unknown
kind string The kind of material or materials the plate is made of. One of: thermal, thermal/low_chemistry, thermal/processless, uv, silver, violet, polyester
maximum_number_of_copies_with_ink integer The number of copies that can be made with this plate while using ink
maximum_number_of_copies_with_varnish integer The number of copies that can be made with this plate while using UV varnish
supports_uv boolean Whether this plate is suitable for usage with UV varnish or not. Will return null if unknown
surface_structure string The type of the required surface structure after exposure. One of: negative, positive

# Variant

name type required description example
dimensions_unit string The unit of the measurements, defaults to mm. One of: mm
height string The height of the variant in millimetres (metric), with changes of the direction of rotation. Do not replace (!) with the variant's width. 6.35
orientation string Orientation of the emulsion side of plates when packaged. One of: (null), face_up, face_down
thickness string The thickness of the plate in dimensions_unit (mm) 150
web boolean If true this plate supports printing in web presses. False otherwise. Please note that this property can be left empty if unknown, in which case it is safe to assume that such a plate cannot be used in web presses.
width string The width of the variant in millimetres (metric), with changes of the direction of rotation. Do not replace (!) with the variant's height 1000
wrapping string The wrapping mode of a stack of plates. Might be single (every plate in the stack is wrappend, there might be another SKU-based wrapping around), single with single with separator (same as single but with an additional spacer/separator between each plate) and multiple. This is important because the consumers might have some form of automation that requires a certain mode of wrapping, so consumers want to select this. Can be left empty if unknown. One of: (null), single, single_with_separator, multiple

# Ring binding attributes

The following attributes are specific to just ring_binding products:

# Article

name type required description example
kind string The kind of the material. One of: metal, metal_spool, plastic
number_of_loops integer The number of loops found on a single spool. *Note: number_of_loops is required if kind is "metal_spool" 12000
ratio string The ratio of holes per length, also known as pitch, for example 4:1 means "four holes per inch". 3:1
size string The size of the paper to be bound, in DIN/ISO 216 format. *Note: size is required if kind is "metal". One of: A3, A4, A5, A6
system string The subcategory of ring binding this belongs to. One of: wire_comb

# Variant

name type required description example
color string The colour of the binding material
diameter string Diameter of the rings, in millimetres (metric) 6.35
diameter_imperial string Diameter of the rings in inches (imperial). Must include units (e.g. 4" or 1/4 in). 1/4 in

# Self adhesive attributes

The following attributes are specific to just self_adhesive products:

# Article

name type required description example
coating string Describes the of the substrate. One of: (null), none, one-sided-cast-coated, one-sided-coated
kind string The kind of material. One of: foil, paper
surface string The texture of the surface

# Variant

name type required description example
adhesive string The kind of adhesive used. One of: (null), removable, permanent, extra-permanent
carrier string The kind of carrier used. One of: (null), notched, slit, unslit
color string Color of the substrates surface
dimensions_unit string The unit for all dimensions of this product and variant. One of: mm
grain string The grain of the paper. One of: (null), long, short
height integer The height of the variant in millimeter (metric)
substrate_weight integer The substrate weight
substrate_weight_unit string The unit of the substrate weight, defaults to gsm. One of: (null), gsm, basis weight
width integer The width of the variant in millimeter (metric)

# Sleeking foil attributes

The following attributes are specific to just sleeking_foil products:

# Article

name type required description example
surface string The surface texture of the foil. One of: gloss, matte, metallic, hologram

# Variant

name type required description example
color string The color of the surface
core_diameter string Diameter of the core of the roll in dimensions_unit 77.0
dimensions_unit string The unit used for the measurements of the variant. Defaults to mm. One of: mm
length string The length of the roll in dimensions_unit
width string The width of the roll in dimensions_unit

# Specialized printing blanket attributes

The following attributes are specific to just specialized_printing_blanket products:

# Article

name type required description example
applications array The possible applications for this blanket, one or several
color string The color of the blanket material
compressible_layer string The structure of the compressible layer. One of: (null), closed cells, yes, no
fabric_layers integer The number of layers (e.g. fabric layer, compressible layer and rubber layer = 3)
hardness integer The estimated hardness of the surface in Shore A, see https://en.wikipedia.org/wiki/Shore_durometer
ink_compatibility array Which inks types this blanket is compatible with, if empty it is assumed to be incompatible with all inks
rubber_composition string The kind of rubber that is used. One of: nbr, epdm, irr, bu, nitrile, nylon, rubber, tpu
surface string The texture of the surface. One of: fine_medium, medium_rough, plain_surface, plain_surface_unpolished, rubber_fabric
surface_roughness string The estimated roughness of the surface Ra in micrometers, see https://en.wikipedia.org/wiki/Surface_roughness

# Variant

name type required description example
dimensions_unit string The unit used for dimensions (width, height, thickness). One of: mm
height string The height of the blanket in dimensions_unit
thickness string Thickness of the blanket in dimensions_unit
width string The width of the blanket in dimensions_unit

# Stitching wire attributes

The following attributes are specific to just stitching_wire products:

# Article

name type required description example
form string The form of the wire. One of: round, flat round
gauge string The stitching wire standard gauge which corresponds to the thickness of the wire 42
thickness string The thickness of the wire in mm 42.0
width string The width of the wire in mm 42.0

# Variant

name type required description example
color string The colour of the wire, if the wire is bare metal this is null red
dimensions_unit string The unit of the measurements, defaults to mm. One of: mm mm
length integer The length of the stitching wire 42
surface string The surface of the stitching wire Galvanized

# Substrate attributes

The following attributes are specific to just substrate products:

# Article

name type required description example
certifications array A list of certifications for this particular substrate
classification_reports array A list of reference reports, which could be related to the certifications
coated string Describes the sides on which the paper is coated. One of: none, one side, both sides
finish string The type of surface finish of the substrate "matte", "painted", "glossy", "elephant skin"
kind string Type of the printable substrate. One of: (null), carton, cloth, foil, metal, paper, plastic, wood, proofing_paper

# Variant

name type required description example
brightness integer The brightness of the substrate as a percentage (>= 0). Some substrates have higher than 100 brightness value due to Optical Brightness Agent use.
category string The product category of the substrate. One of: (null), PS1 - Premium Coated, PS2 - Improved Coated, PS3 - Standard Coated Glossy, PS4 - Standard Coated Matte, PS5 - Wood-free Uncoated, PS6 - Super Calendered, PS7 - Improved Uncoated, PS8 - Standard Uncoated
color string The colour of the substrates surface
dimensions_unit string The unit used for dimensions (width / height) of the variant. One of: mm
form string DEPRECATED - form is deprecated, please use article base_unit to express how this product is quantified. If you're looking for rolls or envelopes, please check out the web_substrate or envelope types instead. One of: sheet
grain string Grain of the substrate. Please note that we validate width and height dimensions depending on grain: For long grain the width needs to be smaller or equal to the height. For short grain the width needs to be larger or equal to the height. One of: (null), long, short
height integer The height of the variant in millimeter (metric), with changes of the direction of rotation do not replace (!) with the variant's width
optical_brightness_agent boolean Flag indicating presence of Optical Brightness Agent (OBA)
optical_brightness_agent_amount string Amount of the OBA measured in Delta-B (dB)
paper_weight integer Paper weight of the substrate specified as grams per square meter (gsm) or lb (basis weight) depending on the paper_weight_unit.
paper_weight_unit string The unit in which the paper weight is defined. One of: (null), gsm, basis weight
roughness integer The roughness of the substrate in mL/min
thickness integer Thickness of the substrate in micrometer (metric)
transparency integer The transparency of the substrate as a percentage
unit_system string
white_point_m0 string White Point Lab M0 value 95,7/1,1/-4,3
white_point_m1 string White Point Lab M1 value 95,3/1,3/-5,5
whiteness integer The whiteness of the substrate as a percentage (values may be >100 for substrates with OBA added)
width integer The width of the substrate in the variants dimensions_unit

# Web substrate attributes

The following attributes are specific to just web_substrate products:

# Article

name type required description example
certifications array A list of certifications for this particular substrate
classification_reports array A list of reference reports, which could be related to the certifications
coated string Describes the sides on which the paper is coated. One of: (null), none, one side, both sides
finish string The type of surface finish of the substrate "matte", "painted", "glossy", "elephant skin"
kind string Type of the printable substrate. One of: (null), carton, cloth, foil, metal, paper, plastic, wood, proofing_paper

# Variant

name type required description example
brightness integer The brightness of the substrate as a percentage (values may be >100 for substrates with OBA added)
category string The product category of the substrate. One of: (null), PS1 - Premium Coated, PS2 - Improved Coated, PS3 - Standard Coated Glossy, PS4 - Standard Coated Matte, PS5 - Wood-free Uncoated, PS6 - Super Calendered, PS7 - Improved Uncoated, PS8 - Standard Uncoated
color string The color of the substrates surface
core_diameter string Diameter of the core of the roll of substrate 77.0
dimensions_unit string The unit used for dimensions (width / height) of the variant. One of: mm
length string Approximate length of the Substrate in dimensions_unit (mm). The length may vary due to moisture content and other environmental factors during production.
optical_brightness_agent boolean Flag indicating presence of Optical Brightness Agent (OBA)
optical_brightness_agent_amount string Amount of the optical brightness agent, measured in delta-b (dB)
paper_weight integer Paper weight of the substrate specified as grams per square meter (gsm) or lb (basis weight) depending on the paper_weight_unit.
paper_weight_unit string The unit in which the paper weight is defined. One of: (null), gsm, basis weight
roughness string The roughness of the substrate in mL/min
thickness string Thickness of the substrate in micrometer (metric)
transparency integer The transparency of the substrate as a percentage
white_point_m0 string White Point Lab M0 value 95,7/1,1/-4,3
white_point_m1 string White Point Lab M1 value 95,3/1,3/-5,5
whiteness integer The whiteness of the substrate as a percentage (values may be >100 for substrates with OBA added)
width string The width of the substrate in the variants dimensions_unit