Skip to main content
POST
Products Search
Use this endpoint to filter and find products within your account. You can search by name, category, materials, or French Eco-Score status.

Request body properties

Set to true to return only products that have a French Eco-Score calculation.
Controls pagination. from specifies the starting index (default 0), and size specifies the number of results to return (default 50).

Response body properties

The search result includes a results array containing product details.
This property is located within purchaseOrder[].assembly and provides the environmental impact specifically for the finished product assembly.

Implementation details

  • Pagination: Use from and size for large result sets. The response includes a total field to help you calculate the number of pages.
  • Filtering logic: Most array fields (like name or material) act as “OR” filters. A product is returned if it matches any of the provided values in the array.
  • French Eco-Score: Use the hasFrenchEcoScore filter to identify products eligible for French environmental labeling.

PIC - Retrieve French Eco-Score

PIC - Create a Product

PIC - Create a Purchase Order

Check the PIC Data Dictionary for detailed definitions of product and impact fields.

Authorizations

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

Body

application/json
id
string[] | null
name
string[] | null
sort
object

API Search requests

textSearch
string[] | null
from
number<double> | null
size
number<double> | null
productSize
string[] | null
productCategory
string[] | null
component
string[] | null
material
string[] | null
packaging
string[] | null
tag
string[] | null
identifier
string[] | null
hasFrenchEcoScore
boolean | null
publishEligibleOnly
boolean | null

Opt-in only. When true the search restricts results to products eligible to publish to the French Eco-Score declaration portal right now. Omit (or pass false) to skip the filter — both behave identically. Silently ignored for accounts without the publish feature enabled.

Response

200 - application/json

Ok

API Search responses

from
number<double>
required
size
number<double>
required
total
number<double>
required
results
object[]
required