Skip to main content

Get all product footprints for the specified organization

GET 
/partner/v1.0/organizations/:organizationId/footprints

Get all product footprints for the specified organization

Request​

Path Parameters

    organizationId stringrequired

    The ID of the organization in the Carbon Trail platform

Query Parameters

    limit int32

    The maximum number of results to return. Optional.

    offset int32

    The offset of the first result to return. Useful for pagination. Optional.

    uuid string

    The UUID of the footprint for which all versions should be retrieved. Optional.

    articleNumber string

    The article number of the product for which footprints should be retrieved. Optional.

    impactCategories string[]

    The impact categories that should be returned in the response. Optional. Defaults to all impact categories.

Responses​

OK

Schema

    data

    object[]

    nullable

    A page of product footprints.

  • Array [

    • id stringnullable

    The unique identifier for this product footprint.

    uuid stringnullable

    The UUID of the product footprint. Versioned footprints have the same UUID but different IDs.

    created date-time

    The date and time when this product footprint was created.

    updated date-timenullable

    The date and time when this product footprint was last updated.

    retirement date-timenullable

    The date when this product footprint is set to be retired.

    cutOffDate date-timenullable

    The cut-off date for this footprint after which edits are not allowed.

    version double

    The version number of this product footprint.

    systemBoundary SystemBoundary (string)

    Possible values: [Cradle-To-Gate, Cradle-To-Grave]

    The system boundary used for calculating an footprint.

    productCategory ProductCategory (string)

    Possible values: [Apparel, Footwear, Bags, Fabric, Home, Component, Sports Equipment]

    The category of the product.

    productId stringnullable

    The unique identifier of the product for which this footprint is calculated.

    assessmentId stringnullable

    The unique identifier of the product assessment that this footprint is calculated for.

    articleNumber stringnullable

    The article number of the product.

    sku stringnullable

    The SKU (Stock Keeping Unit) of the product.

    organizationId stringnullable

    The unique identifier of the organization.

    primaryDataPercentage doublenullable

    The percentage of primary data used in the footprint calculation.

    subsidiaryId stringnullable

    The unique identifier of the subsidiary.

    submitterUserEmail stringnullable

    The email of the user who submitted this product footprint.

    footprints

    object[]

    nullable

    The footprints of this product across impact categories.

  • Array [

    • impactCategory ImpactCategory (string)

    Possible values: [Climate Change, Ozone Depletion, Human Toxicity - Cancer, Human Toxicity - Non-Cancer, Particulate Matter, Human Health - Ionising Radiation, Human Health - Photochemical Ozone Formation, Acidification, Eutrophication - Terrestrial, Eutrophication - Freshwater, Eutrophication - Marine, Ecotoxicity - Freshwater, Land Use, Water Use, Resource Use - Minerals & Metals, Resource Use - Fossils, Climate Change - Fossil, Climate Change - Biogenic, Climate Change - Land Use, Water Consumption, Resource Use - All Energy, Microfibres - Midpoint, Microfibres - Endpoint, Water Withdrawal, Overall Score]

    The set of LCA impact categories

    impactValue double

    The numerical value of the impact.

    impactUnit stringnullable

    The unit of measurement for the impact value.

    datasetGap booleannullable

    Indicates whether there is a gap in the dataset used for this footprint calculation.

    comment stringnullable

    Additional notes or explanations about this footprint measurement.

  • ]

    • dataQualityRating

    object

    Represents the data quality rating (DQR) for a product footprint or activity.

    overallDQR double

    The Overall Data Quality Rating (DQR) score.

    technologicalDQR double

    The Technological Data Quality Rating score.

    temporalDQR double

    The Temporal Data Quality Rating score.

    geographicalDQR double

    The Geographical Data Quality Rating score.

    precisionDQR double

    The Precision Data Quality Rating score.

    stageFootprints

    object[]

    nullable

    The list of stage footprints for this product.

  • Array [

    • name stringnullable

    The name of the lifecycle stage.

    footprints

    object[]

    nullable

    The list of footprints associated with this stage across impact categories.

  • Array [

    • impactCategory ImpactCategory (string)

    Possible values: [Climate Change, Ozone Depletion, Human Toxicity - Cancer, Human Toxicity - Non-Cancer, Particulate Matter, Human Health - Ionising Radiation, Human Health - Photochemical Ozone Formation, Acidification, Eutrophication - Terrestrial, Eutrophication - Freshwater, Eutrophication - Marine, Ecotoxicity - Freshwater, Land Use, Water Use, Resource Use - Minerals & Metals, Resource Use - Fossils, Climate Change - Fossil, Climate Change - Biogenic, Climate Change - Land Use, Water Consumption, Resource Use - All Energy, Microfibres - Midpoint, Microfibres - Endpoint, Water Withdrawal, Overall Score]

    The set of LCA impact categories

    impactValue double

    The numerical value of the impact.

    impactUnit stringnullable

    The unit of measurement for the impact value.

    datasetGap booleannullable

    Indicates whether there is a gap in the dataset used for this footprint calculation.

    comment stringnullable

    Additional notes or explanations about this footprint measurement.

  • ]

    • datasetGap booleannullable

    Indicates whether there is a gap in the dataset used for this stage's footprint calculation.

  • ]

    • status ProductFootprintStatus (string)

    Possible values: [Active, Deprecated]

    Represents the status of the product footprint.

    facilityDataUsed boolean

    Indicates whether facility data was used in the footprint calculation.

    overallScore double

    The overall score of the product footprint. For PEF, it's the PEF score. For FR ADEME, it's the Environmental cost

    systemVersion stringnullable

    The version of the LCA engine used for this product footprint calculation.

    methodology Methodology (string)

    Possible values: [Default, PEF, FR ADEME]

    The LCA methodology used for calculating a footprint.

  • ]

    • totalCount int64

    The total number of product footprints.

Loading...