API docs by Redocly

Fairglow Product LCA API (0.0.1)

Download OpenAPI specification:

API for creating, updating, and performing LCA calculations on products.

Create or update the product

path Parameters
id
required
string

Unique product identifier provided by the API user.

Request Body schema: application/json
required

This payload represents a finished consumer product.

Preferred values for certain fields

Fields tagged with ✳️ have preferred values that are optional but will help improve the speed and accuracy of the LCA calculation.

If not provided, the API will attempt to normalize values to a preferred value during LCA calculation.

One of
product_name
required
string

Name of the product.

product_brand
string

Brand of the product.

product_line
string

Product line or series.

volume_ml
required
number

Volume of the product in milliliters. Required if weight_g is not provided.

weight_g
number

Weight of the product in grams. Required if volume_ml is not provided.

product_category
required
string

Main category of the product. ✳️

product_subcategory
string

Subcategory of the product. ✳️

transport_truck_km
number

Distance transported by truck (km).

transport_boat_km
number

Distance transported by boat (km).

transport_plane_km
number

Distance transported by plane (km).

transport_train_km
number

Distance transported by train (km).

geography
string

Geography or region for the product. ✳️

packaging_reuse_count
number

If the product is reusable, the number of times the packaging can be reused.

Array of objects (Ingredient)

List of ingredient objects.

Array of objects (PackagingElement)

List of packaging element objects.

Array of objects or objects (ManufacturingActivity)

List of manufacturing activity objects.

Responses

Request samples

Content type
application/json
{
  • "product_name": "string",
  • "product_brand": "string",
  • "product_line": "string",
  • "volume_ml": 0,
  • "weight_g": 0,
  • "product_category": "string",
  • "product_subcategory": "string",
  • "transport_truck_km": 0,
  • "transport_boat_km": 0,
  • "transport_plane_km": 0,
  • "transport_train_km": 0,
  • "geography": "string",
  • "packaging_reuse_count": 0,
  • "ingredients": [
    ],
  • "packaging": [
    ],
  • "manufacturing": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "product_id": "string"
}

Start an LCA calculation job

path Parameters
id
required
string

Unique product identifier provided by the API user.

Responses

Response samples

Content type
application/json
{
  • "job_id": "string"
}

Get the status and results of a job

path Parameters
job_id
required
string

Unique identifier for the job.

Responses

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "status": "string",
  • "results": {
    }
}