API endpoints

Refrigerators with a direct sales function

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

Beverage coolers: arrow image

Path

/api/v1/refrigerators-direct-sales/beverage-coolers/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 for refrigerators with a direct sales function.

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" }

Beverage coolers: 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 appliance it doesn't have to be attached to the product, but it must still be easy to see. It must be at least 96mm x 192mm when printed.

Path

/api/v1/refrigerators-direct-sales/beverage-coolers/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 Energy efficiency class for beverage coolers.

Must be one of:
A
B
C
D
E
F
G
String
annualEnergyConsumption The annual electricity consumption in kWh in terms of final energy consumption per year. This may be up to 4 digits long. Integer
capacity The sum of the gross volumes, expressed in litres, of all compartments functioning at chilled operating temperature. This may be up to 4 digits long. Integer
compartmentTemp The highest average compartment temperature, expressed in degrees Celsius, of all compartments functioning at chilled operating temperature. This may be up to 2 digits long. Integer
maxAmbientTemp The maximum ambient temperature expressed in degrees Celsius. This may be up to 2 digits long. Integer
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", "efficiencyRating": "A", "annualEnergyConsumption": 1, "capacity": 1, "compartmentTemp": 1, "maxAmbientTemp": 1, "qrCodeUrl": "https://example.com" }

Ice cream freezers: arrow image

Path

/api/v1/refrigerators-direct-sales/ice-cream-freezers/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 for refrigerators with a direct sales function.

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" }

Ice cream freezers: 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 appliance it doesn't have to be attached to the product, but it must still be easy to see. It must be at least 96mm x 192mm when printed.

Path

/api/v1/refrigerators-direct-sales/ice-cream-freezers/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 Energy efficiency class for ice cream freezers.

Must be one of:
A
B
C
D
E
F
G
String
annualEnergyConsumption The annual electricity consumption in kWh in terms of final energy consumption per year. This may be up to 4 digits long. Integer
capacity The sum of the net volumes, expressed in litres, of all compartments functioning at frozen operating temperature. This may be up to 4 digits long. Integer
compartmentTemp The highest average compartment temperature, expressed in degrees Celsius, of all compartments functioning at frozen operating temperature. This may be up to 2 digits long. Integer
maxAmbientTemp The maximum ambient temperature expressed in degrees Celsius. This may be up to 2 digits long. Integer
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", "efficiencyRating": "A", "annualEnergyConsumption": 1, "capacity": 1, "compartmentTemp": 1, "maxAmbientTemp": 1, "qrCodeUrl": "https://example.com" }

Refrigerated vending machines: arrow image

Path

/api/v1/refrigerators-direct-sales/vending-machines/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 for refrigerators with a direct sales function.

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" }

Refrigerated vending machines: 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 appliance it doesn't have to be attached to the product, but it must still be easy to see. It must be at least 96mm x 192mm when printed.

Path

/api/v1/refrigerators-direct-sales/vending-machines/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 Energy efficiency class for refrigerated vending machines.

Must be one of:
A
B
C
D
E
F
G
String
annualEnergyConsumption The annual electricity consumption in kWh in terms of final energy consumption per year. This may be up to 4 digits long. Integer
fridgeCapacity The sum of the net volumes, expressed in litres, of all compartments functioning at chilled operating temperature. This may be up to 4 digits long. Integer
fridgeMaxTemp The maximum measured product temperature, expressed in degrees Celsius, of the compartment(s) with chilled operating temperatures. This may be up to 2 digits long. Integer
frozenCompartment Does this model have any compartments functioning at frozen operating temperature? Boolean
freezerMaxTemp The maximum measured product temperature, expressed in degrees Celsius, of the compartment(s) with frozen operating temperatures. Only required if frozenCompartment is true. This may be up to 2 digits long. Integer
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", "efficiencyRating": "A", "annualEnergyConsumption": 1, "fridgeCapacity": 1, "fridgeMaxTemp": 1, "frozenCompartment": true, "freezerMaxTemp": 1, "qrCodeUrl": "https://example.com" }

Supermarket refrigerator or freezer cabinets or gelato-scooping cabinets: arrow image

Path

/api/v1/refrigerators-direct-sales/display-cabinets/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 for refrigerators with a direct sales function.

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" }

Supermarket refrigerator or freezer cabinets or gelato-scooping cabinets: 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 appliance it doesn't have to be attached to the product, but it must still be easy to see. It must be at least 96mm x 192mm when printed.

Path

/api/v1/refrigerators-direct-sales/display-cabinets/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 Energy efficiency class for supermarket refrigerators, freezer cabinets or gelato-scooping cabinets.

Must be one of:
A
B
C
D
E
F
G
String
annualEnergyConsumption The annual electricity consumption in kWh in terms of final energy consumption per year. This may be up to 5 digits long. Integer
fridgeCompartment Does this model have any display areas functioning at chilled operating temperature? Boolean
fridgeCapacity The sum of the display areas, expressed in square metres, of all compartments functioning at chilled operating temperature. Only required if fridgeCompartment is true. This may be up to 4 digits long with an optional 2 decimal places. Number
fridgeMaxTemp The highest temperature, expressed in degrees Celsius, of the warmest M-package of the compartment(s) with chilled operating temperatures. Only required if fridgeCompartment is true. This may be up to 2 digits long. Integer
fridgeMinTemp The lowest temperature of the coldest M-package, or the highest minimum temperature of all M-packages, expressed in degrees Celsius of the compartment(s) with chilled operating temperatures. Only required if fridgeCompartment is true. This may be up to 2 digits long. Integer
frozenCompartment Does this model have any display areas functioning at frozen operating temperature? Boolean
freezerCapacity The sum of the display areas, expressed in square metres, of all display areas functioning at frozen operating temperature. Only required if frozenCompartment is true. This may be up to 4 digits long with an optional 2 decimal places. Number
freezerMaxTemp The highest temperature, expressed in degrees Celsius, of the warmest M-package of the compartment(s) with frozen operating temperatures. Only required if frozenCompartment is true. This may be up to 2 digits long. Integer
freezerMinTemp The lowest temperature of the coldest M-package, or the highest minimum temperature of all M-packages, expressed in degrees Celsius of the compartment(s) with frozen operating temperatures. Only required if frozenCompartment is true. This may be up to 2 digits long. Integer
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", "efficiencyRating": "A", "annualEnergyConsumption": 1, "fridgeCompartment": true, "fridgeCapacity": 1.1, "fridgeMaxTemp": 1, "fridgeMinTemp": 1, "frozenCompartment": true, "freezerCapacity": 1.1, "freezerMaxTemp": 1, "freezerMinTemp": 1, "qrCodeUrl": "https://example.com" }