Get labels for French Eco-Scores

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

import requests

url = "https://api-v2.production.higg.org/pic-api/v1/french-label/image"

payload = { "productIds": ["<string>"] }
headers = {
    "x-api-key": "<api-key>",
    "x-developer-request-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-developer-request-token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({productIds: ['<string>']})
};

fetch('https://api-v2.production.higg.org/pic-api/v1/french-label/image', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.production.higg.org/pic-api/v1/french-label/image",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'productIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-developer-request-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-v2.production.higg.org/pic-api/v1/french-label/image"

	payload := strings.NewReader("{\n  \"productIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-developer-request-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-v2.production.higg.org/pic-api/v1/french-label/image")
  .header("x-api-key", "<api-key>")
  .header("x-developer-request-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.production.higg.org/pic-api/v1/french-label/image")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-developer-request-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"productIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "productId": "<string>",
    "svg": "<string>",
    "error": "<string>",
    "code": 123
  }
]

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

import requests

url = "https://api-v2.production.higg.org/pic-api/v1/french-label/image"

payload = { "productIds": ["<string>"] }
headers = {
    "x-api-key": "<api-key>",
    "x-developer-request-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'x-developer-request-token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({productIds: ['<string>']})
};

fetch('https://api-v2.production.higg.org/pic-api/v1/french-label/image', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.production.higg.org/pic-api/v1/french-label/image",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'productIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-developer-request-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-v2.production.higg.org/pic-api/v1/french-label/image"

	payload := strings.NewReader("{\n  \"productIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-developer-request-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-v2.production.higg.org/pic-api/v1/french-label/image")
  .header("x-api-key", "<api-key>")
  .header("x-developer-request-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.production.higg.org/pic-api/v1/french-label/image")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-developer-request-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"productIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "productId": "<string>",
    "svg": "<string>",
    "error": "<string>",
    "code": 123
  }
]

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

Name	Type	Description
`productIds`	`Array<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

Name	Type	Description
`productId`	`string`	[REQUIRED] The ID of the product.
`code`	`number`	The calculated French Eco-Score value. `null` when label generation fails.
`error`	`string`	A description of the error if the label could not be generated for this product.
`svg`	`string`	The 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

productId

string

required

svg

string | null

error

string | null

code

number<double> | null

Assessments

PIC API

Product Tools

Request body properties

Implementation details

Response body properties

PIC - Retrieve French Eco-Score

PIC - Update Product with French Eco-Score requirements

PIC - Create Product with French Eco-Score Optional Fields

Authorizations

Body

Response

​Request body properties

​Implementation details

​Response body properties

​Related recipes

PIC - Retrieve French Eco-Score

PIC - Update Product with French Eco-Score requirements

PIC - Create Product with French Eco-Score Optional Fields

Authorizations

Body

Response

Request body properties

Implementation details

Response body properties

Related recipes