Quick Start¶

For getting started with our Application and our APIs, kindly refer to Getting Started.

For general information about the Procurement functionality, refer to the respective section in the SiGREEN Help: Procurement made easy.

Concepts and Glossary¶

For detailed information about the concepts and terminology, please refer to Concepts and Glossary.

Procurement API¶

The Procurement API, part of SiGREEN's suite of APIs, offers a streamlined solution for managing component-level emissions within procurement processes. With various endpoints mentioned below, users can efficiently access and analyze crucial data related to components and suppliers.

Suppliers¶

Prerequisite: In order to create a supplier, it is mandatory to create the supplier identifier type first.

Getting started with the Procurement APIs involves the following steps with respect to the Suppliers:

1. Create a supplier identifier type for a company in SiGREEN. The identifier type created initially in the beginning acts as the main identifier type.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/suppliers/identifierTypes' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data '{
         "idType": "Supplier ID"
     }'
   

   Example Response

     {
         "id": "0190832b-b69b-778f-a843-a2a787a0827d"
     }
   

2. Get supplier identifier types for a company in SiGREEN.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/suppliers/identifierTypes' \
     --header 'Authorization: Bearer TOKEN' \
   

   Example Response

     {
         "items": [
   
             {
                 "id": "0190832b-b69b-778f-a843-a2a787a0827d",
                 "idType": "Supplier ID",
                 "isMainIdentifierType": true
             }
         ],
         "hasNext": false,
         "hasPrev": false,
         "page": 0,
         "pageNumber": 1,
         "size": 1,
         "totalPages": 1
     }
   

3. Create a supplier in SiGREEN.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/suppliers' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data-raw '{
         "name": "Supplier Company Limited",
         "identifiers": [
             {
                 "idType": "Supplier ID",
                 "value": "SUP-123",
                 "default": true
             }
         ],
         "email": "demo@demo.com",
         "contactNumber": "+91 234-234-2445",
         "website": "www.demo.com",
         "locations": [
             "12459 Berlin, Siemensstraße 42"
         ],
         "comment": "Proc Supplier"
     }'
   

   Example Response

     {
         "id": "01908348-1ade-718b-9895-0b53c9e4a4f9"
     }
   

4. Get supplier details by ID for a company in SiGREEN.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/suppliers/01908348-1ade-718b-9895-0b53c9e4a4f9' \
     --header 'Authorization: Bearer TOKEN' \
     --data ''
   

   Example Response

     {
         "id": "01908348-1ade-718b-9895-0b53c9e4a4f9",
         "name": "Supplier Company Limited",
         "identifiers": [
             {
                 "idType": "Supplier ID",
                 "value": "SUP-123",
                 "default": true
             }
         ],
         "email": "demo@demo.com",
         "contactNumber": "+49 911 2155- 4444",
         "website": "www.demo.com",
         "locations": [
         "12459 Berlin, Siemensstraße 42"
         ],
         "comment": "Proc Supplier",
         "status": "ACTIVE",
         "createdOn": "2023-01-01T12:00:00",
         "updatedOn": "2023-01-02T12:00:00"
     }
   

With the other available Supplier APIs, you can perform the following operations:

1. Update supplier identifier type for a company in SiGREEN.
2. Update a supplier by supplier ID in SiGREEN.
3. Delete a supplier by supplier ID in SiGREEN.
4. Invite a supplier to SiGREEN.
5. Cancel a supplier invite to SiGREEN.
6. Get all suppliers for one company in SiGREEN.
7. Delete an unused supplier identifier type for a company in SiGREEN.

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under Procurement API(s).

Components¶

Prerequisite: In order to create a component, it is mandatory to create the component identifier type first.

Getting started with the Procurement APIs involves the following steps with respect to the Components:

1. Create a component identifier type for a company in SiGREEN. The identifier type created initially in the beginning acts as the main identifier type.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/identifierTypes' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data '{
         "idType": "SKU"
     }'
   

   Example Response

     {
         "id": "0190835f-f167-7a6c-b8ab-2d5cb2c1d7e8"
     }
   

2. Get component identifier types for a company in SiGREEN.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/identifierTypes?size=1' \
     --header 'Authorization: Bearer TOKEN' \
   

   Example Response

     {
         "items": [
             {
                 "id": "0190835f-f167-7a6c-b8ab-2d5cb2c1d7e8",
                 "idType": "SKU",
                 "isMainIdentifierType": true
             }
         ],
         "hasNext": false,
         "hasPrev": false,
         "page": 0,
         "pageNumber": 1,
         "size": 1,
         "totalPages": 1
     }
   

3. Create a component in SiGREEN.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data '{
         "name": "Frames",
         "materialCategory": "Electronics",
         "unit": "piece",
         "weight": "3.5",
         "identifiers": [
             {
                 "idType": "SKU",
                 "value": "FRM1234",
                 "default": true
             }
         ]
     }'
   

   Example Response

     {
         "id": "0190838b-4469-76fc-b4bc-414c71526f2f"
     }
   

4. Get component details by ID.

   Example Request

     curl --location --request GET 'https://app.sigreen.siemens.com/api/components/0190838b-4469-76fc-b4bc-414c71526f2f' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data ''
   

   Example Response

     {
         "id": "0190838b-4469-76fc-b4bc-414c71526f2f",
         "name": "Frames",
         "materialCategory": "Electronics",
         "unit": "piece",
         "weight": "3.5",
         "identifiers": [
             {
                 "idType": "SKU",
                 "value": "FRM1234",
                 "default": true
             },
         ],
         "createdOn": "2024-04-19T00:00:00.000Z",
         "updatedOn": "2024-04-19T00:00:00.000Z"
     }
   

5. Create secondary data with component. Either totalInclBio or totalExclBio mandatory.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/0190838b-4469-76fc-b4bc-414c71526f2f/secondaryData' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data-raw '{
         "email": "abc@testing.com",
         "productionStage": {
         "pcfIncludingBiogenic": "79.86801562912491",
         "pcfExcludingBiogenic": "79.86801562912432",
         "fossilGhgEmissions": "79.86801562912497",
         "biogenic": "79.86801562912497",
         "luGhgEmissions": "79.86801562912497",
         "aircraftGhgEmissions": "79.86801562912497",
         "dLucGhgEmissions": "79.86801562912497"
       },
       "distributionStage": {
         "pcfIncludingBiogenic": "79.86801562912494",
         "pcfExcludingBiogenic": "79.8680156291287",
         "fossilGhgEmissions": "79.86801562912497",
         "biogenic": "79.86801562912497",
         "luGhgEmissions": "79.86801562912497",
         "aircraftGhgEmissions": "79.86801562912497",
         "dLucGhgEmissions": "79.86801562912497"
       },
         "quantity": 1,
         "validityPeriodStart": "2024-06-04T08:30:00.000Z",
         "region": "Europe",
         "comment": "No Comments",
         "dataSource": "Database",
         "dataVerification": "Proxy data"
     }'
   

   Example Response

     {
         "secondaryDataId": "0190839e-1255-753b-8c52-a3202978a983"
     }
   

6. Get component secondary data by secondary data ID.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/0190838b-4469-76fc-b4bc-414c71526f2f/secondaryData/0190839e-1255-753b-8c52-a3202978a983' \
     --header 'Authorization: Bearer TOKEN' \
     --data ''
   

   Example Response

     {
         "quantity": "1.0",
         "dataSource": "Database",
         "dataVerification": "Proxy data",
         "region": "Europe",
         "validityPeriodStart": "2024-06-04 08:30:00.0",
         "comment": "No Comments",
         "secondaryDataId": "0190839e-1255-753b-8c52-a3202978a983",
         "email": "abc@testing.com"
         "productionStage": {
         "pcfIncludingBiogenic": "79.86801562912491",
         "pcfExcludingBiogenic": "79.86801562912432",
         "fossilGhgEmissions": "79.86801562912497",
         "biogenic": "79.86801562912497",
         "luGhgEmissions": "79.86801562912497",
         "aircraftGhgEmissions": "79.86801562912497",
         "dLucGhgEmissions": "79.86801562912497"
       },
       "distributionStage": {
         "pcfIncludingBiogenic": "79.86801562912494",
         "pcfExcludingBiogenic": "79.8680156291287",
         "fossilGhgEmissions": "79.86801562912497",
         "biogenic": "79.86801562912497",
         "luGhgEmissions": "79.86801562912497",
         "aircraftGhgEmissions": "79.86801562912497",
         "dLucGhgEmissions": "79.86801562912497"
       },
     }
   

7. Link suppliers and secondary data with component.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/0190838b-4469-76fc-b4bc-414c71526f2f/linkSuppliers' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data '[
         {
             "supplierId": "01908348-1ade-718b-9895-0b53c9e4a4f9",
             "supplierLocation": "12459 Berlin, Siemensstraße 42",
             "share": 100,
             "supplierProductId": "SUPCOMP1",
             "secondaryDataId": "018fe8a5-349f-7e94-8032-d57f9420e2a4"
         }
     ]'
   

   Example Response

     [
         {
             "supplierLocation": "12459 Berlin, Siemensstraße 42",
             "share": "100.0",
             "supplierProductId": "SUPCOMP1",
             "supplierId": "01908348-1ade-718b-9895-0b53c9e4a4f9",
             "secondaryDataId": "018fe8a5-349f-7e94-8032-d57f9420e2a4"
         }
     ]
   

8. Send pcf request to suppliers in SiGREEN.

   The PCF Request API allows you to send a Product Carbon Footprint (PCF) request to suppliers within your supply chain, helping track and report the carbon footprint of specific components. This is essential for maintaining transparency and sustainability in the supply chain.

   This API sends a request to the supplier to provide the carbon footprint information for a specific component. The request is based on the unique identifiers for both the component and the supplier.

   On a successful request, the supplier is notified via email and also via the standard SiGREEN notification in the application. The supplier will then be responsible for responding with the PCF information.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/019228f3-8d22-73f7-a8a9-673996b71326/suppliers/cb688ef3-a61f-455f-b308-4c80f87e8db6/pcfRequest' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
     --data '{
         "pcfStandard": "TFS V2",
         "location": "Mumbai",
         "message": "PCF request message",
         "identifiers": [
             {
                 "idType": "ean",
                 "value": "4667"
             }
         ]
     }'
   

   Example Response

      {
         "taskId": "T0247",                
      }
   

With the other available Component APIs, you can perform the following operations:

1. Update a component identifier type for a company in SiGREEN.
2. Get all components for one company in SiGREEN.
3. Delete a component by ID for a company in SiGREEN.
4. Get all component secondary data for component in SiGREEN.
5. Update component secondary data by secondary data ID.
6. Get all linked suppliers with component.
7. Get linked suppliers by componentSupplierLinkId with component.
8. Update location/share/secondary data/supplier product ID by component supplier ID.
9. Delete an unused component identifier type for a company in SiGREEN.
10. Delete link between component and supplier. Deletion of records supports only soft delete.

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under Procurement API(s).

Components PCF¶

With the available Components PCF APIs, you can perform the following operations:

1. Get an aggregated export of a PCF of a component.
2. Get an export of a PCF of a component.

3. GET the PCF data for your components in SiGREEN.

   With this API, you can retrieve the PCF data for your components shared by the supplier in different scenarios:

   You can retrieve the PCF data for all the components available in SiGREEN for your respective company.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/pcfData' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   You can retrieve the PCF data shared by the supplier in a specific time range.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/pcfData?from=2024-01-03T00%3A00%3A00.000Z&%20to=2024-12-31T23%3A59%3A59.999Z' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   You can retrieve the PCF data shared by a specific supplier.

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/pcfData?from=2024-01-03T00%3A00%3A00.000Z&%20to=2024-12-31T23%3A59%3A59.999Z&supplierId=0192416b-087d-7b2d-82b4-e08ad5da65db' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   You can retrieve the PCF data shared by the supplier wherein the PCF data is in any of the following state:

   Accepted

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/pcfData?supplierId=0192416b-087d-7b2d-82b4-e08ad5da65db&accepted=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   Denied

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/pcfData?supplierId=019232dd-8e5d-72bf-9ed1-01fbf137cf6b&denied=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   Withdrawn

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/pcfData?supplierId=019232dd-8e5d-72bf-9ed1-01fbf137cf6b&withdrawn=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   Active

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/pcfData?supplierId=0192416b-087d-7b2d-82b4-e08ad5da65db&active=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   Expired

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/pcfData?supplierId=01924911-87ea-7918-a753-9e3602c7d285&expired=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

   Revoked

   Example Request

     curl --location 'https://app.sigreen.siemens.com/api/components/pcfData?supplierId=019232dd-8e5d-72bf-9ed1-01fbf137cf6b&revoked=true' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer TOKEN' \
   

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under Procurement API(s).

Material Category¶

With the available Material Category APIs, you can perform the following operations:

1. Get Material Category details by ID.
2. Update Material Categories details by ID.
3. Delete Material Categories details by ID.
4. Get Material Category image by ID.
5. Update Material Category image by ID.
6. Delete Material Category image by ID.
7. Get all Material Categories for one company in SiGREEN.
8. Create Material Category to SiGREEN.

For more information in detail about the Parameters, Request Body, and Responses refer to the API Reference under Procurement API(s).