/eprel/products/label

POST /api/eprel/products/label

Price: 20 credits

Resolve the EU energy label artwork for one registered model and return a direct, publicly fetchable link to it, together with the media type and byte size the registry served. Available as vector SVG, print-ready PDF, PNG and a small PNG preview. Both the registry-generated label and the artwork the supplier uploaded can be requested.

How to use it

The link is checked before it is returned: the registry builds an address for any input and its web server answers 200 with an HTML page when the file behind it does not exist, so an unresolvable label comes back as 412 here rather than as a link to a web page. Models registered with supplier artwork have no generated label at all — `has_generated_label` on the product record says which, and those need `supplier_label` set. Ask for SVG or PDF to reproduce the label at label size; THUMB_PNG is a preview only. The label is a picture, not data: the class letter and the measured values behind it are on the product record, and the wording of the accompanying information sheet is eprel/products/fiche.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product_group string required — Product group the registration number belongs to (one of: "airconditioners", "dishwashers", "dishwashers2019", "electronicdisplays", "hotwaterstoragetanks", "lamps", "lightsources", "localspaceheaters", "ovens", "professionalrefrigeratedstoragecabinets", "rangehoods", "refrigeratingappliances", "refrigeratingappliances2019", "refrigeratingappliancesdirectsalesfunction", "residentialventilationunits", "smartphonestablets20231669", "solidfuelboilerpackages", "solidfuelboilers", "spaceheaterpackages", "spaceheaters", "spaceheatersolardevice", "spaceheatertemperaturecontrol", "televisions", "tumbledriers", "tumbledryers20232534", "tyres", "washerdriers", "washerdriers2019", "washingmachines", "washingmachines2019", "waterheaterpackages", "waterheaters", "waterheatersolardevices"; examples: "refrigeratingappliances2019", "tyres")
• registration_number string required — EPREL registration number of the model (examples: "2836291", "2384029"; minLength: 1)
• artwork_format string — Artwork format to resolve. THUMB_PNG is the small preview the registry serves (default: "PDF"; one of: "SVG", "PDF", "PNG", "THUMB_PNG")
• supplier_label boolean — Ask for the artwork the supplier uploaded instead of the one the registry generates. Models whose record reports has_generated_label false only have an uploaded label (default: false)

Response

• @type string (default: "EprelDocument")
• id string required
• url string required
• product_id string required
• product_group string required
• document_type string required
• artwork_format string nullable
• language string nullable
• content_type string nullable
• size_bytes integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The model is not registered under that product group, or it has no label in the requested format — commonly a model whose supplier uploaded its own artwork. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.