Skip to main content
POST
Create environmental impact

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload for POST /environmental-impacts.

gtin
string<gtin>
required

GTIN (8, 12, 13 or 14 digits) of the product. Must be a product the caller's organization owns, else 404.

Required string length: 8 - 14
impact_type
enum<string>
required

Category of environmental effect measured.

Available options:
CARBON_FOOTPRINT,
WATER_USAGE,
ENERGY_CONSUMPTION,
WASTE_GENERATION,
LAND_USE,
OTHER
score_value
number
required

Magnitude of the impact in unit, up to four decimal places.

Required range: -99999999999 <= x <= 99999999999
unit
string
required

Unit score_value is expressed in.

Required string length: 1 - 10
Pattern: ^(kg\ CO2e|kg|t|L|m³|m²|MJ|kWh|%|Other)$
Example:

"kg CO2e"

methodology_reference
string
default:""

Standard or method used, for example GHG Protocol.

Maximum string length: 200
Pattern: ^[^\x00]{0,200}$
assessment_date
string<date> | null

Date of the assessment.

notes
string
default:""

Scope, assumptions or data source.

Maximum string length: 1000
Pattern: ^[^\x00]{0,1000}$

Response

Created

A quantified environmental impact of one of the organization's products.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
organization_id
string<shortuuid>
required

The organization that owns the product.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gtin
string
required

The product's GTIN, normalized to GTIN-14.

created
string<date-time>
required

Server-side ISO 8601 timestamp of creation (UTC).

modified
string<date-time>
required

Server-side ISO 8601 timestamp of last modification (UTC).

impact_type
string
required

Category of environmental effect measured.

score_value
number
required

Magnitude of the impact, expressed in unit.

unit
string
required

Unit score_value is expressed in.

methodology_reference
string
required

Standard or method used. Empty when unset.

assessment_date
string<date> | null
required

Date of the assessment. Null when unset.

notes
string
required

Scope, assumptions or data source. Empty when unset.