Products API Nomenclatures

Some of the data that the Products API works with is predefined – an error will be returned if the entered data deviates from the options described on this page. Here you will find the different product and data types, country-specific operators, countries and languages that the Products API works with.

Products can be differentiated according to their use – regular, project-specific or configured for a particular building. With this in mind, the Products API has three specific product types:
SpecificType (parameter) Description
Regular Any product that is manufactured and is a part of a manufacturer’s product catalogue.
ProductLine A product line is a summarized description of two or more products that have the same construction object type and share common characteristics. They can be used to organize products in groups, where the parent level (product line) describes the characteristics common for the group, and the child level (regular product) describes a particular variation of what can be manufactured.
Private Products that are configured for a particular building and are not a part of the manufacturer’s regular catalogue. This type of product can only be created and used through the Products API and does not show in the regular goBIM product catalogue.
In each country there are multiple databases for construction products. In each of these the product receives its own unique reference number. Depending on the country of distribution that a product has, there might be additional reference numbers or identifiers that may need to be added in the product’s digital passport.
Country of distribution Name (parameter) Description
Norway Nobbnr A product’s reference number for the NOBB database
Elnr A product’s reference number for the EL database
Nrfnr A product’s reference number for the NRF database

In order for us to make the products’ digital passport machine readable and the information easily exportable in different formats, we have different data types, depending on the type of information that the particular product characteristic bears.

Even though the data type of the property is not required when sending the request for creating properties, the value will be validated according to the property’s data type. If the value’s format is not the same as the data type, required by the property, an error will be returned and the value will not be created.

The possible data types are:

Datatype (parameter) Data type description
string String - ex. "Hello world!"
int Integer - ex. "3"
float Float number - ex. "3.14"
bool Boolean - ex. "true"
date Date (The only accepted format is the ISO 8601 f.ex. 2020-12-31)
link Link - ex. ""
email Email - ex. ""

In order to create a range value for a property, one needs to use operators for specifying the exact range.

The possible operators are:

Operator (parameter) Value operator
eq Equal to (=)
lt Less than (<)
lte Less than or equal to (<=)
gt Greater than (>)
gte Greater than or equal to (>=)
Here’s a list of the countries of distribution that the Products API supports. The supported country format is the ISO 3166 Аlpha-2 code format.
Country (parameter) Country
BE Belgium
BG Bulgaria
CN China
HR Croatia
CZ Czech Republic
DK Denmark
EE Estonia
FI Finland
FR France
DE Germany
HU Hungary
IT Italy
LV Latvia
LT Lithuania
LU Luxembourg
NL The Netherlands
NO Norway
PL Poland
PT Portugal
ES Spain
SE Sweden
CH Switzerland
TR Turkey
GB United Kingdom
Here are the supported cultures and the codes that represent them in the Products API contracts:
Culture (parameter) Culture name
bg-BG Bulgarian
cs-CZ Czech
da-DK Danish
nl-BE Dutch (Belgium)
nl-NL Dutch (Netherlands)
en-GB English (United Kingdom)
fi-FI Finnish
fr-BE French (Belgium)
fr-FR French (France)
de-DE German
el-GR Greek
hu-HU Hungarian
it-IT Italian
is-IS Islandic
nb-NO Norwegian (Bokmål)
pl-PL Polish
ro-RO Romanian
ru-RU Russian
sr-Latn Serbian
es-ES Spanish
sv-SE Swedish
When creating a product asset (a document, photo or BIM object) through the Products API, you need to also provide information about the type of asset you are creating.
Document type (parameter) Document type name
Warranty Warranty
ProductPhoto Product Photo
OperatingInstructions Operating Instructions
Brochure Brochure
DeclarationOfPerformance Declaration Of Performance
FireSafetyData Fire Safety Data
EnvironmentalInformation Environmental Information
FMdocumentation FM Documentation
PriceList Price List
AssemblyInstructions Assembly Instructions
TechnicalDatasheet Technical Datasheet
ProductCertification Product Certification
InformationSheet Information Sheet
BIMObject BIM Object
Just like the products, the documents which describe them can be active or no longer applicable/ not in use. Here are the statuses which can be used when working with the documents endpoints:
Document status (parameter) Description
Active Documents which is actively in use
Expired Expired documents are documents which are no longer in use or are past their expiration date (f.ex. expired certificates)
All Both active and expired documents