API endpoints

Space heaters

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Boiler combination heater: arrow image

Path

/api/v1/space-heaters/boiler-combination-heaters/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Boiler combination heater: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/space-heaters/boiler-combination-heaters/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
declaredLoadProfile Declared load profile.

Must be one of:
3XS
XXS
XS
S
M
L
XL
XXL
String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String
waterHeatingEfficiencyRating The water heating energy efficiency class.

Must be one of:
A+
A
B
C
D
E
F
String
heatOutput The rated heat output in kW. This may be up to 2 digits long. Integer
soundPowerLevelIndoors Sound power level, indoors dB (optional), up to 2 digits long. Integer
offPeak Can the heater be set to work only during off-peak hours? Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "declaredLoadProfile": "3XS", "efficiencyRating": "A+++", "waterHeatingEfficiencyRating": "A+", "heatOutput": 1, "soundPowerLevelIndoors": 1, "offPeak": true }

Boiler space heater: arrow image

Path

/api/v1/space-heaters/boiler-space-heaters/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Boiler space heater: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/space-heaters/boiler-space-heaters/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String
heatOutput The rated heat output in kW. This may be up to 2 digits long. Integer
soundPowerLevelIndoors Sound power level, indoors dB. This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "heatOutput": 1, "soundPowerLevelIndoors": 1 }

Cogeneration space heaters: arrow image

Path

/api/v1/space-heaters/cogeneration-space-heaters/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Cogeneration space heaters: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/space-heaters/cogeneration-space-heaters/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String
heatOutput The rated heat output in kW. This may be up to 2 digits long. Integer
soundPowerLevelIndoors Sound power level, indoors dB. This may be up to 2 digits long. Integer
electricityGeneration Is there an additional electricity generation function? Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A+++", "heatOutput": 1, "soundPowerLevelIndoors": 1, "electricityGeneration": true }

Heat pump combination heaters: arrow image

Path

/api/v1/space-heaters/heat-pump-combination-heaters/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Heat pump combination heaters: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/space-heaters/heat-pump-combination-heaters/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
declaredLoadProfile Declared load profile.

Must be one of:
3XS
XXS
XS
S
M
L
XL
XXL
String
spaceHeatingEfficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String
waterHeatingEfficiencyRating The water heating energy efficiency class.

Must be one of:
A+
A
B
C
D
E
F
String
colderHeatOutput The total rated heat output in colder climate conditions. In kW, up to 2 digits long. This may be up to 2 digits long. Integer
averageHeatOutput The total rated heat output in average climate conditions. In kW, up to 2 digits long. This may be up to 2 digits long. Integer
warmerHeatOutput The total rated heat output in warmer climate conditions. In kW, up to 2 digits long. This may be up to 2 digits long. Integer
soundPowerLevelIndoors Sound power level, indoors dB (optional), up to 2 digits long. Integer
soundPowerLevelOutdoors Sound power level, outdoors dB. This may be up to 2 digits long. Integer
offPeak Can the heater be set to work only during off-peak hours? Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "declaredLoadProfile": "3XS", "spaceHeatingEfficiencyRating": "A+++", "waterHeatingEfficiencyRating": "A+", "colderHeatOutput": 1, "averageHeatOutput": 1, "warmerHeatOutput": 1, "soundPowerLevelIndoors": 1, "soundPowerLevelOutdoors": 1, "offPeak": true }

Heat pump space heaters (except low-temperature heat pumps): arrow image

Path

/api/v1/space-heaters/heat-pump-space-heaters/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Heat pump space heaters (except low-temperature heat pumps): energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/space-heaters/heat-pump-space-heaters/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
lowTempEfficiencyRating The seasonal space heating energy efficiency class under average climate conditions for low temperature.

Must be one of:
A+++
A++
A+
A
B
C
D
String
lowTempColderHeatOutput The total rated heat output for low temperature application, in colder climate conditions. In kW, up to 2 digits long. This may be up to 2 digits long. Integer
lowTempAverageHeatOutput The total rated heat output for low temperature application, in average climate conditions. In kW, up to 2 digits long. This may be up to 2 digits long. Integer
lowTempWarmerHeatOutput The total rated heat output for low temperature application, in warmer climate conditions. In kW, up to 2 digits long. This may be up to 2 digits long. Integer
soundPowerLevelIndoors Sound power level, indoors dB (optional), up to 2 digits long. Integer
soundPowerLevelOutdoors Sound power level, outdoors dB. This may be up to 2 digits long. Integer
mediumTempEfficiencyRating The seasonal space heating energy efficiency class under average climate conditions for medium temperature.

Must be one of:
A+++
A++
A+
A
B
C
D
String
mediumTempColderHeatOutput The total rated heat output for medium temperature application, in colder climate conditions. In kW. This may be up to 2 digits long. Integer
mediumTempAverageHeatOutput The total rated heat output for medium temperature application, in colder average climate conditions. In kW. This may be up to 2 digits long. Integer
mediumTempWarmerHeatOutput The total rated heat output for medium temperature application, in warmer climate conditions. In kW. This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "lowTempEfficiencyRating": "A+++", "lowTempColderHeatOutput": 1, "lowTempAverageHeatOutput": 1, "lowTempWarmerHeatOutput": 1, "soundPowerLevelIndoors": 1, "soundPowerLevelOutdoors": 1, "mediumTempEfficiencyRating": "A+++", "mediumTempColderHeatOutput": 1, "mediumTempAverageHeatOutput": 1, "mediumTempWarmerHeatOutput": 1 }

Low-temperature heat pump space heaters: arrow image

Path

/api/v1/space-heaters/low-temperature-heat-pump-space-heaters/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Low-temperature heat pump space heaters: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 105mm x 200mm when printed.

Path

/api/v1/space-heaters/low-temperature-heat-pump-space-heaters/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
lowTempEfficiencyRating The seasonal space heating energy efficiency class under average climate conditions for low temperature.

Must be one of:
A+++
A++
A+
A
B
C
D
String
lowTempColderHeatOutput The total rated heat output for low temperature application, in colder climate conditions. In kW, up to 2 digits long. This may be up to 2 digits long. Integer
lowTempAverageHeatOutput The total rated heat output for low temperature application, in average climate conditions. In kW, up to 2 digits long. This may be up to 2 digits long. Integer
lowTempWarmerHeatOutput The total rated heat output for low temperature application, in warmer climate conditions. In kW, up to 2 digits long. This may be up to 2 digits long. Integer
soundPowerLevelIndoors Sound power level, indoors dB (optional), up to 2 digits long. Integer
soundPowerLevelOutdoors Sound power level, outdoors dB. This may be up to 2 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "lowTempEfficiencyRating": "A+++", "lowTempColderHeatOutput": 1, "lowTempAverageHeatOutput": 1, "lowTempWarmerHeatOutput": 1, "soundPowerLevelIndoors": 1, "soundPowerLevelOutdoors": 1 }

Packages of combination heater, temperature control and solar device - Boiler: energy label calculator

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/space-heaters/package-combination-heater/calculate/boiler/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
preferentialHeaterHeatOutput Rated heat output (Prated) of the preferential heater (in kW). This may be up to 4 digits long. Integer
preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the preferential heater (in %). This may be up to 3 digits long. Integer
temperatureControl Does this package include a temperature control? Boolean
temperatureControlClass Temperature control class. Only required if temperatureControl is true.

Must be one of:
I
II
III
IV
V
VI
VII
VIII
String
supplementaryBoiler Does this package include a supplementary boiler? Boolean
supplementaryBoilerHeatOutput Rated heat output (Prated) of the supplementary boiler (in kW). Only required if supplementaryBoiler is true. This may be up to 4 digits long. Integer
supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of supplementary boiler (in %). Only required if supplementaryBoiler is true. This may be up to 3 digits long. Integer
solarCollectorSize Solar collector area (in m2). This may be up to 3 digits long. Integer
solarCollectorEfficiencyPercentage Solar collector efficiency (in %). This may be up to 3 digits long. Integer
storageTank Does this package include a hot water storage tank? Boolean
storageTankVolume Volume of the heat storage tank (in l). Only required if storageTank is true. This may be up to 4 digits long. Integer
storageTankRating Tank label class. Only required if storageTankRating is true.

Must be one of:
A+
A
B
C
D
E
F
G
String
spaceHeater Does this package include a supplementary space heater? Boolean
supplementaryHeatPump Does this package include a supplementary heat pump? Boolean
supplementaryHeatPumpHeatOutput Rated heat output (Prated) of the supplementary heat pump (in kW). Only required if supplementaryHeatPump is true. This may be up to 4 digits long. Integer
supplementaryHeatPumpSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the supplementary heat pump (in %). Only required if supplementaryHeatPump is true. This may be up to 3 digits long. Integer
waterHeatingEfficiencyPercentage Water heating energy efficiency of water heater (%). This may be up to 3 digits long. Integer
declaredLoadProfile Declared load profile.

Must be one of:
M
L
XL
XXL
String
annualNonSolarHeatContribution Annual non-solar heat contribution (kWh). This may be up to 4 digits long. Integer
auxElectricityConsumption Auxiliary electricity consumption (kWh). This may be up to 4 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "preferentialHeaterHeatOutput": 1, "preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage": 1, "temperatureControl": true, "temperatureControlClass": "I", "supplementaryBoiler": true, "supplementaryBoilerHeatOutput": 1, "supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage": 1, "solarCollectorSize": 1, "solarCollectorEfficiencyPercentage": 1, "storageTank": true, "storageTankVolume": 1, "storageTankRating": "A+", "spaceHeater": true, "supplementaryHeatPump": true, "supplementaryHeatPumpHeatOutput": 1, "supplementaryHeatPumpSeasonalSpaceHeatingEfficiencyPercentage": 1, "waterHeatingEfficiencyPercentage": 1, "declaredLoadProfile": "M", "annualNonSolarHeatContribution": 1, "auxElectricityConsumption": 1 }

Packages of combination heater, temperature control and solar device - Boiler: fiche

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/space-heaters/package-combination-heater/calculate/boiler/fiche

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
preferentialHeaterHeatOutput Rated heat output (Prated) of the preferential heater (in kW). This may be up to 4 digits long. Integer
preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the preferential heater (in %). This may be up to 3 digits long. Integer
temperatureControl Does this package include a temperature control? Boolean
temperatureControlClass Temperature control class. Only required if temperatureControl is true.

Must be one of:
I
II
III
IV
V
VI
VII
VIII
String
supplementaryBoiler Does this package include a supplementary boiler? Boolean
supplementaryBoilerHeatOutput Rated heat output (Prated) of the supplementary boiler (in kW). Only required if supplementaryBoiler is true. This may be up to 4 digits long. Integer
supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of supplementary boiler (in %). Only required if supplementaryBoiler is true. This may be up to 3 digits long. Integer
solarCollectorSize Solar collector area (in m2). This may be up to 3 digits long. Integer
solarCollectorEfficiencyPercentage Solar collector efficiency (in %). This may be up to 3 digits long. Integer
storageTank Does this package include a hot water storage tank? Boolean
storageTankVolume Volume of the heat storage tank (in l). Only required if storageTank is true. This may be up to 4 digits long. Integer
storageTankRating Tank label class. Only required if storageTankRating is true.

Must be one of:
A+
A
B
C
D
E
F
G
String
spaceHeater Does this package include a supplementary space heater? Boolean
supplementaryHeatPump Does this package include a supplementary heat pump? Boolean
supplementaryHeatPumpHeatOutput Rated heat output (Prated) of the supplementary heat pump (in kW). Only required if supplementaryHeatPump is true. This may be up to 4 digits long. Integer
supplementaryHeatPumpSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the supplementary heat pump (in %). Only required if supplementaryHeatPump is true. This may be up to 3 digits long. Integer
waterHeatingEfficiencyPercentage Water heating energy efficiency of water heater (%). This may be up to 3 digits long. Integer
declaredLoadProfile Declared load profile.

Must be one of:
M
L
XL
XXL
String
annualNonSolarHeatContribution Annual non-solar heat contribution (kWh). This may be up to 4 digits long. Integer
auxElectricityConsumption Auxiliary electricity consumption (kWh). This may be up to 4 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "preferentialHeaterHeatOutput": 1, "preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage": 1, "temperatureControl": true, "temperatureControlClass": "I", "supplementaryBoiler": true, "supplementaryBoilerHeatOutput": 1, "supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage": 1, "solarCollectorSize": 1, "solarCollectorEfficiencyPercentage": 1, "storageTank": true, "storageTankVolume": 1, "storageTankRating": "A+", "spaceHeater": true, "supplementaryHeatPump": true, "supplementaryHeatPumpHeatOutput": 1, "supplementaryHeatPumpSeasonalSpaceHeatingEfficiencyPercentage": 1, "waterHeatingEfficiencyPercentage": 1, "declaredLoadProfile": "M", "annualNonSolarHeatContribution": 1, "auxElectricityConsumption": 1 }

Packages of combination heater, temperature control and solar device - Heat pump: energy label calculator

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/space-heaters/package-combination-heater/calculate/heat-pump/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
preferentialHeaterHeatOutput Rated heat output (Prated) of the preferential heater (in kW). This may be up to 4 digits long. Integer
preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the preferential heater (in %). This may be up to 3 digits long. Integer
temperatureControl Does this package include a temperature control? Boolean
temperatureControlClass Temperature control class. Only required if temperatureControl is true.

Must be one of:
I
II
III
IV
V
VI
VII
VIII
String
supplementaryBoiler Does this package include a supplementary boiler? Boolean
supplementaryBoilerHeatOutput Rated heat output (Prated) of the supplementary boiler (in kW). Only required if supplementaryBoiler is true. This may be up to 4 digits long. Integer
supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of supplementary boiler (in %). Only required if supplementaryBoiler is true. This may be up to 3 digits long. Integer
solarCollectorSize Solar collector area (in m2). This may be up to 3 digits long. Integer
solarCollectorEfficiencyPercentage Solar collector efficiency (in %). This may be up to 3 digits long. Integer
storageTank Does this package include a hot water storage tank? Boolean
storageTankVolume Volume of the heat storage tank (in l). Only required if storageTank is true. This may be up to 4 digits long. Integer
storageTankRating Tank label class. Only required if storageTankRating is true.

Must be one of:
A+
A
B
C
D
E
F
G
String
spaceHeater Does this package include a supplementary space heater? Boolean
preferentialHeatPumpSeasonalSpaceHeatingEfficiencyColderPercentage Seasonal space heating energy efficiency of the heat pump in colder climate (in %). This may be up to 3 digits long. Integer
preferentialHeatPumpSeasonalSpaceHeatingEfficiencyWarmerPercentage Seasonal space heating energy efficiency of heat pump in warmer climate (in %). This may be up to 3 digits long. Integer
lowTemperatureHeatPump Is this a low temperature heat pump? Boolean
waterHeatingEfficiencyPercentage Water heating energy efficiency of water heater (%). This may be up to 3 digits long. Integer
declaredLoadProfile Declared load profile.

Must be one of:
M
L
XL
XXL
String
annualNonSolarHeatContribution Annual non-solar heat contribution (kWh). This may be up to 4 digits long. Integer
auxElectricityConsumption Auxiliary electricity consumption (kWh). This may be up to 4 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "preferentialHeaterHeatOutput": 1, "preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage": 1, "temperatureControl": true, "temperatureControlClass": "I", "supplementaryBoiler": true, "supplementaryBoilerHeatOutput": 1, "supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage": 1, "solarCollectorSize": 1, "solarCollectorEfficiencyPercentage": 1, "storageTank": true, "storageTankVolume": 1, "storageTankRating": "A+", "spaceHeater": true, "preferentialHeatPumpSeasonalSpaceHeatingEfficiencyColderPercentage": 1, "preferentialHeatPumpSeasonalSpaceHeatingEfficiencyWarmerPercentage": 1, "lowTemperatureHeatPump": true, "waterHeatingEfficiencyPercentage": 1, "declaredLoadProfile": "M", "annualNonSolarHeatContribution": 1, "auxElectricityConsumption": 1 }

Packages of combination heater, temperature control and solar device - Heat pump: fiche

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/space-heaters/package-combination-heater/calculate/heat-pump/fiche

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
preferentialHeaterHeatOutput Rated heat output (Prated) of the preferential heater (in kW). This may be up to 4 digits long. Integer
preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the preferential heater (in %). This may be up to 3 digits long. Integer
temperatureControl Does this package include a temperature control? Boolean
temperatureControlClass Temperature control class. Only required if temperatureControl is true.

Must be one of:
I
II
III
IV
V
VI
VII
VIII
String
supplementaryBoiler Does this package include a supplementary boiler? Boolean
supplementaryBoilerHeatOutput Rated heat output (Prated) of the supplementary boiler (in kW). Only required if supplementaryBoiler is true. This may be up to 4 digits long. Integer
supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of supplementary boiler (in %). Only required if supplementaryBoiler is true. This may be up to 3 digits long. Integer
solarCollectorSize Solar collector area (in m2). This may be up to 3 digits long. Integer
solarCollectorEfficiencyPercentage Solar collector efficiency (in %). This may be up to 3 digits long. Integer
storageTank Does this package include a hot water storage tank? Boolean
storageTankVolume Volume of the heat storage tank (in l). Only required if storageTank is true. This may be up to 4 digits long. Integer
storageTankRating Tank label class. Only required if storageTankRating is true.

Must be one of:
A+
A
B
C
D
E
F
G
String
spaceHeater Does this package include a supplementary space heater? Boolean
preferentialHeatPumpSeasonalSpaceHeatingEfficiencyColderPercentage Seasonal space heating energy efficiency of the heat pump in colder climate (in %). This may be up to 3 digits long. Integer
preferentialHeatPumpSeasonalSpaceHeatingEfficiencyWarmerPercentage Seasonal space heating energy efficiency of heat pump in warmer climate (in %). This may be up to 3 digits long. Integer
lowTemperatureHeatPump Is this a low temperature heat pump? Boolean
waterHeatingEfficiencyPercentage Water heating energy efficiency of water heater (%). This may be up to 3 digits long. Integer
declaredLoadProfile Declared load profile.

Must be one of:
M
L
XL
XXL
String
annualNonSolarHeatContribution Annual non-solar heat contribution (kWh). This may be up to 4 digits long. Integer
auxElectricityConsumption Auxiliary electricity consumption (kWh). This may be up to 4 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "preferentialHeaterHeatOutput": 1, "preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage": 1, "temperatureControl": true, "temperatureControlClass": "I", "supplementaryBoiler": true, "supplementaryBoilerHeatOutput": 1, "supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage": 1, "solarCollectorSize": 1, "solarCollectorEfficiencyPercentage": 1, "storageTank": true, "storageTankVolume": 1, "storageTankRating": "A+", "spaceHeater": true, "preferentialHeatPumpSeasonalSpaceHeatingEfficiencyColderPercentage": 1, "preferentialHeatPumpSeasonalSpaceHeatingEfficiencyWarmerPercentage": 1, "lowTemperatureHeatPump": true, "waterHeatingEfficiencyPercentage": 1, "declaredLoadProfile": "M", "annualNonSolarHeatContribution": 1, "auxElectricityConsumption": 1 }

Packages of combination heater, temperature control and solar device: arrow image

Path

/api/v1/space-heaters/package-combination-heater/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Packages of combination heater, temperature control and solar device: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 210mm x 297mm when printed.

Path

/api/v1/space-heaters/package-combination-heater/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
spaceHeaterEfficiencyRating The seasonal space heating energy efficiency class of the space heater.

Must be one of:
A+++
A++
A+
A
B
C
D
E
F
G
String
waterHeaterEfficiencyRating Water heating energy efficiency.

Must be one of:
A+++
A++
A+
A
B
C
D
E
F
G
String
heaterDeclaredLoadProfile Declared load profile of the space heater.

Must be one of:
3XS
XXS
XS
S
M
L
XL
XXL
String
solarCollector Does this package include a solar collector? Boolean
hotWaterStorageTank Does this package include a hot water storage tank? Boolean
temperatureControl Does this package include a temperature control? Boolean
spaceHeater Does this package include a supplementary space heater? Boolean
packageSpaceHeatingEfficiencyRating The seasonal space heating energy efficiency class of the package of combination heater, temperature control and solar device.

Must be one of:
A+++
A++
A+
A
B
C
D
E
F
G
String
packageWaterHeatingEfficiencyRating The water heating energy efficiency class of the package of combination heater, temperature control and solar device.

Must be one of:
A+++
A++
A+
A
B
C
D
E
F
G
String
packageDeclaredLoadProfile Declared load profile of the package.

Must be one of:
3XS
XXS
XS
S
M
L
XL
XXL
String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "spaceHeaterEfficiencyRating": "A+++", "waterHeaterEfficiencyRating": "A+++", "heaterDeclaredLoadProfile": "3XS", "solarCollector": true, "hotWaterStorageTank": true, "temperatureControl": true, "spaceHeater": true, "packageSpaceHeatingEfficiencyRating": "A+++", "packageWaterHeatingEfficiencyRating": "A+++", "packageDeclaredLoadProfile": "3XS" }

Packages of space heater, temperature control and solar device - Boiler: energy label calculator

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/space-heaters/package-space-heater/calculate/boiler/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
preferentialHeaterHeatOutput Rated heat output (Prated) of the preferential heater (in kW). This may be up to 4 digits long. Integer
preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the preferential heater (in %). This may be up to 3 digits long. Integer
temperatureControl Does this package include a temperature control? Boolean
temperatureControlClass Temperature control class. Only required if temperatureControl is true.

Must be one of:
I
II
III
IV
V
VI
VII
VIII
String
supplementaryBoiler Does this package include a supplementary boiler? Boolean
supplementaryBoilerHeatOutput Rated heat output (Prated) of the supplementary boiler (in kW). Only required if supplementaryBoiler is true. This may be up to 4 digits long. Integer
supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of supplementary boiler (in %). Only required if supplementaryBoiler is true. This may be up to 3 digits long. Integer
solarCollectorSize Solar collector area (in m2). This may be up to 3 digits long. Integer
solarCollectorEfficiencyPercentage Solar collector efficiency (in %). This may be up to 3 digits long. Integer
storageTank Does this package include a hot water storage tank? Boolean
storageTankVolume Volume of the heat storage tank (in l). Only required if storageTank is true. This may be up to 4 digits long. Integer
storageTankRating Tank label class. Only required if storageTankRating is true.

Must be one of:
A+
A
B
C
D
E
F
G
String
spaceHeater Does this package include a supplementary space heater? Boolean
supplementaryHeatPump Does this package include a supplementary heat pump? Boolean
supplementaryHeatPumpHeatOutput Rated heat output (Prated) of the supplementary heat pump (in kW). Only required if supplementaryHeatPump is true. This may be up to 4 digits long. Integer
supplementaryHeatPumpSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the supplementary heat pump (in %). Only required if supplementaryHeatPump is true. This may be up to 3 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "preferentialHeaterHeatOutput": 1, "preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage": 1, "temperatureControl": true, "temperatureControlClass": "I", "supplementaryBoiler": true, "supplementaryBoilerHeatOutput": 1, "supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage": 1, "solarCollectorSize": 1, "solarCollectorEfficiencyPercentage": 1, "storageTank": true, "storageTankVolume": 1, "storageTankRating": "A+", "spaceHeater": true, "supplementaryHeatPump": true, "supplementaryHeatPumpHeatOutput": 1, "supplementaryHeatPumpSeasonalSpaceHeatingEfficiencyPercentage": 1 }

Packages of space heater, temperature control and solar device - Boiler: fiche

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/space-heaters/package-space-heater/calculate/boiler/fiche

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
preferentialHeaterHeatOutput Rated heat output (Prated) of the preferential heater (in kW). This may be up to 4 digits long. Integer
preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the preferential heater (in %). This may be up to 3 digits long. Integer
temperatureControl Does this package include a temperature control? Boolean
temperatureControlClass Temperature control class. Only required if temperatureControl is true.

Must be one of:
I
II
III
IV
V
VI
VII
VIII
String
supplementaryBoiler Does this package include a supplementary boiler? Boolean
supplementaryBoilerHeatOutput Rated heat output (Prated) of the supplementary boiler (in kW). Only required if supplementaryBoiler is true. This may be up to 4 digits long. Integer
supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of supplementary boiler (in %). Only required if supplementaryBoiler is true. This may be up to 3 digits long. Integer
solarCollectorSize Solar collector area (in m2). This may be up to 3 digits long. Integer
solarCollectorEfficiencyPercentage Solar collector efficiency (in %). This may be up to 3 digits long. Integer
storageTank Does this package include a hot water storage tank? Boolean
storageTankVolume Volume of the heat storage tank (in l). Only required if storageTank is true. This may be up to 4 digits long. Integer
storageTankRating Tank label class. Only required if storageTankRating is true.

Must be one of:
A+
A
B
C
D
E
F
G
String
spaceHeater Does this package include a supplementary space heater? Boolean
supplementaryHeatPump Does this package include a supplementary heat pump? Boolean
supplementaryHeatPumpHeatOutput Rated heat output (Prated) of the supplementary heat pump (in kW). Only required if supplementaryHeatPump is true. This may be up to 4 digits long. Integer
supplementaryHeatPumpSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the supplementary heat pump (in %). Only required if supplementaryHeatPump is true. This may be up to 3 digits long. Integer

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "preferentialHeaterHeatOutput": 1, "preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage": 1, "temperatureControl": true, "temperatureControlClass": "I", "supplementaryBoiler": true, "supplementaryBoilerHeatOutput": 1, "supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage": 1, "solarCollectorSize": 1, "solarCollectorEfficiencyPercentage": 1, "storageTank": true, "storageTankVolume": 1, "storageTankRating": "A+", "spaceHeater": true, "supplementaryHeatPump": true, "supplementaryHeatPumpHeatOutput": 1, "supplementaryHeatPumpSeasonalSpaceHeatingEfficiencyPercentage": 1 }

Packages of space heater, temperature control and solar device - Cogeneration heater: energy label calculator

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/space-heaters/package-space-heater/calculate/cogeneration-heater/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
preferentialHeaterHeatOutput Rated heat output (Prated) of the preferential heater (in kW). This may be up to 4 digits long. Integer
preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the preferential heater (in %). This may be up to 3 digits long. Integer
temperatureControl Does this package include a temperature control? Boolean
temperatureControlClass Temperature control class. Only required if temperatureControl is true.

Must be one of:
I
II
III
IV
V
VI
VII
VIII
String
supplementaryBoiler Does this package include a supplementary boiler? Boolean
supplementaryBoilerHeatOutput Rated heat output (Prated) of the supplementary boiler (in kW). Only required if supplementaryBoiler is true. This may be up to 4 digits long. Integer
supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of supplementary boiler (in %). Only required if supplementaryBoiler is true. This may be up to 3 digits long. Integer
solarCollectorSize Solar collector area (in m2). This may be up to 3 digits long. Integer
solarCollectorEfficiencyPercentage Solar collector efficiency (in %). This may be up to 3 digits long. Integer
storageTank Does this package include a hot water storage tank? Boolean
storageTankVolume Volume of the heat storage tank (in l). Only required if storageTank is true. This may be up to 4 digits long. Integer
storageTankRating Tank label class. Only required if storageTankRating is true.

Must be one of:
A+
A
B
C
D
E
F
G
String
spaceHeater Does this package include a supplementary space heater? Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "preferentialHeaterHeatOutput": 1, "preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage": 1, "temperatureControl": true, "temperatureControlClass": "I", "supplementaryBoiler": true, "supplementaryBoilerHeatOutput": 1, "supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage": 1, "solarCollectorSize": 1, "solarCollectorEfficiencyPercentage": 1, "storageTank": true, "storageTankVolume": 1, "storageTankRating": "A+", "spaceHeater": true }

Packages of space heater, temperature control and solar device - Cogeneration heater: fiche

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/space-heaters/package-space-heater/calculate/cogeneration-heater/fiche

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
preferentialHeaterHeatOutput Rated heat output (Prated) of the preferential heater (in kW). This may be up to 4 digits long. Integer
preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the preferential heater (in %). This may be up to 3 digits long. Integer
temperatureControl Does this package include a temperature control? Boolean
temperatureControlClass Temperature control class. Only required if temperatureControl is true.

Must be one of:
I
II
III
IV
V
VI
VII
VIII
String
supplementaryBoiler Does this package include a supplementary boiler? Boolean
supplementaryBoilerHeatOutput Rated heat output (Prated) of the supplementary boiler (in kW). Only required if supplementaryBoiler is true. This may be up to 4 digits long. Integer
supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of supplementary boiler (in %). Only required if supplementaryBoiler is true. This may be up to 3 digits long. Integer
solarCollectorSize Solar collector area (in m2). This may be up to 3 digits long. Integer
solarCollectorEfficiencyPercentage Solar collector efficiency (in %). This may be up to 3 digits long. Integer
storageTank Does this package include a hot water storage tank? Boolean
storageTankVolume Volume of the heat storage tank (in l). Only required if storageTank is true. This may be up to 4 digits long. Integer
storageTankRating Tank label class. Only required if storageTankRating is true.

Must be one of:
A+
A
B
C
D
E
F
G
String
spaceHeater Does this package include a supplementary space heater? Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "preferentialHeaterHeatOutput": 1, "preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage": 1, "temperatureControl": true, "temperatureControlClass": "I", "supplementaryBoiler": true, "supplementaryBoilerHeatOutput": 1, "supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage": 1, "solarCollectorSize": 1, "solarCollectorEfficiencyPercentage": 1, "storageTank": true, "storageTankVolume": 1, "storageTankRating": "A+", "spaceHeater": true }

Packages of space heater, temperature control and solar device - Heat pump: energy label calculator

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/space-heaters/package-space-heater/calculate/heat-pump/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
preferentialHeaterHeatOutput Rated heat output (Prated) of the preferential heater (in kW). This may be up to 4 digits long. Integer
preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the preferential heater (in %). This may be up to 3 digits long. Integer
temperatureControl Does this package include a temperature control? Boolean
temperatureControlClass Temperature control class. Only required if temperatureControl is true.

Must be one of:
I
II
III
IV
V
VI
VII
VIII
String
supplementaryBoiler Does this package include a supplementary boiler? Boolean
supplementaryBoilerHeatOutput Rated heat output (Prated) of the supplementary boiler (in kW). Only required if supplementaryBoiler is true. This may be up to 4 digits long. Integer
supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of supplementary boiler (in %). Only required if supplementaryBoiler is true. This may be up to 3 digits long. Integer
solarCollectorSize Solar collector area (in m2). This may be up to 3 digits long. Integer
solarCollectorEfficiencyPercentage Solar collector efficiency (in %). This may be up to 3 digits long. Integer
storageTank Does this package include a hot water storage tank? Boolean
storageTankVolume Volume of the heat storage tank (in l). Only required if storageTank is true. This may be up to 4 digits long. Integer
storageTankRating Tank label class. Only required if storageTankRating is true.

Must be one of:
A+
A
B
C
D
E
F
G
String
spaceHeater Does this package include a supplementary space heater? Boolean
preferentialHeatPumpSeasonalSpaceHeatingEfficiencyColderPercentage Seasonal space heating energy efficiency of the heat pump in colder climate (in %). This may be up to 3 digits long. Integer
preferentialHeatPumpSeasonalSpaceHeatingEfficiencyWarmerPercentage Seasonal space heating energy efficiency of heat pump in warmer climate (in %). This may be up to 3 digits long. Integer
lowTemperatureHeatPump Is this a low temperature heat pump? Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "preferentialHeaterHeatOutput": 1, "preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage": 1, "temperatureControl": true, "temperatureControlClass": "I", "supplementaryBoiler": true, "supplementaryBoilerHeatOutput": 1, "supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage": 1, "solarCollectorSize": 1, "solarCollectorEfficiencyPercentage": 1, "storageTank": true, "storageTankVolume": 1, "storageTankRating": "A+", "spaceHeater": true, "preferentialHeatPumpSeasonalSpaceHeatingEfficiencyColderPercentage": 1, "preferentialHeatPumpSeasonalSpaceHeatingEfficiencyWarmerPercentage": 1, "lowTemperatureHeatPump": true }

Packages of space heater, temperature control and solar device - Heat pump: fiche

You're responsible for making sure the energy label and fiche are calculated accurately. You must check the label and fiche carefully before you provide them to your customers.

Path

/api/v1/space-heaters/package-space-heater/calculate/heat-pump/fiche

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
preferentialHeaterHeatOutput Rated heat output (Prated) of the preferential heater (in kW). This may be up to 4 digits long. Integer
preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of the preferential heater (in %). This may be up to 3 digits long. Integer
temperatureControl Does this package include a temperature control? Boolean
temperatureControlClass Temperature control class. Only required if temperatureControl is true.

Must be one of:
I
II
III
IV
V
VI
VII
VIII
String
supplementaryBoiler Does this package include a supplementary boiler? Boolean
supplementaryBoilerHeatOutput Rated heat output (Prated) of the supplementary boiler (in kW). Only required if supplementaryBoiler is true. This may be up to 4 digits long. Integer
supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage Seasonal space heating energy efficiency of supplementary boiler (in %). Only required if supplementaryBoiler is true. This may be up to 3 digits long. Integer
solarCollectorSize Solar collector area (in m2). This may be up to 3 digits long. Integer
solarCollectorEfficiencyPercentage Solar collector efficiency (in %). This may be up to 3 digits long. Integer
storageTank Does this package include a hot water storage tank? Boolean
storageTankVolume Volume of the heat storage tank (in l). Only required if storageTank is true. This may be up to 4 digits long. Integer
storageTankRating Tank label class. Only required if storageTankRating is true.

Must be one of:
A+
A
B
C
D
E
F
G
String
spaceHeater Does this package include a supplementary space heater? Boolean
preferentialHeatPumpSeasonalSpaceHeatingEfficiencyColderPercentage Seasonal space heating energy efficiency of the heat pump in colder climate (in %). This may be up to 3 digits long. Integer
preferentialHeatPumpSeasonalSpaceHeatingEfficiencyWarmerPercentage Seasonal space heating energy efficiency of heat pump in warmer climate (in %). This may be up to 3 digits long. Integer
lowTemperatureHeatPump Is this a low temperature heat pump? Boolean

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "preferentialHeaterHeatOutput": 1, "preferentialHeaterSeasonalSpaceHeatingEfficiencyPercentage": 1, "temperatureControl": true, "temperatureControlClass": "I", "supplementaryBoiler": true, "supplementaryBoilerHeatOutput": 1, "supplementaryBoilerSeasonalSpaceHeatingEfficiencyPercentage": 1, "solarCollectorSize": 1, "solarCollectorEfficiencyPercentage": 1, "storageTank": true, "storageTankVolume": 1, "storageTankRating": "A+", "spaceHeater": true, "preferentialHeatPumpSeasonalSpaceHeatingEfficiencyColderPercentage": 1, "preferentialHeatPumpSeasonalSpaceHeatingEfficiencyWarmerPercentage": 1, "lowTemperatureHeatPump": true }

Packages of space heater, temperature control and solar device: arrow image

Path

/api/v1/space-heaters/package-space-heater/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
productPriceHeightPx Enter height of the product's price (in pixels). This may be up to 3 digits long. Integer
labelOrientation Arrow direction.

Must be one of:
LEFT
RIGHT
String
labelFormat Image format.

Must be one of:
JPEG
PNG
String
efficiencyRating The seasonal space heating energy efficiency class.

Must be one of:
A+++
A++
A+
A
B
C
D
String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A+++" }

Packages of space heater, temperature control and solar device: energy label

You must display the label at the point of sale so that it’s easy to see and clearly related to the product. It must be at least 210mm x 297mm when printed.

Path

/api/v1/space-heaters/package-space-heater/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property Description Type
outputFormat Format of the generated label. Optional, defaults to PDF if not set.

Must be one of:
PDF
PNG
JPEG
String
supplierName Supplier's name or trade mark. String
modelName Supplier's model identification code. String
heaterEfficiencyRating The seasonal space heating energy efficiency class of the space heater.

Must be one of:
A+++
A++
A+
A
B
C
D
E
F
G
String
solarCollector Does this package include a solar collector? Boolean
hotWaterStorageTank Does this package include a hot water storage tank? Boolean
temperatureControl Does this package include a temperature control? Boolean
spaceHeater Does this package include a supplementary space heater? Boolean
packageEfficiencyRating The seasonal space heating energy efficiency class of the package of space heater, temperature control and solar device.

Must be one of:
A+++
A++
A+
A
B
C
D
E
F
G
String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "heaterEfficiencyRating": "A+++", "solarCollector": true, "hotWaterStorageTank": true, "temperatureControl": true, "spaceHeater": true, "packageEfficiencyRating": "A+++" }