Skip to main content
POST
/
french-label
/
image
Get French Eco Score SVG Labels
curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/french-label/image \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "productIds": [
    "<string>"
  ]
}
'
[
  {
    "productId": "<string>",
    "svg": "<string>",
    "error": "<string>",
    "code": 123
  }
]

Documentation Index

Fetch the complete documentation index at: https://developer.worldly.io/llms.txt

Use this file to discover all available pages before exploring further.

Returns official Ecobalyse SVG labels for one or more products in your library. Use this endpoint to retrieve the visual French Eco-Score (Environmental Cost) for display on product pages or packaging.
Specify an array of up to 50 product IDs to retrieve labels in a single request.

​
Request body properties

NameTypeDescription
productIdsArray<string>[REQUIRED] The list of Worldly product IDs for which you want to generate labels.

​
Implementation details

  • Batch limit: You can request labels for a maximum of 50 products per request.
  • Error isolation: The endpoint uses per-product error isolation. If one product fails to generate a label (e.g., due to missing mandatory French Eco-Score data), the response still contains labels for the successful products.
  • SVG output: The svg property in the response contains the raw SVG string. You can render this string directly in a browser or save it as a file.

​
Response body properties

NameTypeDescription
productIdstring[REQUIRED] The ID of the product.
codenumberThe calculated French Eco-Score value. null when label generation fails.
errorstringA description of the error if the label could not be generated for this product.
svgstringThe raw SVG data for the label. null when label generation fails.

PIC - Retrieve French Eco-Score

PIC - Update Product with French Eco-Score requirements

PIC - Create Product with French Eco-Score Optional Fields

Check the PIC Data Dictionary for more information on French Eco-Score fields.

Authorizations

​
x-api-key
string
header
required
​
x-developer-request-token
string
header
required

Body

application/json
​
productIds
string[]
required

Response

200 - application/json

Ok

​
productId
string
required
​
svg
string | null
​
error
string | null
​
code
number<double> | null