API endpoints

Dishwashers

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

Dishwashers: arrow image

Path

/api/v1/dishwasher/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
labelColour The colour of the arrow image. Use a colour arrow if you can. You can use a black and white arrow if your material is being printed in black and white. You shouldn't use black and white arrows on the internet.

Must be one of:
COLOUR
BLACK_AND_WHITE
String
efficiencyRating Energy efficiency class indicator.

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

Example request body

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

Dishwashers: energy label

You must attach the label to the front or top of the product so that it’s easy to see. If it's a built-in dishwasher it doesn't have to be attached to the product, but it must still be easy to see. Labels must be at least 96mm x 192mm when printed.

Path

/api/v1/dishwasher/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
noiseEmissions Airborne acoustical noise emissions expressed in dB(A) re 1 pW. This may be up to 2 digits long. Integer
ecoCapacity Rated capacity (number of standard place settings) for the eco programme. This may be up to 2 digits long. Integer
energyConsumptionPer100Cycles Eco programme energy consumption (EPEC) in kWh per 100 cycles. This may be up to 3 digits long. Integer
waterConsumptionPerCycle Eco programme water consumption (EPWC) in litres per cycle. This may be up to 2 digits long with an optional 1 decimal place. Number
programmeDurationHours Enter a number of hours for the eco programme duration, up to 1 digit. If the eco programme duration is under 1 hour, enter 0. This may be up to 1 digit long. Integer
programmeDurationMinutes Enter a number of minutes for the eco programme duration, between 0 and 59. Integer
noiseEmissionsClass Airborne acoustic noise emission class.

Must be one of:
A
B
C
D
String
efficiencyRating Energy efficiency class indicator.

Must be one of:
A
B
C
D
E
F
G
String
qrCodeUrl Enter a link to the product information sheet. Links must start with http:// or https:// and contain at least one dot (.) character. String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "noiseEmissions": 1, "ecoCapacity": 1, "energyConsumptionPer100Cycles": 1, "waterConsumptionPerCycle": 1.1, "programmeDurationHours": 1, "programmeDurationMinutes": 1, "noiseEmissionsClass": "A", "efficiencyRating": "A", "qrCodeUrl": "https://example.com" }