Publish French Eco-Scores

Publish French Eco-Scores to the Affichage Environnemental portal

curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/french-label/publish \
  --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/publish"

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/publish', 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/publish",
  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/publish"

	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/publish")
  .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/publish")

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

{
  "succeeded": [
    {
      "productId": "<string>",
      "internalReference": "<string>",
      "publishedAt": 123,
      "nextEligibleAt": 123
    }
  ],
  "failed": [
    {
      "productId": "<string>",
      "error": "<string>",
      "httpStatus": 123,
      "code": "<string>"
    }
  ],
  "skipped": [
    {
      "productId": "<string>",
      "reasons": [
        {
          "message": "<string>"
        }
      ],
      "nextEligibleAt": 123,
      "driftedPeer": "<string>"
    }
  ]
}

{
  "succeeded": [
    {
      "productId": "<string>",
      "internalReference": "<string>",
      "publishedAt": 123,
      "nextEligibleAt": 123
    }
  ],
  "failed": [
    {
      "productId": "<string>",
      "error": "<string>",
      "httpStatus": 123,
      "code": "<string>"
    }
  ],
  "skipped": [
    {
      "productId": "<string>",
      "reasons": [
        {
          "message": "<string>"
        }
      ],
      "nextEligibleAt": 123,
      "driftedPeer": "<string>"
    }
  ]
}

{
  "succeeded": [
    {
      "productId": "<string>",
      "internalReference": "<string>",
      "publishedAt": 123,
      "nextEligibleAt": 123
    }
  ],
  "failed": [
    {
      "productId": "<string>",
      "error": "<string>",
      "httpStatus": 123,
      "code": "<string>"
    }
  ],
  "skipped": [
    {
      "productId": "<string>",
      "reasons": [
        {
          "message": "<string>"
        }
      ],
      "nextEligibleAt": 123,
      "driftedPeer": "<string>"
    }
  ]
}

POST

french-label

publish

Publish French Eco-Scores to the Affichage Environnemental portal

curl --request POST \
  --url https://api-v2.production.higg.org/pic-api/v1/french-label/publish \
  --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/publish"

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/publish', 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/publish",
  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/publish"

	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/publish")
  .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/publish")

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

{
  "succeeded": [
    {
      "productId": "<string>",
      "internalReference": "<string>",
      "publishedAt": 123,
      "nextEligibleAt": 123
    }
  ],
  "failed": [
    {
      "productId": "<string>",
      "error": "<string>",
      "httpStatus": 123,
      "code": "<string>"
    }
  ],
  "skipped": [
    {
      "productId": "<string>",
      "reasons": [
        {
          "message": "<string>"
        }
      ],
      "nextEligibleAt": 123,
      "driftedPeer": "<string>"
    }
  ]
}

{
  "succeeded": [
    {
      "productId": "<string>",
      "internalReference": "<string>",
      "publishedAt": 123,
      "nextEligibleAt": 123
    }
  ],
  "failed": [
    {
      "productId": "<string>",
      "error": "<string>",
      "httpStatus": 123,
      "code": "<string>"
    }
  ],
  "skipped": [
    {
      "productId": "<string>",
      "reasons": [
        {
          "message": "<string>"
        }
      ],
      "nextEligibleAt": 123,
      "driftedPeer": "<string>"
    }
  ]
}

{
  "succeeded": [
    {
      "productId": "<string>",
      "internalReference": "<string>",
      "publishedAt": 123,
      "nextEligibleAt": 123
    }
  ],
  "failed": [
    {
      "productId": "<string>",
      "error": "<string>",
      "httpStatus": 123,
      "code": "<string>"
    }
  ],
  "skipped": [
    {
      "productId": "<string>",
      "reasons": [
        {
          "message": "<string>"
        }
      ],
      "nextEligibleAt": 123,
      "driftedPeer": "<string>"
    }
  ]
}

Submit finalized French Eco-Scores for products in your library to the French government’s Affichage Environnemental portal.

Specify an array of up to 50 product IDs to publish in a single request. IDs must be non-empty, unique, and non-blank.

Request body properties

Name	Type	Description
`productIds`	`Array<string>`	[REQUIRED] IDs of the products to publish. Must be non-empty, unique, and non-blank. Up to 50 IDs per request.

Implementation details

Batch limit: You can publish a maximum of 50 products per request.
Eligibility re-check: For each product, the server re-checks eligibility (GTIN, materials, manufacturing country, and other requirements) and enforces the 3-month re-publish lock before any portal call.
Status codes: The endpoint returns 200 when every attempted product succeeded, 207 when at least one succeeded and at least one failed, and 400 when every attempted product failed.
Result handling: Always inspect failed[] and skipped[] to confirm each product was filed — a 200 does not guarantee every product in the request was published.

Response body properties

Name	Type	Description
`succeeded`	`Array<object>`	[REQUIRED] Products accepted by the portal. `httpStatus` is `201` for a new declaration or `208` when the portal confirms an existing declaration is already on file. `publishedAt` and `nextEligibleAt` are populated only on `201`; on `208` the previously stored values remain. Products submitted in the same batch share `internalReference`.
`failed`	`Array<object>`	[REQUIRED] Products the portal rejected or that could not be persisted. `error` is a human-readable explanation; `httpStatus` (when present) is the upstream portal status code. Products in the same failed batch carry the same `error` and `httpStatus`.
`skipped`	`Array<object>`	[REQUIRED] Products the publish request did not attempt to submit to the portal. Reasons include ownership, the 3-month re-publish lock, a structural eligibility failure, or a concurrent Eco-Score change detected just before submission. `nextEligibleAt` is set when a reason is `WithinThreeMonthLock`; it is the Unix-ms timestamp at which the lock expires. `driftedPeer` is set when a reason is `GroupAbortedDueToPeerDrift`; it is the productId of the peer whose change caused the batch rollback.

PIC - Update Product with French Eco-Score requirements

PIC - Retrieve French Eco-Score

Refer to the PIC Data Dictionary for more information on French Eco-Score attributes.

Authorizations

x-api-key

string

header

required

x-developer-request-token

string

header

required

Body

application/json

Request body for the French Eco-Score batch publish endpoint. Up to 50 products per request.

productIds

string[]

required

IDs of the products to publish. Must be non-empty, unique, and non-blank. Up to 50 IDs per request.

Response

Aggregate result of a French Eco-Score batch publish request. - succeeded[] — products accepted by the portal. - failed[] — products the portal rejected or that could not be persisted. - skipped[] — products the publish did not attempt (ownership, lock window, eligibility failure, or concurrent score change). Returned with HTTP 200 when every attempted product succeeded, 207 when at least one succeeded and at least one failed, or 400 when every attempted product failed — callers MUST inspect failed[] and skipped[] to confirm individual products were filed.

succeeded

object[]

required

Show child attributes

failed

object[]

required

Show child attributes

skipped

object[]

required

Show child attributes

Assessments

PIC API

Product Tools

Request body properties

Implementation details

Response body properties

PIC - Update Product with French Eco-Score requirements

PIC - Retrieve French Eco-Score

Authorizations

Body

Response

​Request body properties

​Implementation details

​Response body properties

​Related recipes

PIC - Update Product with French Eco-Score requirements

PIC - Retrieve French Eco-Score

Authorizations

Body

Response

Request body properties

Implementation details

Response body properties

Related recipes