Entity: Label - LabelHub/labelhub.integration.documentation GitHub Wiki
Name | Type | Required | Default | Notes |
---|---|---|---|---|
labelHubId | long | Internal LabelHubID. Primarily used for export from LabelHub | ||
brandOwnerNo | string | Yes | Foreign key to the BrandOwner who owns the label | |
labelNoManufacturer | string | Yes | The labelnumber for the manufacturer. Usually the primary product/article number from ERP/MIS | |
labelNoBrandOwner | string | The labelnumber used by the brandowner. Optional but highly recommended for usability! | ||
description | string | Yes | ||
shape | enum | special |
The shape of the label. Options: square , round , oval or special
|
|
width | decimal | Yes | Width of the label (see notes on size) | |
height | decimal | Yes | Height of the label (see notes on size) | |
cornerRadius | decimal | 0 | The radius of the corners of the label | |
labelsAcross | integer | 0 | Number of labels side-by-side on the final roll/sheet (not on the die!). Usually 1
|
|
labelsForward | integer | 0 | Number of labels forward on the final roll/sheet (not on the die!). Often 1000
|
|
dieNo | string | Yes | Foreign key for die | |
directionNo | string | Yes | Foreign key for how the labels are finished. Usually between 1 -8 or sheet or fanfold , but LabelHub is usually setup to "know" the different finishing/direction keys used by the manufacturer |
|
materialNo1 | string | (none) | Foreign key for material | |
materialNo2 | string | Foreign key for material. Note: Currently not imported! | ||
materialNo3 | string | Foreign key for material. Note: Currently not imported! | ||
lacquerNo | string | (none) | Foreign key for the lacquer(varnish) | |
coreNo | string | (none) | Foreign key for the core used on the final product. This usually coresponds to the diameter of the rollcore, eg. 76
|
|
deleted | boolean | false |
Option to mark a label as deleted. Set to true to mark it as deleted or leave empty or set to false to mark it as active |
|
printMethod | enum | digital |
The printmethod this die is intended for. Values: digital or flexo
|
|
stockQuantity | integer | Amount of stock of this label stored at manufacturer. | ||
notesInternal | string | Notes on this label only visible to the manufacturer | ||
notesExternal | string | Notes on this label primarily visible to the brandowner (manufacturer can see it aswell) | ||
dispenser | boolean | false |
Should the labels be delivered in a dispenser? | |
maxRollDiameter | integer | undefined | Set this if there is a limit to the final size of a finished roll. Undefined = no limit |
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<label version="6">
<brandOwnerNo>cust123</brandOwnerNo>
<labelNoManufacturer>lbl123</labelNoManufacturer>
<labelNoBrandOwner>brandlbl456</labelNoBrandOwner>
<description>Tanzania Coffee</description>
<shape>Special</shape>
<width>117.5</width>
<height>186</height>
<cornerRadius>2</cornerRadius>
<directionNo>8</directionNo>
<labelsAcross>1</labelsAcross>
<labelsForward>1000</labelsForward>
<dieNo>die123</dieNo>
<materialNo1>mat123</materialNo1>
<materialNo2/>
<materialNo3/>
<lacquerNo/>
<coreNo>76</coreNo>
<deleted>false</deleted>
<printMethod>Digital</printMethod>
<stockQuantity>0</stockQuantity>
<notesInternal>Notes only for manufacturer</notesInternal>
<notesExternal>Notes seen by manufacturer and customer</notesExternal>
</label>
In the future it will be possible to load multiple materials on one label inside LabelHub. This is why label-v6 has multiple material-fields, but only one is currently loaded. If material2
and material3
are populated they will be imported later on when the multi-material option is available inside LabelHub.
As described on the lacquer details page LabelHub is currently transitioning from using the term "lacquer" to the correct term "varnish". As of now the fields are still named lacquer
in the integrations, but will be displayed as varnish
inside LabelHub. In a later revision of the integration this will be corrected.