V1 Data models


The data models for the NOBB Connect Supplier API use the same entity and attribute names as are used in other NOBB-related services. Hence, they should be familiar to users of the NOBB database.


Module

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

active

Boolean







brand

String

Brand used for items in this module. This is the


Yes

SYS 840

valid based on the reference list (name from the entry)


corporateBrand

String



Yes

WEBER

valid based on the reference list (name from the entry)


description

String




En klar luktfri olje for behandling av uglaserte fliser og klinker

String
Regexp pattern:
^[0-9a-zA-ZÆØÅæøå][a-zA-Z0-9!:="%&´()?,-.<>°+/ÆØÅæøå\s]*$

800

etimClass

String

Etim Class for the module.  If empty, it will be inherited from the productGroup. If not empty, must be one of the available classes from the productGroup.



EC00503

Valid based on available etim classes for product group


expiryDate

date

NOT IN USE - will always be NULL






internalid

String

The customer's internal module id 


Yes

ABC123

String
Regexp pattern:
^[a-zA-Z0-9!:="%&´()?,-.<>°+/ÆØÅæøå\s]*$

8

manufacturer 

String

Name of the manufacturer


Yes

Alkobel

valid based on the reference list (name from the entry)


number

Integer

NOBB Module number. Used as key in GET/PUT



44445555

Valid type


productGroupNumber

string

NOBB Varegruppe


Yes

1234567

Valid product group


text

String



Yes

WEBER SYS 840 KLINKEROLJE

String
Regexp pattern:
^[0-9a-zA-ZÆØÅæøå][a-zA-Z0-9!:="%&´()?,-.<>°+/ÆØÅæøå\s]*$

35


Item

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

bundleItems

array of objects

Items belonging to the display or composite. Only used for Display and Composite items. 






countryOfOrigin

string

Two character ISO code for country of origin



no

Valid based on the reference list (“countries”)


currentVolumeFactor

decimal





Not more than 6 digit precision


customsEuCode

string

EU Custom code



2999

String

15

customsNoCode

string

NO Custom code



1999

String

15

dangerousGoods

object

Dangerous goods information for the item.






description

string




Natre Fastkarm - isolerer bedre..

String
Regexp pattern:
^[a-zA-Z0-9!:="%&´()?,-.<>°+/ÆØÅæøåÖöÜüÄäÉéÈèÀàÔô'\s]*$

800

digitalChannelText

string





String
Regexp pattern:
^[a-zA-Z0-9!:="%&´()?,-.<>°+/ÆØÅæøåÖöÜüÄäÉéÈèÀàÔô'\s]*$

60

environmentLabels

array of string

Environmental labels for the item



Blomst, Svane, NAAF, FSC, PEFC

Valid based on the reference list (name from the entry)


epd

object

EPD related information for the item.






etimFeatures

array of objects







expiryDate

date

expiryDate for the item. NOTE: When expiring an item, there is no need to send the item to approval.




Valid type


finfoNumber

string





String

14

firstTimeApproved

date

Date for first-time approval of the item

Yes



Valid type


freightGroup

string





String

20

hasDurabilityDate

boolean



Yes


Valid type


hazardLabels

array of integers

Number(s) for the hazard labels, based on the labels table.



1,5

Valid based on the reference list (code from the entry)


internalid

string

The customer’s internal id on the item. In other systems, this is referred to as the supplier’s item number.


Yes


String
Regexp pattern:
^[a-zA-Z0-9!:="%&´()?,-_.<>°+/ÆØÅæøå\s]*$

20

launchDate

date





Valid type


manufacturerItemNumber

string



Yes


String
Regexp pattern:
^[a-zA-Z0-9!:="%&´()?,-_.<>°+/ÆØÅæøå\s]*$

20

modelName

string





String

35

moduleNumber

integer



Yes


Valid type


nobbNumber

integer


Yes

Yes

55556666

Valid type


nominalVolumeFactor

decimal





Not more than 6 digit precision


nrfInfo

object







priceComparisonFactor

object







priceUnit

string



Yes


Valid based on the reference list (code from the entry)


primaryText

string



Yes


String
Regexp pattern:
^[a-zA-ZÆØÅæøå][a-zA-Z0-9!:="%&´'()?,-.<>°+/ÆØÅæøåÖöÜüÄä\s]*$

35

replacesNobbNumber

integer





Valid type


secondaryText

string





String
Regexp pattern:
^[a-zA-Z0-9!:="%&´'()?,-.<>°+/ÆØÅæøåÖöÜüÄä\s]*$

35

seriesName

string





String

35

tax

string





Valid based on the reference list (code from the entry)


toleratesFrost

boolean





Valid type


tunNumber

string





String

14

type

string

"Standard","Display", "Composite" or "Special". NOTE: Not part of the UPDATE method, it can only be set on create.


Yes


Valid based on defined list


uniqueSellingPoint1

string

Unique selling point 1




String

45

uniqueSellingPoint2

string

Unique selling point 2




String

45

uniqueSellingPoint3

string

Unique selling point 3




String

45

uniqueSellingPoint4

string

Unique selling point 4




String

45

uniqueSellingPoint5

string

Unique selling point 5




String

45

videos

array of objects







Item.dangerousGoods

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

adrName

string

Item name as shown on the ADR label. Can be added when danger class an UN number is registered.




String

100

classes

array of objects

Danger class information. Note: This is an array, but we will only allow one value in the array now. 






number

integer

4 digit UN number for the item




Valid type


packagingGroup

integer

1 = Meget farlig
2 = Middels farlig
3 = Mindre farlig



1, 2 or 3

Valid based on defined list



Item.dangerousGoods.class

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

class

string

Identifier for the danger class.



5.1

Valid based on reference list (code from the entry)


className

string

Name of the danger class. Only available in the Read model

Yes


Oxidizing substances




Item.epd

Attribute

Type

Description

Read only?

Required?

Example value

Validation rule

String max length

epdId

string

Unique identifier of the EPD the item is relevant for, as defined in the Byggtjeneste EPD registry



NEPD-001


32

calculationFactor

decimal

Calculation factur between the EPD’s declared/functional unit and the item’s price unit in NOBB.




6 digit number


Item.etimFeature

Attribute

Type

Description

Read only?

Required?

Example value

Validation rule

String max length

code

string

Etim code for the feature



EF000008 

"EF" + integer


value

string

Value for the feature. 

For alpha numeric values, this should be the EV code in the write model and will be the Norwegian text in the read model.






valueCode

string

ETIM value code (EV??????) for the value. Note: Only available in the read model. In the write model, use the value attribute.

Yes





secondaryValue

string

Secondary value for the feature, for etimfeatures of type Range. Upper value for the range.






Item.nrfInfo

Attribute

Type

Description

Read only?

Required?

Example value

Validation rule

String max length

additionalText

string







dimension

string






40

name

string



Yes



name+dimension: max 60

number

integer





7 digit number


productGroupNumber

string

NRF item group number


Yes


7 digit number


supplierNumber

integer

NRF Supplier number


Yes


5 digit number


Item.priceComparisonFactor

Attribute

Type

Description

Read only?

Required?

Example value

Validation rule

String max length

unit

string

The unit for the price comparison.




Valid based on the unit reference list (code from the entry).

Must be one of the product group’s PCUs


factor

decimal

The actual price comparison factor





40

notRelevant

boolean





Valid type


Item.video

Attribute

Type

Description

Read only?

Required?

Example value

Validation rule

String max length

type

string

“youtube” or “viemo”


Yes

youtube



code

string

Youtube/Vimeo id of the video


Yes

JMOOG7rWTPg



description

string

Description of the video






Package

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

availableFrom

date





Valid type


availableTo

date





Valid type


calculatedCount

decimal

The calculated number of price units for this package

Yes





class

string

F-PAK, T-PAK, D-PAK, or UDEF


Yes

F-PAK

valid based on the reference list (code from the entry)


consistsOfCount

decimal



Yes


Not more than 6 digit precision


consistsOfUnit

string

Can only be set in Create. Not possible to update.


Yes


valid based on the reference list (code from the entry)


deliverable

boolean



Yes


Valid type


dPakLayerCount

integer

Only relevant for "T-PAK"




Valid type


gtin

string

GTIN number




String

14

height

integer

Height in millimetres




Valid type


length

integer

Length in millimetres




Valid type


maxStackingWeight

decimal

Only relevant for "T-PAK"




Not more than 3 digit precision


minOrderQuantity

integer

Only relevant for "F-PAK"




Valid type


nobbNumber

integer



Yes




packageId

string

Unique ID for the package

Yes


Auto-generated by NOBB Supplier



stocked

boolean



Yes


Valid type


unit

string



Yes


valid based on the reference list (code from the entry)


volume

decimal

Volume in m3




Not more than 6 digit precision
Max volume: 30


weight

decimal

Weight in kg




Not more than 3 digit precision.
Max weight: 20 000


width

integer

Width in millimetres




Valid type



Price

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

fromDate

string



Yes


Valid type


nobbNumber

integer



Yes




price

decimal



Yes


Not more than 2 digit precision


toDate

string

Only available for published prices.

Yes





status

string

Status of the price. 

Yes






Image

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

imageType

string

Type for the image, from a predefined list of image types


Yes

PB

Valid based on the reference list (code from the entry)


imageSide

string

Side for the image, from a predefined list of image sides. Note: Use the code based on the reference data list



3

Valid based on the reference list (code from the entry)


imageAngle

string

Angle for the image, from a predefined list of image angles. Note: Use the code based on the reference data list



L

Valid based on the reference list (code from the entry)


validFrom

date

NOT IN USE - will always be NULL






validTo

date

NOT IN USE - will always be NULL






comment

string

NOT IN USE - will always be NULL






imageNumber

string

Unique ID for the image

Yes





technicalQuality

string

Technical quality for the image

Yes





fileName

string

Filename for the file

Yes






Document

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

documentType

object







validFrom

date

NOT IN USE - will always be NULL






validTo

date

NOT IN USE - will always be NULL






language

string

NOT IN USE - will always be null






comment

string

NOT IN USE - will always be NULL






documentNumber

string

Unique ID for the document

Yes






Document.documentType

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

code

string

Abbreviation for the document type



A20-2012

Valid based on the reference list (code from the entry)


name

string

Name of the document type

Yes


A20 egenerklæring 2012, BREEAM-NOR




Common (status)

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

issues

object

List of issues for the entity

Yes





status

string

Status of the entity. See below for information on the different statuses

Yes





latestComment

string

Latest comment from NOBB Admin related to approval/rejection of the item

Yes






Common (status.issues)

Attribute

Type

Description

Read-only?

Required?

Example value

Validation rule

String max length

comment

string

NOT IN USE - will always be NULL






issue 

string

Id for the issue







Status of an entity

An entity can have the following statuses:

Status

Value

Description

1

Avventer godkjenning

After a newly created entity has been sent for approval, waiting for approval by Byggtjeneste

2

Endret, ikke sendt

Changed after initial approval, not sent for new approval

3

Godkjent

Approved by Byggtjeneste

4

Underkjent

Entity rejected in approval process