Changelog 

The format is based on Keep a Changelog.

[1.15.0] - 2025-06-23 

What's New 

POST /products/{id}/bomVersions 

Create a Bill of Material Versions for a product in SiGREEN

DELETE /products/{id}/factoryEmissions 

Deletes factory emissions data associated with a specific product in the SiGREEN system. The deletion requires a factory ID and can be further scoped using optional filters such as batch number, revision, and a date range to precisely manage and remove outdated or invalid emissions records.

DELETE /products/{id}/bomVersions/{bomVersionId} 

Delete a BOM version of a product in SiGREEN.

PATCH /products/{id}/bomVersions/{bomVersionId} 

Update the BOM version of a product in SiGREEN.

GET /products/{id}/bom/{bomVersionId} 

Get a list of Bill of Material entries for a product in SiGREEN.

PATCH /products/{id}/bom/{bomVersionId} 

Add Groups, Components, and Products to product BOM version in SiGREEN, and return the job Id. Job Status API can be used to retrieve the status of operations. This API performs tasks such as adding BOM items, synchronizing components, and executing calculations.

DELETE /products/{id}/bom/{bomVersionId}/items/{bomItemId} 

Delete BOM item (Groups,Components and Products)) to product BOM version in SiGREEN.

PATCH /products/{id}/bom/{bomVersionId}/items/{bomItemId} 

Update meta data of Groups,Components and Products to product BOM version in SiGREEN.

PATCH /products/{id}/bom/{bomVersionId}/saveUpstreamEmissions 

Save the current state of the upstream emission data for a product BOM version in SiGREEN. Once saved, the upstream emissions BOM will be locked, and no further changes will be allowed.

GET /products/jobs/{id}/status 

This API is used to fetch the status of a job

What's Deleted 

GET /products/{productId}/bom 

Get a list Bill of Material entries for a product in SiGREEN

POST /products/{productId}/bom 

Create a Bill of Material for a product in SiGREEN

POST /products/{productId}/offsetting 

Offset your emissions.

Breaking Changes 

POST /products/identifierTypes 

Request: 

Changed content type : application/json

New required properties: - mandatory

• Added property mandatory (boolean) > Whether this identifier must be filled when creating products.

PATCH /products/identifierTypes/{id} 

Request: 

Changed content type : application/json

New required properties: - mandatory

• Added property mandatory (boolean) > Whether this identifier must be filled when creating products.

GET /products/{id}/pcf 

Return Type: 

Changed response : 200 OK

Product carbon footprint of a product in a SiGREEN company

Changed content type : application/json

Changed property factoryEmission (object) > Details about the factory emission.

New optional properties: - factoryId - from - productCarbonFootprint - to

Added property pcfIncludingBiogenic (string) > Factory emission GWP total (incl. bio.). kg CO2e/declared unit

Added property pcfExcludingBiogenic (string) > Factory emission GWP total (excl. bio.). kg CO2e/declared unit

Deleted property revision (string) > Revision

Deleted property factoryId (string) > UUID to identify the factory of the company in SiGREEN

Deleted property from (string) > From date

Deleted property to (string) > to date

Deleted property batch (object) > Batch

Deleted property productCarbonFootprint (number) > Product carbon foot print

Deleted property emissions (array) > Factory emission activities

Deleted property comment (string) > Comments

Deleted property sourceSystem (string) > Source system

What's Changed 

GET /products/identifierTypes 

Return Type: 

Changed response : 200 OK

List of product identifier types

Changed content type : application/json

Changed property items (array)

Changed items (object):

New required properties: - isMandatory

• Added property isMandatory (boolean) > Whether this identifier must be filled when creating products.

POST /products/identifierTypes 

Request: 

Changed content type : application/json

New required properties: - mandatory

• Added property mandatory (boolean) > Whether this identifier must be filled when creating products.

PATCH /products/identifierTypes/{id} 

Request: 

Changed content type : application/json

New required properties: - mandatory

• Added property mandatory (boolean) > Whether this identifier must be filled when creating products.

GET /products 

Parameters: 

Changed: sort in query

Sorting fields supported (name, createdOn, updatedOn). Example - Ascending order '+name' , Descending order '-name'. Default order is createdOn ascending order.

Return Type: 

Changed response : 200 OK

A list of products

Changed content type : application/json

Changed property items (array)

Changed items (object):

• Changed property identifiers (array) > There should be one identifier where default parameter is set to true. That will act as main identifier for this entity.

POST /products 

Request: 

Changed content type : application/json

• Changed property identifiers (array) > There must be one identifier with the default parameter set to true, as it represents the main identifier for this entity.

GET /products/{id} 

Return Type: 

Changed response : 200 OK

A product

Changed content type : application/json

• Changed property identifiers (array) > There should be one identifier where default parameter is set to true. That will act as main identifier for this entity.

PUT /products/{id} 

Request: 

Changed content type : application/json

• Changed property identifiers (array) > There must be one identifier with the default parameter set to true, as it represents the main identifier for this entity.

GET /products/{id}/pcf 

Return Type: 

Changed response : 200 OK

Product carbon footprint of a product in a SiGREEN company

Changed content type : application/json

Changed property factoryEmission (object) > Details about the factory emission.

New optional properties: - factoryId - from - productCarbonFootprint - to

Added property pcfIncludingBiogenic (string) > Factory emission GWP total (incl. bio.). kg CO2e/declared unit

Added property pcfExcludingBiogenic (string) > Factory emission GWP total (excl. bio.). kg CO2e/declared unit

Deleted property revision (string) > Revision

Deleted property factoryId (string) > UUID to identify the factory of the company in SiGREEN

Deleted property from (string) > From date

Deleted property to (string) > to date

Deleted property batch (object) > Batch

Deleted property productCarbonFootprint (number) > Product carbon foot print

Deleted property emissions (array) > Factory emission activities

Deleted property comment (string) > Comments

Deleted property sourceSystem (string) > Source system

GET /products/bomVersions 

Parameters: 

Added: locked in query

BOM is locked or not.true or false.

Added: sort in query

Sorting fields supported (createdOn, updatedOn,upstreamEmissionCreatedOn). Example - Ascending order '+createdOn' , Descending order '-createdOn'. Default order is createdOn ascending order.

Return Type: 

Changed response : 200 OK

Bill of Materials metadata

Changed content type : application/json

Changed property items (array)

Changed items (object):

Added property id (string) > UUID of product BOM Version of the company in SiGREEN

Added property latestSync (string) > Last BOM sync DateTime.DateTime (ISO 8601; UTC Timezone)

Added property upstreamEmission (object) > Details about the upstream emission details.

Property pcfIncludingBiogenic (string) > Upstream GWP total (incl. bio.). kg CO2e/declared unit

Property pcfExcludingBiogenic (string) > Upstream GWP total (excl. bio.). kg CO2e/declared unit

Added property productionStage (object) > Production stage details

Property pcfIncludingBiogenic (string) > Production stage GWP total (incl. bio.). kg CO2e/declared unit

Property pcfExcludingBiogenic (string) > Production stage GWP total (excl. bio.). kg CO2e/declared unit

Added property distributionStage (object) > Distribution stage details

Property pcfIncludingBiogenic (string) > Distribution stage GWP total (incl. bio.). kg CO2e/declared unit

Property pcfExcludingBiogenic (string) > Distribution stage GWP total (excl. bio.). kg CO2e/declared unit

Added property upstreamEmissionCreatedOn (string) > Emission createdOn.DateTime (ISO 8601; UTC Timezone)

Added property createdOn (string) > BOM version Created on (ISO 8601; UTC Timezone)

Added property updatedOn (string) > BOM version Updated on (ISO 8601; UTC Timezone)

GET /products/pcfData 

GET the PCF data for products in SiGREEN.

Parameters: 

Changed: sort in query

Sorting fields supported (createdOn). Example - Ascending order '+createdOn' , Descending order '-createdOn'. Default order is createdOn ascending order.

[1.13.0] - 2025-02-10 

What's New 

GET /products/pcfData 

GET the PCF data for your Products in SiGREEN.

GET /products/bomVersions 

Get a list of BOM versions

What's Deprecated 

POST /products/{id}/factoryEmissions 

Upload factory emissions for a product in SiGREEN.

What's Changed 

POST /products/identifierTypes 

Return Type: 

Changed response : 201 Created

Created. Response will return the UUID of the created product identifier type.

Changed content type : application/json

• Changed property id (string)

UUID to identify the identifier type of the company in SiGREEN

DELETE /products/identifierTypes/{id} 

Parameters: 

Changed: id in path

UUID to identify the product identifier type of the company in SiGREEN.

PATCH /products/identifierTypes/{id} 

Parameters: 

Changed: id in path

UUID for identifying the product identifier type of the company in SiGREEN.

GET /products 

Parameters: 

Added: searchText in query

Partial text search on following attributes - name , identifiers.
Minimum 3 characters required to search.
Partial text match would be either name or identifiers or both

Added: name in query

Filter products by name

Added: family in query

Filter products by product family

Added: idType in query

Product identifier type in SiGREEN.
idType filter is applicable only when user is searching with idValue filter.
Idea here is to find products with idType and value combination.

Added: idValue in query

Filter products based on either main or additional identifier value in SiGREEN.

Added: factoryId in query

UUID to identify the factory of the company in SiGREEN

Added: sort in query

Sorting fields supported (name, createdOn, updatedOn). Example - Ascending order '+name' , Descending order '-name'. Default order is createdOn ascending order.

Return Type: 

Changed response : 200 OK

A list of products

Changed content type : application/json

• Changed property items (array)

POST /products 

Request: 

Changed content type : application/json

• Changed property factoryIds (array)

Product Factory Ids (UUIDs)

Return Type: 

Changed response : 201 Created

Created

Changed content type : application/json

• Changed property id (string)

UUID to identify the product of the company in SiGREEN

GET /products/{id} 

Parameters: 

Changed: id in path

UUID to identify the product of the company in SiGREEN

Return Type: 

Changed response : 200 OK

A product

Changed content type : application/json

Added property createdOn (string)

Created on (ISO 8601; UTC Timezone)

Added property updatedOn (string) > Updated on (ISO 8601; UTC Timezone)

Changed property id (string) > UUID to identify the product of the company in SiGREEN

Changed property factoryIds (array) > Product Factory Ids (UUIDs)

PUT /products/{id} 

Parameters: 

Changed: id in path

UUID to identify the product of the company in SiGREEN

Request: 

Changed content type : application/json

• Changed property factoryIds (array)

Product Factory Ids (UUIDs)

DELETE /products/{id} 

Parameters: 

Changed: id in path

UUID to identify the product of the company in SiGREEN

GET /products/{id}/pcf 

Get product PCF details by id in SiGREEN.

Parameters: 

Changed: id in path

UUID to identify the product of the company in SiGREEN

Return Type: 

Changed response : 200 OK

Product carbon footprint of a product in a SiGREEN company

Changed content type : application/json

Added property pcfId (string) > The unique PCF Id of a credential

Added property productionStage (object) > Production stage details

Property pcfIncludingBiogenic (string) > Production stage GWP total (incl. bio.). kg CO2e/declared unit

Property pcfExcludingBiogenic (string) > Production stage GWP total (excl. bio.). kg CO2e/declared unit

Added property distributionStage (object) > Distribution stage details

Property pcfIncludingBiogenic (string) > Distribution stage GWP total (incl. bio.). kg CO2e/declared unit

Property pcfExcludingBiogenic (string) > Distribution stage GWP total (excl. bio.). kg CO2e/declared unit

Added property upstream (object) > Details about the upstream emission details.

Property pcfIncludingBiogenic (string) > Upstream GWP total (incl. bio.). kg CO2e/declared unit

Property pcfExcludingBiogenic (string) > Upstream GWP total (excl. bio.). kg CO2e/declared unit

Deleted property totalPcf (number) > Total Pcf

Deleted property upstreamPcf (number) > Upstream Pcf

Deleted property dataQuality (array) > Data Quality

Changed property factoryEmission (number -> object)

Changed property active (boolean) > The active status of the product

Changed property creationDate (string -> string) > The creation date of the product

Changed property validityPeriodStart (string -> string) > The start of the validity period of the product

Changed property validityPeriodEnd (string -> string) > The end of the validity period of the product

Changed property certifier (string) > The certifier of the product

Changed property revision (string) > The revision of the product

Changed property bomVersion (string) > The BOM version of the product

Changed property emissionUnit (string) > The emission unit of the product

Removed enum values:

• piece
• kg
• m2
• m3
• kWh
• tkm
• MJ
• L
  • Changed property quantity (number -> number)

The quantity of the product

POST /factories 

Return Type: 

Changed response : 201 Created

Created. Response will return the UUID of the created factory.

Changed content type : application/json

• Changed property id (string)

UUID to identify the factory of a company in SiGREEN.

DELETE /factories/{id} 

Parameters: 

Changed: id in path

UUID to identify the factory of the company in SiGREEN.

PATCH /factories/{id} 

Parameters: 

Changed: id in path

UUID for identifying the factory of the company in SiGREEN.

GET /products/{productId}/bom 

Parameters: 

Changed: productId in path

Alphanumeric Id (Product Identifier) for identifying the product of the company in SiGREEN

Return Type: 

Changed response : 200 OK

Bill of Materials

Changed content type : application/json

• Changed property boms (array)

POST /products/{productId}/bom 

Parameters: 

Changed: productId in path

Alphanumeric Id (Product Identifier) for identifying the product of the company in SiGREEN

Request: 

Changed content type : application/json

Changed property version (string)

Version of the Bill of Material

Changed property comment (string)

Comments

Changed property revision (string)

Revision of the product

Changed property components (array)

List of BOM Components of the product

Changed items (object):

Changed property identifier (string) > Identifier of the component

Changed property quantity (string) > Quantity of the component

Changed property components (array) > List of BOM Components of the product

POST /products/{productId}/offsetting 

Parameters: 

Changed: productId in path

Alphanumeric Id (Product Identifier) for identifying the product of the company in SiGREEN

Request: 

Changed content type : application/json

Changed items (object):

Changed property batchNumber (string)

batch number

Changed property taskId (string)

task id

Changed property offsetTotal (number)

offset total

Changed property offsetUnit (string)

offset unit

Changed property offsetPortfolioId (string)

offset portfolio id

Changed property offsetPrice (number)

offset price

Changed property offsetPriceUnit (string)

offset price unit

Changed property offsetOwner (string)

offset owner

Changed property offsetReason (string)

offset reason

Changed property offsetOwnerVisibility (string)

offset owner visibility

Changed property offsetReasonVisibility (string)

offset reason visibility

Changed property offsetProviderOrderID (string)

offset provider order id

Changed property certificateLink (string)

certificate link

Changed property comment (string)

Comments

Changed property offsetProjects (array)

List of offset projects

Changed items (object):

Changed property offsetType (string) > offset type

Changed property offsetProvider (string) > offset provider

Changed property offsetProviderProjectID (string) > offset provider project id

Changed property offsetProviderFinalizationID (string) > offset provider finalization id

Changed property offsetProviderFinalizationDate (string) > offset provider finalization date

Changed property offsetQuantity (number) > offset quantity

Changed property offsetQuantityUnit (string) > offset quantity unit

Changed property projectID (string) > project id

Changed property projectName (string) > project name

Changed property projectLocation (string) > project location

Changed property projectType (string) > project type

Changed property projectURL (string) > project url

Changed property productType (string) > product type

Changed property offsetRetirementURL (string) > offset retirement url

Changed property offsetRetirementDate (string) > offset retirement date

Changed property offsetVintageStart (string) > offset vintage start

Changed property offsetVintageEnd (string) > offset vintage end

Changed property offsetSerialNumber (string) > offset serial number

Changed property offsetOwner (string) > offset owner

Changed property offsetReason (string) > offset reason

POST /products/{id}/factoryEmissions 

Parameters: 

Changed: id in path

UUID to identify the product of the company in SiGREEN

Request: 

Changed content type : application/json

New required properties: - factoryId

New optional properties: - emissions

Changed property factoryId (string)

UUID to identify the factory of the company in SiGREEN

Changed property batch (object)

Batch

New optional properties: - assessmentYear

Return Type: 

Changed response : 201 Created

Created

Changed content type : application/json

• Changed property factoryEmissionId (string)

UUID to identify the factory emission of the company in SiGREEN

[1.12.0] - 2024-10-14 

What's New 

DELETE /products/{id} 

Delete a product in SiGREEN.

What's Changed 

POST products/{id}/factoryEmissions 

• API endpoint changed from "/products/factoryEmissions/{productId}" to "/products/{id}/factoryEmissions"
• Parameter changed from {productId} - product main identifier value to {id} - product system generated id
• Changed Request body structure changed from array to single object.
• Changed Request body - Instead of factory name now it uses factory id.

PATCH /factories/{id} 

Parameters 

Changed: id in path

System generated id to identify the factory of the company in SiGREEN.

GET /products/{id} 

Changed response : --200 OK--

The request was successful and received single product data.

Changed content type : application/json

• Changed property unitType (string)

Unit type of the product

PUT /products/{id} 

Request 

Changed content type : application/json

New required properties:

identifiers

Changed property unitType (string)

Unit type of the product

Added enum values:

- `piece`
- `kg`
- `m2`
- `m3`
- `kWh`
- `tkm`
- `MJ`
- `L`

GET /products/identifierTypes 

Changed response : --200 OK--

List of product identifier types.

Changed content type : application/json

Added property totalRecords (integer)

Total number of records.

Changed property items (array)

List of product identifiers

GET /factories 

Return Type 

Changed response : --200 OK--

List of factories belongs to a specific company.

Changed content type : application/json

• Added property totalRecords (integer)

Total number of records.

POST /products 

Request 

Product details for create

Changed content type : application/json

New required properties:

identifiers

Changed property unitType (string)

Unit type of the product

Added enum values:

- `piece`
- `kg`
- `m2`
- `m3`
- `kWh`
- `tkm`
- `MJ`
- `L`

GET /products 

Return Type 

Changed response : --200 OK--

The request was successful and received list of product data.

Changed content type : application/json

Added property totalRecords (integer)

Total number of records.

Changed property items (array)

List of products

Changed items (object):

Product response data.

Changed property unitType (string) > Unit type of the product

Added enum values:

  - `piece`
  - `kg`
  - `m2`
  - `m3`
  - `kWh`
  - `tkm`
  - `MJ`
  - `L`

[1.11.0] - 2024-07-22 

What's New 

POST /products/identifierTypes 

Create a product identifier type for a company in SiGREEN.

DELETE /products/identifierTypes/{id} 

Delete an unused product identifier type for a company in SiGREEN.

PATCH /products/identifierTypes/{id} 

Update a product identifier type for a company in SiGREEN.

DELETE /factories/{id} 

Delete an unused factory for a company in SiGREEN.

PATCH /factories/{id} 

Update a factory for a company in SiGREEN.

PUT /products/{id} 

Update a product by product Id in SiGREEN

What's Changed 

GET /products/{productId}/pcf/{filter} 

Get an export of a product carbon footprint without cryptographic material. If you need cryptographic verifiability of this information please use DIDComm APIs.

Parameters 

Removed: filter in path Added: filter in query

Here you can provide a filter on the request, e.g pcf information out of active or latest credential. Available values : active, latest

Changed path parameter : productId in path to id in path

GET /products/identifierTypes 

Get product identifier types for a company in SiGREEN.

Parameters 

Added: page in query

Page Number, usually starts with 0

Added: size in query

Size of the page default value is 10

Return Type 

New response : --403 Forbidden--

Forbidden. Deleted response : --400 Bad Request-- Bad request. Changed response : --401 Unauthorized-- Unauthorized.

• New content type : application/problem+json

Changed response : --500 Internal Server Error--

Unexpected error.

• New content type : application/problem+json

Changed response : --200 OK--

List of product identifier types

Changed content type : application/json

Changed property hasNext (boolean)

true if next page exists (page < totalPages)

Changed property hasPrev (boolean)

true if a previous page exists (page > 0)

Changed property page (number)

The current page-number (starts with 0)

Changed property pageNumber (number)

The current page-number (starts with 1)

Changed property size (number)

The size of elements in the response

Changed property totalPages (number)

The total available pages

Changed property identifierTypes (array)

GET /products/{productId} 

Return Type 

New response : --403 Forbidden--

Forbidden. Deleted response : --404 Not Found-- Not found. Changed response : --400 Bad Request-- Bad request.

• New content type : application/problem+json

Changed response : --401 Unauthorized--

Unauthorized.

• New content type : application/problem+json

Changed response : --500 Internal Server Error--

Unexpected error.

• New content type : application/problem+json

Changed response : --200 OK--

A product

• Changed content type : application/json

New required properties -id

- Added property `id` (string)
  > System generated id to identify the product of the company in SiGREEN

- Added property `factoryIds` (array)
  > Product Factory Ids (System Generated Ids)

  Items (string):

- Deleted property `location` (string)

- Deleted property `factory` (array)

- Changed property `name` (string)
  > Name of Product

- Changed property `family` (string)
  > Product Family name

- Changed property `description` (string)
  > Product description

- Changed property `weight` (string)
  > Product weight

- Changed property `quantity` (string)
  > Product Quantity

- Changed property `identifiers` (array)
  > You have to have one identifier where default parameter is set to true as this represents your main identifier for this entity.

  Changed items (object):

    - Changed property `idType` (string)
      > identifier type

    - Changed property `value` (string)
      > identifier value

    - Changed property `default` (boolean)
      > whether main identifier type or not

- Changed property `unitType` (string)
  > Unit Types