Get Product - Variable API

Get a product by UUID

curl --request GET \
  --url https://app.variable.global/api/v1/product/{uuid} \
  --header 'Authorization: Bearer <token>'

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Product Name",
  "description": "A descriptive description",
  "notes": "Internal notes about this product",
  "sku": "SKU123",
  "syncId": "sync123",
  "cpcCode": "CPC123",
  "supplierPartId": "PART-123",
  "unit": "kg",
  "weight": {
    "quantity": 100,
    "unit": "kg"
  },
  "packagingWeight": {
    "quantity": 10,
    "unit": "kg"
  },
  "recycledPercent": 30,
  "footprint": {
    "CO2e": {
      "A1": "1200.0",
      "A2": "30.0",
      "A3": "4.0",
      "A4": "0.5",
      "B1": "0.06",
      "B2": "0.007",
      "B3": "0.0008",
      "B4": "",
      "B5": "",
      "C1": "",
      "C2": "",
      "C3": "",
      "C4": "",
      "D": "",
      "totalCarbonFootprint": "1234.5678",
      "productCarbonFootprint": "1234.0",
      "upstream": "1230.0",
      "direct": "4.0",
      "downstream": "0.5678",
      "A1_A3": "1234.0"
    }
  },
  "dataQualityIndicators": {
    "description": "Primary data from the 2022 production year; background datasets from ecoinvent 3.9.",
    "documentationYear": 2019,
    "coveragePercent": 80,
    "specificPercent": 40,
    "technologicalDQR": 1,
    "temporalDQR": 1,
    "geographicalDQR": 1,
    "completenessDQR": 1,
    "reliabilityDQR": 1,
    "averagePercent": 60
  },
  "taxonomy": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Material",
    "path": "material"
  },
  "geoLocation": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Pittsburgh, PA"
  },
  "location": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Pittsburgh Office"
  },
  "startDate": "2021-01-01T00:00:00.000Z",
  "endDate": "2021-01-01T00:00:00.000Z",
  "dataSource": "model",
  "image": "https://app.variable.global/uploads/image.jpg",
  "modeledWeight": {
    "quantity": 100,
    "unit": "kg"
  },
  "modeledPackagingWeight": {
    "quantity": 12.5,
    "unit": "kg"
  },
  "modeledTotalWeight": {
    "quantity": 112.5,
    "unit": "kg"
  },
  "modeledRecycledPercent": 27.5,
  "impacts": {
    "GWP-fossil": {
      "unit": "kgCO2e",
      "method": "Mixed",
      "totalCarbonFootprint": "10",
      "A1_A3": "10"
    },
    "ODP": {
      "unit": "kgCFC11e",
      "method": "EN15804+A2 - Core impact categories and indicators",
      "A1_A3": "0.0000012"
    },
    "AP": {
      "unit": "molH+e",
      "method": "EN15804+A2 - Core impact categories and indicators",
      "A1_A3": "2"
    }
  },
  "dataset": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Name",
    "source": "ecoinvent 3.8",
    "declaredUnit": "kg"
  },
  "datasetAmount": {
    "quantity": 1,
    "unit": "kg"
  },
  "dataQualityRating": 1.4,
  "created": "2021-01-01T00:00:00.000Z",
  "updated": "2021-01-31T23:59:59.000Z"
}

GET

product

{uuid}

Get a product by UUID

curl --request GET \
  --url https://app.variable.global/api/v1/product/{uuid} \
  --header 'Authorization: Bearer <token>'

{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Product Name",
  "description": "A descriptive description",
  "notes": "Internal notes about this product",
  "sku": "SKU123",
  "syncId": "sync123",
  "cpcCode": "CPC123",
  "supplierPartId": "PART-123",
  "unit": "kg",
  "weight": {
    "quantity": 100,
    "unit": "kg"
  },
  "packagingWeight": {
    "quantity": 10,
    "unit": "kg"
  },
  "recycledPercent": 30,
  "footprint": {
    "CO2e": {
      "A1": "1200.0",
      "A2": "30.0",
      "A3": "4.0",
      "A4": "0.5",
      "B1": "0.06",
      "B2": "0.007",
      "B3": "0.0008",
      "B4": "",
      "B5": "",
      "C1": "",
      "C2": "",
      "C3": "",
      "C4": "",
      "D": "",
      "totalCarbonFootprint": "1234.5678",
      "productCarbonFootprint": "1234.0",
      "upstream": "1230.0",
      "direct": "4.0",
      "downstream": "0.5678",
      "A1_A3": "1234.0"
    }
  },
  "dataQualityIndicators": {
    "description": "Primary data from the 2022 production year; background datasets from ecoinvent 3.9.",
    "documentationYear": 2019,
    "coveragePercent": 80,
    "specificPercent": 40,
    "technologicalDQR": 1,
    "temporalDQR": 1,
    "geographicalDQR": 1,
    "completenessDQR": 1,
    "reliabilityDQR": 1,
    "averagePercent": 60
  },
  "taxonomy": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Material",
    "path": "material"
  },
  "geoLocation": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Pittsburgh, PA"
  },
  "location": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Pittsburgh Office"
  },
  "startDate": "2021-01-01T00:00:00.000Z",
  "endDate": "2021-01-01T00:00:00.000Z",
  "dataSource": "model",
  "image": "https://app.variable.global/uploads/image.jpg",
  "modeledWeight": {
    "quantity": 100,
    "unit": "kg"
  },
  "modeledPackagingWeight": {
    "quantity": 12.5,
    "unit": "kg"
  },
  "modeledTotalWeight": {
    "quantity": 112.5,
    "unit": "kg"
  },
  "modeledRecycledPercent": 27.5,
  "impacts": {
    "GWP-fossil": {
      "unit": "kgCO2e",
      "method": "Mixed",
      "totalCarbonFootprint": "10",
      "A1_A3": "10"
    },
    "ODP": {
      "unit": "kgCFC11e",
      "method": "EN15804+A2 - Core impact categories and indicators",
      "A1_A3": "0.0000012"
    },
    "AP": {
      "unit": "molH+e",
      "method": "EN15804+A2 - Core impact categories and indicators",
      "A1_A3": "2"
    }
  },
  "dataset": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Name",
    "source": "ecoinvent 3.8",
    "declaredUnit": "kg"
  },
  "datasetAmount": {
    "quantity": 1,
    "unit": "kg"
  },
  "dataQualityRating": 1.4,
  "created": "2021-01-01T00:00:00.000Z",
  "updated": "2021-01-31T23:59:59.000Z"
}

Requires permission:

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid

string<uuid>

required

Query Parameters

impacts

string

Which environmental impact indicators to include in the impacts field. Absent or empty returns only GWP-fossil. Pass all for every indicator, or a comma-separated list of canonical codes to filter (case-insensitive). all is only honored on its own — combining it with other codes (e.g. all,gwp-fossil) is treated as an unknown code. An unknown code returns 400. See the Impacts concept and the full indicator catalog.

Example:

"gwp-fossil,odp,ap"

Response

A product

uuid

string<uuid>

name

string

Example:

"Product Name"

description

string

Example:

"A descriptive description"

notes

string

Example:

"Internal notes about this product"

sku

string

Example:

"SKU123"

syncId

string

An identifier to use when syncing data with other systems. Read more

Example:

"sync123"

cpcCode

string

Example:

"CPC123"

supplierPartId

string

The supplier's part identifier for this product.

Example:

"PART-123"

unit

string

The unit code (e.g. kg, lbs, etc.). All unit codes can be found in the List Units endpoint.

Example:

"kg"

weight

object

The user-declared weight of the product. On read responses, compare with the server-computed modeledWeight to mass-balance the product against its bill of materials.

Show child attributes

packagingWeight

object

The user-declared weight of the product's packaging. On read responses, compare with the server-computed modeledPackagingWeight to mass-balance packaging against its bill of materials.

Show child attributes

recycledPercent

number

The user-declared recycled content of the product as a percentage (0–100). A 0 is a declared zero; omit the field when undeclared. On read responses, compare with the server-computed modeledRecycledPercent.

Example:

30

footprint

object

deprecated

Deprecated — use impacts["GWP-fossil"]. Kept for backwards compatibility.

Show child attributes

dataQualityIndicators

object

Show child attributes

taxonomy

object

A reference to a taxonomy category, including its machine-readable path.

Show child attributes

geoLocation

object

Show child attributes

location

object

Show child attributes

startDate

string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

endDate

string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

dataSource

enum<string>

Available options:

model,

external

Example:

"model"

image

string

Example:

"https://app.variable.global/uploads/image.jpg"

modeledWeight

object

read-only

Read-only. Server-computed sum of the model's A1–A3 product material input weights (Material group "Product"; excludes packaging and ancillary), in the same Amount shape as the declared weight. Compare the two to mass-balance the product: weight is the value you set, while modeledWeight is derived from the bill of materials. Present only when the model has qualifying product inputs. Ignored on POST/PATCH.

Show child attributes

modeledPackagingWeight

object

read-only

Read-only. Server-computed sum of the model's A1–A3 packaging input weights (Material group "Packaging"), in the same Amount shape as the declared packagingWeight. Compare the two to mass-balance packaging: packagingWeight is the value you set, while modeledPackagingWeight is derived from the bill of materials. Present only when the model has qualifying packaging inputs. Ignored on POST/PATCH.

Show child attributes

modeledTotalWeight

object

read-only

Read-only. Gross modeled weight: the sum of modeledWeight and modeledPackagingWeight, in the same Amount shape. Derived at read time from the two persisted addends — a missing addend contributes nothing — so it's present whenever at least one of the two is present; its unit follows the first present addend. Ignored on POST/PATCH.

Show child attributes

modeledRecycledPercent

number

read-only

Read-only. Server-computed weight-weighted average of the contributing inputs' recycled content (0–100). Compare against the declared recycledPercent: recycledPercent is the value you set, while modeledRecycledPercent is derived from the bill of materials. Present only when the model has contributing inputs. Ignored on POST/PATCH.

Example:

27.5

impacts

object

Environmental impact indicators keyed by canonical code (e.g. GWP-fossil, ODP, AP). Which indicators appear is controlled by the impacts query parameter — by default only GWP-fossil is returned.

Show child attributes

Example:

{
  "GWP-fossil": {
    "unit": "kgCO2e",
    "method": "Mixed",
    "totalCarbonFootprint": "10",
    "A1_A3": "10"
  },
  "ODP": {
    "unit": "kgCFC11e",
    "method": "EN15804+A2 - Core impact categories and indicators",
    "A1_A3": "0.0000012"
  },
  "AP": {
    "unit": "molH+e",
    "method": "EN15804+A2 - Core impact categories and indicators",
    "A1_A3": "2"
  }
}

dataset

object

The emission-factor dataset a sourced element (/v1/material, /v1/energy, /v1/process) draws its impact from. Send { uuid } to bind one at create time, or a different dataset on update to re-point the element; binding a dataset makes the element external (dataSource: external). Use /v1/database to find one. On read it carries the full reference (uuid, name, source, declaredUnit) and is present for external elements only — absent for modeled products.

Show child attributes

datasetAmount

object

The quantity and unit of the backing dataset this element consumes — the amount its per-unit factor scales. Optional when binding: omit to consume one declared unit of the dataset; send alone on update to re-scale an existing binding without changing the dataset. On read, present for external elements only — absent for modeled products.

Show child attributes

dataQualityRating

number

Example:

1.4

created

string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

updated

string

ISO 8601 date

Example:

"2021-01-31T23:59:59.000Z"

List Products Create Product