Product Types

This page will give you an overview over all supported product types, their specific Article and Variant attributes, as well as the endpoints to work with those.

Support Product Types

Product Type	API Documentation (Suppliers)
Substrates	SubstrateArticles (opens new window) SubstrateVariants (opens new window)

Shared Attributes

This section lists all shared attributes which are available to all product types.

Article attributes

Attribute Name	Type	Required	Description	Example
name	String	✅	The name for the product	Generic Paper
description	String	❌	The products description	This is a generic paper for everyone
base_unit	String	✅	The base unit for the product. Can be one of: kg m piece sheet sqm	sqm
external_identifier	String	❌	Supplier internal identifier for an article. Will not be exposed.	ART-1234

Variant attributes

Attribute Name	Type	Required	Description	Example
external_identifier	String	❌	Supplier internal identifier for an article. Will not be exposed.	VAR-1234

Substrate product attributes

This section lists all additional attributes that are specific to Substrate products.

SubstrateArticle attributes

Attribute Name	Type	Required	Description	Example
kind	String	❌	The substrate's product kind. Can be one of: carton cloth foil metal paper plastic wood	paper
coated	String	✅	The substrate's product coating. Can be one of: none one side both sides	both sides

SubstrateVariant attributes

Attribute Name	Type	Required	Description	Example
width	Integer	✅	The substrate's product width	300
height	Integer	✅	The substrate's product height	300
thickness	Integer	✅	The substrate's product thickness	80
dimensions_unit	String	❌	The unit system to be used. Can only be mm	mm
paper_weight	Integer	✅	The substrate's product paper weight	80
paper_weight_unit	String	❌	The substrate's product paper weight unit. Can be one of: gsm basis weight	gsm
category	String	❌	The substrate's product category. Can be one of: 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	PS1 - Premium Coated
form	String	❌	The substrate's product form. Can be one of: envelope piece roll sheet	piece
grain	String	❌	The substrate's product grain. Can be one of: long short	short
transparency	Integer	❌	The substrate's product transparency. Needs to be between 0 and 100	100
whiteness	String	❌	The substrate's product whiteness. Needs to be between 0 and 100	100
brightness	String	❌	The substrate's product brightness. Needs to be between 0 and 100	100
roughness	String	❌	The substrate's product roughness. Needs to be between 0 and 100	100